Documentation
¶
Index ¶
- Constants
- type ACL
- type ACLConfiguration
- type ACLConfigurationParam
- type ASN
- type ASNParam
- type AllowedProtocol
- type AppDeleteParams
- type AppDeleteResponse
- type AppDeleteResponseEnvelope
- type AppDeleteResponseEnvelopeSuccess
- type AppEditParams
- type AppEditResponse
- type AppEditResponseEnvelope
- type AppEditResponseEnvelopeSuccess
- type AppListParams
- type AppListResponse
- type AppListResponseMagicAccountApp
- type AppListResponseMagicManagedApp
- type AppListResponseUnion
- type AppNewParams
- type AppNewResponse
- type AppNewResponseEnvelope
- type AppNewResponseEnvelopeSuccess
- type AppService
- func (r *AppService) Delete(ctx context.Context, accountAppID string, body AppDeleteParams, ...) (res *AppDeleteResponse, err error)
- func (r *AppService) Edit(ctx context.Context, accountAppID string, params AppEditParams, ...) (res *AppEditResponse, err error)
- func (r *AppService) List(ctx context.Context, query AppListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AppListResponse], err error)
- func (r *AppService) ListAutoPaging(ctx context.Context, query AppListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AppListResponse]
- func (r *AppService) New(ctx context.Context, params AppNewParams, opts ...option.RequestOption) (res *AppNewResponse, err error)
- func (r *AppService) Update(ctx context.Context, accountAppID string, params AppUpdateParams, ...) (res *AppUpdateResponse, err error)
- type AppUpdateParams
- type AppUpdateResponse
- type AppUpdateResponseEnvelope
- type AppUpdateResponseEnvelopeSuccess
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CfInterconnectBulkUpdateParams
- type CfInterconnectBulkUpdateResponse
- type CfInterconnectBulkUpdateResponseEnvelope
- type CfInterconnectBulkUpdateResponseEnvelopeSuccess
- type CfInterconnectBulkUpdateResponseModifiedInterconnect
- type CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE
- type CfInterconnectGetParams
- type CfInterconnectGetResponse
- type CfInterconnectGetResponseEnvelope
- type CfInterconnectGetResponseEnvelopeSuccess
- type CfInterconnectGetResponseInterconnect
- type CfInterconnectGetResponseInterconnectGRE
- type CfInterconnectListParams
- type CfInterconnectListResponse
- type CfInterconnectListResponseEnvelope
- type CfInterconnectListResponseEnvelopeSuccess
- type CfInterconnectListResponseInterconnect
- type CfInterconnectListResponseInterconnectsGRE
- type CfInterconnectService
- func (r *CfInterconnectService) BulkUpdate(ctx context.Context, params CfInterconnectBulkUpdateParams, ...) (res *CfInterconnectBulkUpdateResponse, err error)
- func (r *CfInterconnectService) Get(ctx context.Context, cfInterconnectID string, params CfInterconnectGetParams, ...) (res *CfInterconnectGetResponse, err error)
- func (r *CfInterconnectService) List(ctx context.Context, params CfInterconnectListParams, ...) (res *CfInterconnectListResponse, err error)
- func (r *CfInterconnectService) Update(ctx context.Context, cfInterconnectID string, ...) (res *CfInterconnectUpdateResponse, err error)
- type CfInterconnectUpdateParams
- type CfInterconnectUpdateParamsGRE
- type CfInterconnectUpdateResponse
- type CfInterconnectUpdateResponseEnvelope
- type CfInterconnectUpdateResponseEnvelopeSuccess
- type CfInterconnectUpdateResponseModifiedInterconnect
- type CfInterconnectUpdateResponseModifiedInterconnectGRE
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type ConnectorEditParams
- type ConnectorEditResponse
- type ConnectorEditResponseDevice
- type ConnectorEditResponseEnvelope
- type ConnectorEditResponseEnvelopeErrors
- type ConnectorEditResponseEnvelopeMessages
- type ConnectorEventGetParams
- type ConnectorEventGetResponse
- type ConnectorEventGetResponseE
- type ConnectorEventGetResponseEConfigureCloudflaredTunnel
- type ConnectorEventGetResponseEConfigureCloudflaredTunnelK
- type ConnectorEventGetResponseEFinishAttestationFailure
- type ConnectorEventGetResponseEFinishAttestationFailureK
- type ConnectorEventGetResponseEFinishAttestationSuccess
- type ConnectorEventGetResponseEFinishAttestationSuccessK
- type ConnectorEventGetResponseEFinishRotateCryptKeyFailure
- type ConnectorEventGetResponseEFinishRotateCryptKeyFailureK
- type ConnectorEventGetResponseEFinishRotateCryptKeySuccess
- type ConnectorEventGetResponseEFinishRotateCryptKeySuccessK
- type ConnectorEventGetResponseEFinishRotatePkiFailure
- type ConnectorEventGetResponseEFinishRotatePkiFailureK
- type ConnectorEventGetResponseEFinishRotatePkiSuccess
- type ConnectorEventGetResponseEFinishRotatePkiSuccessK
- type ConnectorEventGetResponseEFinishUpgradeFailure
- type ConnectorEventGetResponseEFinishUpgradeFailureK
- type ConnectorEventGetResponseEFinishUpgradeSuccess
- type ConnectorEventGetResponseEFinishUpgradeSuccessK
- type ConnectorEventGetResponseEInit
- type ConnectorEventGetResponseEInitK
- type ConnectorEventGetResponseEK
- type ConnectorEventGetResponseELeave
- type ConnectorEventGetResponseELeaveK
- type ConnectorEventGetResponseEReconcile
- type ConnectorEventGetResponseEReconcileK
- type ConnectorEventGetResponseEStartAttestation
- type ConnectorEventGetResponseEStartAttestationK
- type ConnectorEventGetResponseEStartRotateCryptKey
- type ConnectorEventGetResponseEStartRotateCryptKeyK
- type ConnectorEventGetResponseEStartRotatePki
- type ConnectorEventGetResponseEStartRotatePkiK
- type ConnectorEventGetResponseEStartUpgrade
- type ConnectorEventGetResponseEStartUpgradeK
- type ConnectorEventGetResponseEUnion
- type ConnectorEventGetResponseEnvelope
- type ConnectorEventGetResponseEnvelopeErrors
- type ConnectorEventGetResponseEnvelopeMessages
- type ConnectorEventLatestListParams
- type ConnectorEventLatestListResponse
- type ConnectorEventLatestListResponseEnvelope
- type ConnectorEventLatestListResponseEnvelopeErrors
- type ConnectorEventLatestListResponseEnvelopeMessages
- type ConnectorEventLatestListResponseItem
- type ConnectorEventLatestListResponseItemsE
- type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel
- type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK
- type ConnectorEventLatestListResponseItemsEFinishAttestationFailure
- type ConnectorEventLatestListResponseItemsEFinishAttestationFailureK
- type ConnectorEventLatestListResponseItemsEFinishAttestationSuccess
- type ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK
- type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure
- type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK
- type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess
- type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK
- type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure
- type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK
- type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess
- type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK
- type ConnectorEventLatestListResponseItemsEFinishUpgradeFailure
- type ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK
- type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess
- type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK
- type ConnectorEventLatestListResponseItemsEInit
- type ConnectorEventLatestListResponseItemsEInitK
- type ConnectorEventLatestListResponseItemsEK
- type ConnectorEventLatestListResponseItemsELeave
- type ConnectorEventLatestListResponseItemsELeaveK
- type ConnectorEventLatestListResponseItemsEReconcile
- type ConnectorEventLatestListResponseItemsEReconcileK
- type ConnectorEventLatestListResponseItemsEStartAttestation
- type ConnectorEventLatestListResponseItemsEStartAttestationK
- type ConnectorEventLatestListResponseItemsEStartRotateCryptKey
- type ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK
- type ConnectorEventLatestListResponseItemsEStartRotatePki
- type ConnectorEventLatestListResponseItemsEStartRotatePkiK
- type ConnectorEventLatestListResponseItemsEStartUpgrade
- type ConnectorEventLatestListResponseItemsEStartUpgradeK
- type ConnectorEventLatestListResponseItemsEUnion
- type ConnectorEventLatestService
- type ConnectorEventListParams
- type ConnectorEventListResponse
- type ConnectorEventListResponseEnvelope
- type ConnectorEventListResponseEnvelopeErrors
- type ConnectorEventListResponseEnvelopeMessages
- type ConnectorEventListResponseItem
- type ConnectorEventService
- func (r *ConnectorEventService) Get(ctx context.Context, connectorID string, eventT float64, eventN float64, ...) (res *ConnectorEventGetResponse, err error)
- func (r *ConnectorEventService) List(ctx context.Context, connectorID string, params ConnectorEventListParams, ...) (res *ConnectorEventListResponse, err error)
- type ConnectorGetParams
- type ConnectorGetResponse
- type ConnectorGetResponseDevice
- type ConnectorGetResponseEnvelope
- type ConnectorGetResponseEnvelopeErrors
- type ConnectorGetResponseEnvelopeMessages
- type ConnectorListParams
- type ConnectorListResponse
- type ConnectorListResponseDevice
- type ConnectorService
- func (r *ConnectorService) Edit(ctx context.Context, connectorID string, params ConnectorEditParams, ...) (res *ConnectorEditResponse, err error)
- func (r *ConnectorService) Get(ctx context.Context, connectorID string, query ConnectorGetParams, ...) (res *ConnectorGetResponse, err error)
- func (r *ConnectorService) List(ctx context.Context, query ConnectorListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ConnectorListResponse], err error)
- func (r *ConnectorService) ListAutoPaging(ctx context.Context, query ConnectorListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ConnectorListResponse]
- func (r *ConnectorService) Update(ctx context.Context, connectorID string, params ConnectorUpdateParams, ...) (res *ConnectorUpdateResponse, err error)
- type ConnectorSnapshotGetParams
- type ConnectorSnapshotGetResponse
- type ConnectorSnapshotGetResponseDHCPLease
- type ConnectorSnapshotGetResponseDisk
- type ConnectorSnapshotGetResponseEnvelope
- type ConnectorSnapshotGetResponseEnvelopeErrors
- type ConnectorSnapshotGetResponseEnvelopeMessages
- type ConnectorSnapshotGetResponseInterface
- type ConnectorSnapshotGetResponseInterfacesIPAddress
- type ConnectorSnapshotGetResponseMount
- type ConnectorSnapshotGetResponseNetdev
- type ConnectorSnapshotGetResponseThermal
- type ConnectorSnapshotGetResponseTunnel
- type ConnectorSnapshotLatestListParams
- type ConnectorSnapshotLatestListResponse
- type ConnectorSnapshotLatestListResponseEnvelope
- type ConnectorSnapshotLatestListResponseEnvelopeErrors
- type ConnectorSnapshotLatestListResponseEnvelopeMessages
- type ConnectorSnapshotLatestListResponseItem
- type ConnectorSnapshotLatestListResponseItemsDHCPLease
- type ConnectorSnapshotLatestListResponseItemsDisk
- type ConnectorSnapshotLatestListResponseItemsInterface
- type ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress
- type ConnectorSnapshotLatestListResponseItemsMount
- type ConnectorSnapshotLatestListResponseItemsNetdev
- type ConnectorSnapshotLatestListResponseItemsThermal
- type ConnectorSnapshotLatestListResponseItemsTunnel
- type ConnectorSnapshotLatestService
- type ConnectorSnapshotListParams
- type ConnectorSnapshotListResponse
- type ConnectorSnapshotListResponseEnvelope
- type ConnectorSnapshotListResponseEnvelopeErrors
- type ConnectorSnapshotListResponseEnvelopeMessages
- type ConnectorSnapshotListResponseItem
- type ConnectorSnapshotService
- func (r *ConnectorSnapshotService) Get(ctx context.Context, connectorID string, snapshotT float64, ...) (res *ConnectorSnapshotGetResponse, err error)
- func (r *ConnectorSnapshotService) List(ctx context.Context, connectorID string, params ConnectorSnapshotListParams, ...) (res *ConnectorSnapshotListResponse, err error)
- type ConnectorUpdateParams
- type ConnectorUpdateResponse
- type ConnectorUpdateResponseDevice
- type ConnectorUpdateResponseEnvelope
- type ConnectorUpdateResponseEnvelopeErrors
- type ConnectorUpdateResponseEnvelopeMessages
- type DHCPRelay
- type DHCPRelayParam
- type DHCPServer
- type DHCPServerParam
- type Error
- type ErrorData
- type ErrorDataSource
- type GRETunnelBulkUpdateParams
- type GRETunnelBulkUpdateResponse
- type GRETunnelBulkUpdateResponseEnvelope
- type GRETunnelBulkUpdateResponseEnvelopeSuccess
- type GRETunnelBulkUpdateResponseModifiedGRETunnel
- type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck
- type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection
- type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget
- func (r GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion()
- func (r *GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
- type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion
- type GRETunnelDeleteParams
- type GRETunnelDeleteResponse
- type GRETunnelDeleteResponseDeletedGRETunnel
- type GRETunnelDeleteResponseDeletedGRETunnelHealthCheck
- type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection
- type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion
- type GRETunnelDeleteResponseEnvelope
- type GRETunnelDeleteResponseEnvelopeSuccess
- type GRETunnelGetParams
- type GRETunnelGetResponse
- type GRETunnelGetResponseEnvelope
- type GRETunnelGetResponseEnvelopeSuccess
- type GRETunnelGetResponseGRETunnel
- type GRETunnelGetResponseGRETunnelHealthCheck
- type GRETunnelGetResponseGRETunnelHealthCheckDirection
- type GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelGetResponseGRETunnelHealthCheckTargetUnion
- type GRETunnelListParams
- type GRETunnelListResponse
- type GRETunnelListResponseEnvelope
- type GRETunnelListResponseEnvelopeSuccess
- type GRETunnelListResponseGRETunnel
- type GRETunnelListResponseGRETunnelsHealthCheck
- type GRETunnelListResponseGRETunnelsHealthCheckDirection
- type GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelListResponseGRETunnelsHealthCheckTargetUnion
- type GRETunnelNewParams
- type GRETunnelNewParamsHealthCheck
- type GRETunnelNewParamsHealthCheckDirection
- type GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelNewParamsHealthCheckTargetUnion
- type GRETunnelNewResponse
- type GRETunnelNewResponseEnvelope
- type GRETunnelNewResponseEnvelopeSuccess
- type GRETunnelNewResponseHealthCheck
- type GRETunnelNewResponseHealthCheckDirection
- type GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelNewResponseHealthCheckTargetUnion
- type GRETunnelService
- func (r *GRETunnelService) BulkUpdate(ctx context.Context, params GRETunnelBulkUpdateParams, ...) (res *GRETunnelBulkUpdateResponse, err error)
- func (r *GRETunnelService) Delete(ctx context.Context, greTunnelID string, params GRETunnelDeleteParams, ...) (res *GRETunnelDeleteResponse, err error)
- func (r *GRETunnelService) Get(ctx context.Context, greTunnelID string, params GRETunnelGetParams, ...) (res *GRETunnelGetResponse, err error)
- func (r *GRETunnelService) List(ctx context.Context, params GRETunnelListParams, opts ...option.RequestOption) (res *GRETunnelListResponse, err error)
- func (r *GRETunnelService) New(ctx context.Context, params GRETunnelNewParams, opts ...option.RequestOption) (res *GRETunnelNewResponse, err error)
- func (r *GRETunnelService) Update(ctx context.Context, greTunnelID string, params GRETunnelUpdateParams, ...) (res *GRETunnelUpdateResponse, err error)
- type GRETunnelUpdateParams
- type GRETunnelUpdateParamsHealthCheck
- type GRETunnelUpdateParamsHealthCheckDirection
- type GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelUpdateParamsHealthCheckTargetUnion
- type GRETunnelUpdateResponse
- type GRETunnelUpdateResponseEnvelope
- type GRETunnelUpdateResponseEnvelopeSuccess
- type GRETunnelUpdateResponseModifiedGRETunnel
- type GRETunnelUpdateResponseModifiedGRETunnelHealthCheck
- type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection
- type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget
- type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion
- type HealthCheck
- type HealthCheckParam
- type HealthCheckRate
- type HealthCheckTargetMagicHealthCheckTarget
- type HealthCheckTargetMagicHealthCheckTargetParam
- type HealthCheckTargetUnion
- type HealthCheckTargetUnionParam
- type HealthCheckType
- type IPSECTunnelBulkUpdateParams
- type IPSECTunnelBulkUpdateResponse
- type IPSECTunnelBulkUpdateResponseEnvelope
- type IPSECTunnelBulkUpdateResponseEnvelopeSuccess
- type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel
- type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck
- type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection
- type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget
- func (r IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion()
- func (r *IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
- type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion
- type IPSECTunnelDeleteParams
- type IPSECTunnelDeleteResponse
- type IPSECTunnelDeleteResponseDeletedIPSECTunnel
- type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck
- type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection
- type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget
- func (r IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion()
- func (r *IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
- type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion
- type IPSECTunnelDeleteResponseEnvelope
- type IPSECTunnelDeleteResponseEnvelopeSuccess
- type IPSECTunnelGetParams
- type IPSECTunnelGetResponse
- type IPSECTunnelGetResponseEnvelope
- type IPSECTunnelGetResponseEnvelopeSuccess
- type IPSECTunnelGetResponseIPSECTunnel
- type IPSECTunnelGetResponseIPSECTunnelHealthCheck
- type IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection
- type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget
- type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion
- type IPSECTunnelListParams
- type IPSECTunnelListResponse
- type IPSECTunnelListResponseEnvelope
- type IPSECTunnelListResponseEnvelopeSuccess
- type IPSECTunnelListResponseIPSECTunnel
- type IPSECTunnelListResponseIPSECTunnelsHealthCheck
- type IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection
- type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget
- type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion
- type IPSECTunnelNewParams
- type IPSECTunnelNewParamsHealthCheck
- type IPSECTunnelNewParamsHealthCheckDirection
- type IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget
- type IPSECTunnelNewParamsHealthCheckTargetUnion
- type IPSECTunnelNewResponse
- type IPSECTunnelNewResponseEnvelope
- type IPSECTunnelNewResponseEnvelopeSuccess
- type IPSECTunnelNewResponseHealthCheck
- type IPSECTunnelNewResponseHealthCheckDirection
- type IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget
- type IPSECTunnelNewResponseHealthCheckTargetUnion
- type IPSECTunnelPSKGenerateParams
- type IPSECTunnelPSKGenerateResponse
- type IPSECTunnelPSKGenerateResponseEnvelope
- type IPSECTunnelPSKGenerateResponseEnvelopeSuccess
- type IPSECTunnelService
- func (r *IPSECTunnelService) BulkUpdate(ctx context.Context, params IPSECTunnelBulkUpdateParams, ...) (res *IPSECTunnelBulkUpdateResponse, err error)
- func (r *IPSECTunnelService) Delete(ctx context.Context, ipsecTunnelID string, params IPSECTunnelDeleteParams, ...) (res *IPSECTunnelDeleteResponse, err error)
- func (r *IPSECTunnelService) Get(ctx context.Context, ipsecTunnelID string, params IPSECTunnelGetParams, ...) (res *IPSECTunnelGetResponse, err error)
- func (r *IPSECTunnelService) List(ctx context.Context, params IPSECTunnelListParams, ...) (res *IPSECTunnelListResponse, err error)
- func (r *IPSECTunnelService) New(ctx context.Context, params IPSECTunnelNewParams, opts ...option.RequestOption) (res *IPSECTunnelNewResponse, err error)
- func (r *IPSECTunnelService) PSKGenerate(ctx context.Context, ipsecTunnelID string, params IPSECTunnelPSKGenerateParams, ...) (res *IPSECTunnelPSKGenerateResponse, err error)
- func (r *IPSECTunnelService) Update(ctx context.Context, ipsecTunnelID string, params IPSECTunnelUpdateParams, ...) (res *IPSECTunnelUpdateResponse, err error)
- type IPSECTunnelUpdateParams
- type IPSECTunnelUpdateParamsHealthCheck
- type IPSECTunnelUpdateParamsHealthCheckDirection
- type IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget
- type IPSECTunnelUpdateParamsHealthCheckTargetUnion
- type IPSECTunnelUpdateResponse
- type IPSECTunnelUpdateResponseEnvelope
- type IPSECTunnelUpdateResponseEnvelopeSuccess
- type IPSECTunnelUpdateResponseModifiedIPSECTunnel
- type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck
- type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection
- type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget
- func (r IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion()
- func (r *IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
- type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion
- type LAN
- type LANStaticAddressing
- type LANStaticAddressingParam
- type MagicTransitService
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Nat
- type NatParam
- type Ownership
- type OwnershipStatus
- type PCAP
- type PCAPDownloadGetParams
- type PCAPDownloadService
- type PCAPFilter
- type PCAPFilterParam
- type PCAPGetParams
- type PCAPGetResponse
- type PCAPGetResponseEnvelope
- type PCAPGetResponseEnvelopeSuccess
- type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull
- type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus
- type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem
- type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType
- type PCAPGetResponseStatus
- type PCAPGetResponseSystem
- type PCAPGetResponseType
- type PCAPGetResponseUnion
- type PCAPListParams
- type PCAPListResponse
- type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull
- type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus
- type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem
- type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType
- type PCAPListResponseStatus
- type PCAPListResponseSystem
- type PCAPListResponseType
- type PCAPListResponseUnion
- type PCAPNewParams
- type PCAPNewParamsBody
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem
- type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType
- type PCAPNewParamsBodySystem
- type PCAPNewParamsBodyType
- type PCAPNewParamsBodyUnion
- type PCAPNewResponse
- type PCAPNewResponseEnvelope
- type PCAPNewResponseEnvelopeSuccess
- type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull
- type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus
- type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem
- type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType
- type PCAPNewResponseStatus
- type PCAPNewResponseSystem
- type PCAPNewResponseType
- type PCAPNewResponseUnion
- type PCAPOwnershipDeleteParams
- type PCAPOwnershipGetParams
- type PCAPOwnershipNewParams
- type PCAPOwnershipNewResponseEnvelope
- type PCAPOwnershipNewResponseEnvelopeSuccess
- type PCAPOwnershipService
- func (r *PCAPOwnershipService) Delete(ctx context.Context, ownershipID string, body PCAPOwnershipDeleteParams, ...) (err error)
- func (r *PCAPOwnershipService) Get(ctx context.Context, query PCAPOwnershipGetParams, ...) (res *pagination.SinglePage[Ownership], err error)
- func (r *PCAPOwnershipService) GetAutoPaging(ctx context.Context, query PCAPOwnershipGetParams, ...) *pagination.SinglePageAutoPager[Ownership]
- func (r *PCAPOwnershipService) New(ctx context.Context, params PCAPOwnershipNewParams, ...) (res *Ownership, err error)
- func (r *PCAPOwnershipService) Validate(ctx context.Context, params PCAPOwnershipValidateParams, ...) (res *Ownership, err error)
- type PCAPOwnershipValidateParams
- type PCAPOwnershipValidateResponseEnvelope
- type PCAPOwnershipValidateResponseEnvelopeSuccess
- type PCAPService
- func (r *PCAPService) Get(ctx context.Context, pcapID string, query PCAPGetParams, ...) (res *PCAPGetResponse, err error)
- func (r *PCAPService) List(ctx context.Context, query PCAPListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PCAPListResponse], err error)
- func (r *PCAPService) ListAutoPaging(ctx context.Context, query PCAPListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PCAPListResponse]
- func (r *PCAPService) New(ctx context.Context, params PCAPNewParams, opts ...option.RequestOption) (res *PCAPNewResponse, err error)
- func (r *PCAPService) Stop(ctx context.Context, pcapID string, body PCAPStopParams, ...) (err error)
- type PCAPStatus
- type PCAPStopParams
- type PCAPSystem
- type PCAPType
- type PSKMetadata
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type RouteBulkUpdateParams
- type RouteBulkUpdateParamsRoute
- type RouteBulkUpdateResponse
- type RouteBulkUpdateResponseEnvelope
- type RouteBulkUpdateResponseEnvelopeSuccess
- type RouteBulkUpdateResponseModifiedRoute
- type RouteDeleteParams
- type RouteDeleteResponse
- type RouteDeleteResponseDeletedRoute
- type RouteDeleteResponseEnvelope
- type RouteDeleteResponseEnvelopeSuccess
- type RouteEmptyParams
- type RouteEmptyResponse
- type RouteEmptyResponseDeletedRoute
- type RouteEmptyResponseEnvelope
- type RouteEmptyResponseEnvelopeSuccess
- type RouteGetParams
- type RouteGetResponse
- type RouteGetResponseEnvelope
- type RouteGetResponseEnvelopeSuccess
- type RouteGetResponseRoute
- type RouteListParams
- type RouteListResponse
- type RouteListResponseEnvelope
- type RouteListResponseEnvelopeSuccess
- type RouteListResponseRoute
- type RouteNewParams
- type RouteNewResponse
- type RouteNewResponseEnvelope
- type RouteNewResponseEnvelopeSuccess
- type RouteService
- func (r *RouteService) BulkUpdate(ctx context.Context, params RouteBulkUpdateParams, ...) (res *RouteBulkUpdateResponse, err error)
- func (r *RouteService) Delete(ctx context.Context, routeID string, body RouteDeleteParams, ...) (res *RouteDeleteResponse, err error)
- func (r *RouteService) Empty(ctx context.Context, body RouteEmptyParams, opts ...option.RequestOption) (res *RouteEmptyResponse, err error)
- func (r *RouteService) Get(ctx context.Context, routeID string, query RouteGetParams, ...) (res *RouteGetResponse, err error)
- func (r *RouteService) List(ctx context.Context, query RouteListParams, opts ...option.RequestOption) (res *RouteListResponse, err error)
- func (r *RouteService) New(ctx context.Context, params RouteNewParams, opts ...option.RequestOption) (res *RouteNewResponse, err error)
- func (r *RouteService) Update(ctx context.Context, routeID string, params RouteUpdateParams, ...) (res *RouteUpdateResponse, err error)
- type RouteUpdateParams
- type RouteUpdateResponse
- type RouteUpdateResponseEnvelope
- type RouteUpdateResponseEnvelopeSuccess
- type RouteUpdateResponseModifiedRoute
- type RoutedSubnet
- type RoutedSubnetParam
- type Scope
- type ScopeParam
- type Site
- type SiteACLDeleteParams
- type SiteACLDeleteResponseEnvelope
- type SiteACLDeleteResponseEnvelopeSuccess
- type SiteACLEditParams
- type SiteACLEditResponseEnvelope
- type SiteACLEditResponseEnvelopeSuccess
- type SiteACLGetParams
- type SiteACLGetResponseEnvelope
- type SiteACLGetResponseEnvelopeSuccess
- type SiteACLListParams
- type SiteACLNewParams
- type SiteACLNewResponseEnvelope
- type SiteACLNewResponseEnvelopeSuccess
- type SiteACLService
- func (r *SiteACLService) Delete(ctx context.Context, siteID string, aclID string, body SiteACLDeleteParams, ...) (res *ACL, err error)
- func (r *SiteACLService) Edit(ctx context.Context, siteID string, aclID string, params SiteACLEditParams, ...) (res *ACL, err error)
- func (r *SiteACLService) Get(ctx context.Context, siteID string, aclID string, query SiteACLGetParams, ...) (res *ACL, err error)
- func (r *SiteACLService) List(ctx context.Context, siteID string, query SiteACLListParams, ...) (res *pagination.SinglePage[ACL], err error)
- func (r *SiteACLService) ListAutoPaging(ctx context.Context, siteID string, query SiteACLListParams, ...) *pagination.SinglePageAutoPager[ACL]
- func (r *SiteACLService) New(ctx context.Context, siteID string, params SiteACLNewParams, ...) (res *ACL, err error)
- func (r *SiteACLService) Update(ctx context.Context, siteID string, aclID string, params SiteACLUpdateParams, ...) (res *ACL, err error)
- type SiteACLUpdateParams
- type SiteACLUpdateResponseEnvelope
- type SiteACLUpdateResponseEnvelopeSuccess
- type SiteDeleteParams
- type SiteDeleteResponseEnvelope
- type SiteDeleteResponseEnvelopeSuccess
- type SiteEditParams
- type SiteEditResponseEnvelope
- type SiteEditResponseEnvelopeSuccess
- type SiteGetParams
- type SiteGetResponseEnvelope
- type SiteGetResponseEnvelopeSuccess
- type SiteLANDeleteParams
- type SiteLANDeleteResponseEnvelope
- type SiteLANDeleteResponseEnvelopeSuccess
- type SiteLANEditParams
- type SiteLANEditResponseEnvelope
- type SiteLANEditResponseEnvelopeSuccess
- type SiteLANGetParams
- type SiteLANGetResponseEnvelope
- type SiteLANGetResponseEnvelopeSuccess
- type SiteLANListParams
- type SiteLANNewParams
- type SiteLANService
- func (r *SiteLANService) Delete(ctx context.Context, siteID string, lanID string, body SiteLANDeleteParams, ...) (res *LAN, err error)
- func (r *SiteLANService) Edit(ctx context.Context, siteID string, lanID string, params SiteLANEditParams, ...) (res *LAN, err error)
- func (r *SiteLANService) Get(ctx context.Context, siteID string, lanID string, query SiteLANGetParams, ...) (res *LAN, err error)
- func (r *SiteLANService) List(ctx context.Context, siteID string, query SiteLANListParams, ...) (res *pagination.SinglePage[LAN], err error)
- func (r *SiteLANService) ListAutoPaging(ctx context.Context, siteID string, query SiteLANListParams, ...) *pagination.SinglePageAutoPager[LAN]
- func (r *SiteLANService) New(ctx context.Context, siteID string, params SiteLANNewParams, ...) (res *pagination.SinglePage[LAN], err error)
- func (r *SiteLANService) NewAutoPaging(ctx context.Context, siteID string, params SiteLANNewParams, ...) *pagination.SinglePageAutoPager[LAN]
- func (r *SiteLANService) Update(ctx context.Context, siteID string, lanID string, params SiteLANUpdateParams, ...) (res *LAN, err error)
- type SiteLANUpdateParams
- type SiteLANUpdateResponseEnvelope
- type SiteLANUpdateResponseEnvelopeSuccess
- type SiteListParams
- type SiteLocation
- type SiteLocationParam
- type SiteNewParams
- type SiteNewResponseEnvelope
- type SiteNewResponseEnvelopeSuccess
- type SiteService
- func (r *SiteService) Delete(ctx context.Context, siteID string, body SiteDeleteParams, ...) (res *Site, err error)
- func (r *SiteService) Edit(ctx context.Context, siteID string, params SiteEditParams, ...) (res *Site, err error)
- func (r *SiteService) Get(ctx context.Context, siteID string, params SiteGetParams, ...) (res *Site, err error)
- func (r *SiteService) List(ctx context.Context, params SiteListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Site], err error)
- func (r *SiteService) ListAutoPaging(ctx context.Context, params SiteListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Site]
- func (r *SiteService) New(ctx context.Context, params SiteNewParams, opts ...option.RequestOption) (res *Site, err error)
- func (r *SiteService) Update(ctx context.Context, siteID string, params SiteUpdateParams, ...) (res *Site, err error)
- type SiteUpdateParams
- type SiteUpdateResponseEnvelope
- type SiteUpdateResponseEnvelopeSuccess
- type SiteWANDeleteParams
- type SiteWANDeleteResponseEnvelope
- type SiteWANDeleteResponseEnvelopeSuccess
- type SiteWANEditParams
- type SiteWANEditResponseEnvelope
- type SiteWANEditResponseEnvelopeSuccess
- type SiteWANGetParams
- type SiteWANGetResponseEnvelope
- type SiteWANGetResponseEnvelopeSuccess
- type SiteWANListParams
- type SiteWANNewParams
- type SiteWANService
- func (r *SiteWANService) Delete(ctx context.Context, siteID string, wanID string, body SiteWANDeleteParams, ...) (res *WAN, err error)
- func (r *SiteWANService) Edit(ctx context.Context, siteID string, wanID string, params SiteWANEditParams, ...) (res *WAN, err error)
- func (r *SiteWANService) Get(ctx context.Context, siteID string, wanID string, query SiteWANGetParams, ...) (res *WAN, err error)
- func (r *SiteWANService) List(ctx context.Context, siteID string, query SiteWANListParams, ...) (res *pagination.SinglePage[WAN], err error)
- func (r *SiteWANService) ListAutoPaging(ctx context.Context, siteID string, query SiteWANListParams, ...) *pagination.SinglePageAutoPager[WAN]
- func (r *SiteWANService) New(ctx context.Context, siteID string, params SiteWANNewParams, ...) (res *pagination.SinglePage[WAN], err error)
- func (r *SiteWANService) NewAutoPaging(ctx context.Context, siteID string, params SiteWANNewParams, ...) *pagination.SinglePageAutoPager[WAN]
- func (r *SiteWANService) Update(ctx context.Context, siteID string, wanID string, params SiteWANUpdateParams, ...) (res *WAN, err error)
- type SiteWANUpdateParams
- type SiteWANUpdateResponseEnvelope
- type SiteWANUpdateResponseEnvelopeSuccess
- type SortDirection
- type Subnet
- type SubnetParam
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenStatus
- type TokenValue
- type WAN
- type WANHealthCheckRate
- type WANStaticAddressing
- type WANStaticAddressingParam
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACL ¶
type ACL struct {
// Identifier
ID string `json:"id"`
// Description for the ACL.
Description string `json:"description"`
// The desired forwarding action for this ACL policy. If set to "false", the policy
// will forward traffic to Cloudflare. If set to "true", the policy will forward
// traffic locally on the Magic Connector. If not included in request, will default
// to false.
ForwardLocally bool `json:"forward_locally"`
LAN1 ACLConfiguration `json:"lan_1"`
LAN2 ACLConfiguration `json:"lan_2"`
// The name of the ACL.
Name string `json:"name"`
Protocols []AllowedProtocol `json:"protocols"`
// The desired traffic direction for this ACL policy. If set to "false", the policy
// will allow bidirectional traffic. If set to "true", the policy will only allow
// traffic in one direction. If not included in request, will default to false.
Unidirectional bool `json:"unidirectional"`
JSON aclJSON `json:"-"`
}
Bidirectional ACL policy for network traffic within a site.
func (*ACL) UnmarshalJSON ¶
type ACLConfiguration ¶
type ACLConfiguration struct {
// The identifier for the LAN you want to create an ACL policy with.
LANID string `json:"lan_id,required"`
// The name of the LAN based on the provided lan_id.
LANName string `json:"lan_name"`
// Array of port ranges on the provided LAN that will be included in the ACL. If no
// ports or port rangess are provided, communication on any port on this LAN is
// allowed.
PortRanges []string `json:"port_ranges"`
// Array of ports on the provided LAN that will be included in the ACL. If no ports
// or port ranges are provided, communication on any port on this LAN is allowed.
Ports []int64 `json:"ports"`
// Array of subnet IPs within the LAN that will be included in the ACL. If no
// subnets are provided, communication on any subnets on this LAN are allowed.
Subnets []Subnet `json:"subnets"`
JSON aclConfigurationJSON `json:"-"`
}
func (*ACLConfiguration) UnmarshalJSON ¶
func (r *ACLConfiguration) UnmarshalJSON(data []byte) (err error)
type ACLConfigurationParam ¶
type ACLConfigurationParam struct {
// The identifier for the LAN you want to create an ACL policy with.
LANID param.Field[string] `json:"lan_id,required"`
// The name of the LAN based on the provided lan_id.
LANName param.Field[string] `json:"lan_name"`
// Array of port ranges on the provided LAN that will be included in the ACL. If no
// ports or port rangess are provided, communication on any port on this LAN is
// allowed.
PortRanges param.Field[[]string] `json:"port_ranges"`
// Array of ports on the provided LAN that will be included in the ACL. If no ports
// or port ranges are provided, communication on any port on this LAN is allowed.
Ports param.Field[[]int64] `json:"ports"`
// Array of subnet IPs within the LAN that will be included in the ACL. If no
// subnets are provided, communication on any subnets on this LAN are allowed.
Subnets param.Field[[]SubnetParam] `json:"subnets"`
}
func (ACLConfigurationParam) MarshalJSON ¶
func (r ACLConfigurationParam) MarshalJSON() (data []byte, err error)
type AllowedProtocol ¶
type AllowedProtocol string
Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
const ( AllowedProtocolTCP AllowedProtocol = "tcp" AllowedProtocolUdp AllowedProtocol = "udp" AllowedProtocolIcmp AllowedProtocol = "icmp" )
func (AllowedProtocol) IsKnown ¶
func (r AllowedProtocol) IsKnown() bool
type AppDeleteParams ¶
type AppDeleteResponse ¶
type AppDeleteResponse struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appDeleteResponseJSON `json:"-"`
}
Custom app defined for an account.
func (*AppDeleteResponse) UnmarshalJSON ¶
func (r *AppDeleteResponse) UnmarshalJSON(data []byte) (err error)
type AppDeleteResponseEnvelope ¶
type AppDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Custom app defined for an account.
Result AppDeleteResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success AppDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON appDeleteResponseEnvelopeJSON `json:"-"`
}
func (*AppDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *AppDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AppDeleteResponseEnvelopeSuccess ¶
type AppDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
AppDeleteResponseEnvelopeSuccessTrue AppDeleteResponseEnvelopeSuccess = true
)
func (AppDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r AppDeleteResponseEnvelopeSuccess) IsKnown() bool
type AppEditParams ¶ added in v4.3.0
type AppEditParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames param.Field[[]string] `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets param.Field[[]string] `json:"ip_subnets"`
// Display name for the app.
Name param.Field[string] `json:"name"`
// Category of the app.
Type param.Field[string] `json:"type"`
}
func (AppEditParams) MarshalJSON ¶ added in v4.3.0
func (r AppEditParams) MarshalJSON() (data []byte, err error)
type AppEditResponse ¶ added in v4.3.0
type AppEditResponse struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appEditResponseJSON `json:"-"`
}
Custom app defined for an account.
func (*AppEditResponse) UnmarshalJSON ¶ added in v4.3.0
func (r *AppEditResponse) UnmarshalJSON(data []byte) (err error)
type AppEditResponseEnvelope ¶ added in v4.3.0
type AppEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Custom app defined for an account.
Result AppEditResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success AppEditResponseEnvelopeSuccess `json:"success,required"`
JSON appEditResponseEnvelopeJSON `json:"-"`
}
func (*AppEditResponseEnvelope) UnmarshalJSON ¶ added in v4.3.0
func (r *AppEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AppEditResponseEnvelopeSuccess ¶ added in v4.3.0
type AppEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
AppEditResponseEnvelopeSuccessTrue AppEditResponseEnvelopeSuccess = true
)
func (AppEditResponseEnvelopeSuccess) IsKnown ¶ added in v4.3.0
func (r AppEditResponseEnvelopeSuccess) IsKnown() bool
type AppListParams ¶
type AppListResponse ¶
type AppListResponse struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id"`
// This field can have the runtime type of [[]string].
Hostnames interface{} `json:"hostnames"`
// This field can have the runtime type of [[]string].
IPSubnets interface{} `json:"ip_subnets"`
// Managed app ID.
ManagedAppID string `json:"managed_app_id"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appListResponseJSON `json:"-"`
// contains filtered or unexported fields
}
Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
func (AppListResponse) AsUnion ¶
func (r AppListResponse) AsUnion() AppListResponseUnion
AsUnion returns a AppListResponseUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are AppListResponseMagicAccountApp, AppListResponseMagicManagedApp.
func (*AppListResponse) UnmarshalJSON ¶
func (r *AppListResponse) UnmarshalJSON(data []byte) (err error)
type AppListResponseMagicAccountApp ¶
type AppListResponseMagicAccountApp struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appListResponseMagicAccountAppJSON `json:"-"`
}
Custom app defined for an account.
func (*AppListResponseMagicAccountApp) UnmarshalJSON ¶
func (r *AppListResponseMagicAccountApp) UnmarshalJSON(data []byte) (err error)
type AppListResponseMagicManagedApp ¶
type AppListResponseMagicManagedApp struct {
// Managed app ID.
ManagedAppID string `json:"managed_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appListResponseMagicManagedAppJSON `json:"-"`
}
Managed app defined by Cloudflare.
func (*AppListResponseMagicManagedApp) UnmarshalJSON ¶
func (r *AppListResponseMagicManagedApp) UnmarshalJSON(data []byte) (err error)
type AppListResponseUnion ¶
type AppListResponseUnion interface {
// contains filtered or unexported methods
}
Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
Union satisfied by AppListResponseMagicAccountApp or AppListResponseMagicManagedApp.
type AppNewParams ¶
type AppNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Display name for the app.
Name param.Field[string] `json:"name,required"`
// Category of the app.
Type param.Field[string] `json:"type,required"`
// FQDNs to associate with traffic decisions.
Hostnames param.Field[[]string] `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets param.Field[[]string] `json:"ip_subnets"`
}
func (AppNewParams) MarshalJSON ¶
func (r AppNewParams) MarshalJSON() (data []byte, err error)
type AppNewResponse ¶
type AppNewResponse struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appNewResponseJSON `json:"-"`
}
Custom app defined for an account.
func (*AppNewResponse) UnmarshalJSON ¶
func (r *AppNewResponse) UnmarshalJSON(data []byte) (err error)
type AppNewResponseEnvelope ¶
type AppNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Custom app defined for an account.
Result AppNewResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success AppNewResponseEnvelopeSuccess `json:"success,required"`
JSON appNewResponseEnvelopeJSON `json:"-"`
}
func (*AppNewResponseEnvelope) UnmarshalJSON ¶
func (r *AppNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AppNewResponseEnvelopeSuccess ¶
type AppNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
AppNewResponseEnvelopeSuccessTrue AppNewResponseEnvelopeSuccess = true
)
func (AppNewResponseEnvelopeSuccess) IsKnown ¶
func (r AppNewResponseEnvelopeSuccess) IsKnown() bool
type AppService ¶
type AppService struct {
Options []option.RequestOption
}
AppService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAppService method instead.
func NewAppService ¶
func NewAppService(opts ...option.RequestOption) (r *AppService)
NewAppService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AppService) Delete ¶
func (r *AppService) Delete(ctx context.Context, accountAppID string, body AppDeleteParams, opts ...option.RequestOption) (res *AppDeleteResponse, err error)
Deletes specific Account App.
func (*AppService) Edit ¶ added in v4.3.0
func (r *AppService) Edit(ctx context.Context, accountAppID string, params AppEditParams, opts ...option.RequestOption) (res *AppEditResponse, err error)
Updates an Account App
func (*AppService) List ¶
func (r *AppService) List(ctx context.Context, query AppListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AppListResponse], err error)
Lists Apps associated with an account.
func (*AppService) ListAutoPaging ¶
func (r *AppService) ListAutoPaging(ctx context.Context, query AppListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AppListResponse]
Lists Apps associated with an account.
func (*AppService) New ¶
func (r *AppService) New(ctx context.Context, params AppNewParams, opts ...option.RequestOption) (res *AppNewResponse, err error)
Creates a new App for an account
func (*AppService) Update ¶
func (r *AppService) Update(ctx context.Context, accountAppID string, params AppUpdateParams, opts ...option.RequestOption) (res *AppUpdateResponse, err error)
Updates an Account App
type AppUpdateParams ¶
type AppUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames param.Field[[]string] `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets param.Field[[]string] `json:"ip_subnets"`
// Display name for the app.
Name param.Field[string] `json:"name"`
// Category of the app.
Type param.Field[string] `json:"type"`
}
func (AppUpdateParams) MarshalJSON ¶
func (r AppUpdateParams) MarshalJSON() (data []byte, err error)
type AppUpdateResponse ¶
type AppUpdateResponse struct {
// Magic account app ID.
AccountAppID string `json:"account_app_id,required"`
// FQDNs to associate with traffic decisions.
Hostnames []string `json:"hostnames"`
// CIDRs to associate with traffic decisions.
IPSubnets []string `json:"ip_subnets"`
// Display name for the app.
Name string `json:"name"`
// Category of the app.
Type string `json:"type"`
JSON appUpdateResponseJSON `json:"-"`
}
Custom app defined for an account.
func (*AppUpdateResponse) UnmarshalJSON ¶
func (r *AppUpdateResponse) UnmarshalJSON(data []byte) (err error)
type AppUpdateResponseEnvelope ¶
type AppUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Custom app defined for an account.
Result AppUpdateResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success AppUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON appUpdateResponseEnvelopeJSON `json:"-"`
}
func (*AppUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *AppUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AppUpdateResponseEnvelopeSuccess ¶
type AppUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
AppUpdateResponseEnvelopeSuccessTrue AppUpdateResponseEnvelopeSuccess = true
)
func (AppUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r AppUpdateResponseEnvelopeSuccess) IsKnown() bool
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CfInterconnectBulkUpdateParams ¶
type CfInterconnectBulkUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body interface{} `json:"body,required"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (CfInterconnectBulkUpdateParams) MarshalJSON ¶
func (r CfInterconnectBulkUpdateParams) MarshalJSON() (data []byte, err error)
type CfInterconnectBulkUpdateResponse ¶
type CfInterconnectBulkUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedInterconnects []CfInterconnectBulkUpdateResponseModifiedInterconnect `json:"modified_interconnects"`
JSON cfInterconnectBulkUpdateResponseJSON `json:"-"`
}
func (*CfInterconnectBulkUpdateResponse) UnmarshalJSON ¶
func (r *CfInterconnectBulkUpdateResponse) UnmarshalJSON(data []byte) (err error)
type CfInterconnectBulkUpdateResponseEnvelope ¶
type CfInterconnectBulkUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result CfInterconnectBulkUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success CfInterconnectBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON cfInterconnectBulkUpdateResponseEnvelopeJSON `json:"-"`
}
func (*CfInterconnectBulkUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CfInterconnectBulkUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CfInterconnectBulkUpdateResponseEnvelopeSuccess ¶
type CfInterconnectBulkUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CfInterconnectBulkUpdateResponseEnvelopeSuccessTrue CfInterconnectBulkUpdateResponseEnvelopeSuccess = true
)
func (CfInterconnectBulkUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r CfInterconnectBulkUpdateResponseEnvelopeSuccess) IsKnown() bool
type CfInterconnectBulkUpdateResponseModifiedInterconnect ¶
type CfInterconnectBulkUpdateResponseModifiedInterconnect struct {
// Identifier
ID string `json:"id"`
// The name of the interconnect. The name cannot share a name with other tunnels.
ColoName string `json:"colo_name"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the interconnect.
Description string `json:"description"`
// The configuration specific to GRE interconnects.
GRE CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE `json:"gre"`
HealthCheck HealthCheck `json:"health_check"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum
// value is 576.
Mtu int64 `json:"mtu"`
// The name of the interconnect. The name cannot share a name with other tunnels.
Name string `json:"name"`
JSON cfInterconnectBulkUpdateResponseModifiedInterconnectJSON `json:"-"`
}
func (*CfInterconnectBulkUpdateResponseModifiedInterconnect) UnmarshalJSON ¶
func (r *CfInterconnectBulkUpdateResponseModifiedInterconnect) UnmarshalJSON(data []byte) (err error)
type CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE ¶
type CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE struct {
// The IP address assigned to the Cloudflare side of the GRE tunnel created as part
// of the Interconnect.
CloudflareEndpoint string `json:"cloudflare_endpoint"`
JSON cfInterconnectBulkUpdateResponseModifiedInterconnectsGREJSON `json:"-"`
}
The configuration specific to GRE interconnects.
func (*CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE) UnmarshalJSON ¶
func (r *CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE) UnmarshalJSON(data []byte) (err error)
type CfInterconnectGetParams ¶
type CfInterconnectGetResponse ¶
type CfInterconnectGetResponse struct {
Interconnect CfInterconnectGetResponseInterconnect `json:"interconnect"`
JSON cfInterconnectGetResponseJSON `json:"-"`
}
func (*CfInterconnectGetResponse) UnmarshalJSON ¶
func (r *CfInterconnectGetResponse) UnmarshalJSON(data []byte) (err error)
type CfInterconnectGetResponseEnvelope ¶
type CfInterconnectGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result CfInterconnectGetResponse `json:"result,required"`
// Whether the API call was successful
Success CfInterconnectGetResponseEnvelopeSuccess `json:"success,required"`
JSON cfInterconnectGetResponseEnvelopeJSON `json:"-"`
}
func (*CfInterconnectGetResponseEnvelope) UnmarshalJSON ¶
func (r *CfInterconnectGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CfInterconnectGetResponseEnvelopeSuccess ¶
type CfInterconnectGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CfInterconnectGetResponseEnvelopeSuccessTrue CfInterconnectGetResponseEnvelopeSuccess = true
)
func (CfInterconnectGetResponseEnvelopeSuccess) IsKnown ¶
func (r CfInterconnectGetResponseEnvelopeSuccess) IsKnown() bool
type CfInterconnectGetResponseInterconnect ¶
type CfInterconnectGetResponseInterconnect struct {
// Identifier
ID string `json:"id"`
// The name of the interconnect. The name cannot share a name with other tunnels.
ColoName string `json:"colo_name"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the interconnect.
Description string `json:"description"`
// The configuration specific to GRE interconnects.
GRE CfInterconnectGetResponseInterconnectGRE `json:"gre"`
HealthCheck HealthCheck `json:"health_check"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum
// value is 576.
Mtu int64 `json:"mtu"`
// The name of the interconnect. The name cannot share a name with other tunnels.
Name string `json:"name"`
JSON cfInterconnectGetResponseInterconnectJSON `json:"-"`
}
func (*CfInterconnectGetResponseInterconnect) UnmarshalJSON ¶
func (r *CfInterconnectGetResponseInterconnect) UnmarshalJSON(data []byte) (err error)
type CfInterconnectGetResponseInterconnectGRE ¶
type CfInterconnectGetResponseInterconnectGRE struct {
// The IP address assigned to the Cloudflare side of the GRE tunnel created as part
// of the Interconnect.
CloudflareEndpoint string `json:"cloudflare_endpoint"`
JSON cfInterconnectGetResponseInterconnectGREJSON `json:"-"`
}
The configuration specific to GRE interconnects.
func (*CfInterconnectGetResponseInterconnectGRE) UnmarshalJSON ¶
func (r *CfInterconnectGetResponseInterconnectGRE) UnmarshalJSON(data []byte) (err error)
type CfInterconnectListResponse ¶
type CfInterconnectListResponse struct {
Interconnects []CfInterconnectListResponseInterconnect `json:"interconnects"`
JSON cfInterconnectListResponseJSON `json:"-"`
}
func (*CfInterconnectListResponse) UnmarshalJSON ¶
func (r *CfInterconnectListResponse) UnmarshalJSON(data []byte) (err error)
type CfInterconnectListResponseEnvelope ¶
type CfInterconnectListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result CfInterconnectListResponse `json:"result,required"`
// Whether the API call was successful
Success CfInterconnectListResponseEnvelopeSuccess `json:"success,required"`
JSON cfInterconnectListResponseEnvelopeJSON `json:"-"`
}
func (*CfInterconnectListResponseEnvelope) UnmarshalJSON ¶
func (r *CfInterconnectListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CfInterconnectListResponseEnvelopeSuccess ¶
type CfInterconnectListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CfInterconnectListResponseEnvelopeSuccessTrue CfInterconnectListResponseEnvelopeSuccess = true
)
func (CfInterconnectListResponseEnvelopeSuccess) IsKnown ¶
func (r CfInterconnectListResponseEnvelopeSuccess) IsKnown() bool
type CfInterconnectListResponseInterconnect ¶
type CfInterconnectListResponseInterconnect struct {
// Identifier
ID string `json:"id"`
// The name of the interconnect. The name cannot share a name with other tunnels.
ColoName string `json:"colo_name"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the interconnect.
Description string `json:"description"`
// The configuration specific to GRE interconnects.
GRE CfInterconnectListResponseInterconnectsGRE `json:"gre"`
HealthCheck HealthCheck `json:"health_check"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum
// value is 576.
Mtu int64 `json:"mtu"`
// The name of the interconnect. The name cannot share a name with other tunnels.
Name string `json:"name"`
JSON cfInterconnectListResponseInterconnectJSON `json:"-"`
}
func (*CfInterconnectListResponseInterconnect) UnmarshalJSON ¶
func (r *CfInterconnectListResponseInterconnect) UnmarshalJSON(data []byte) (err error)
type CfInterconnectListResponseInterconnectsGRE ¶
type CfInterconnectListResponseInterconnectsGRE struct {
// The IP address assigned to the Cloudflare side of the GRE tunnel created as part
// of the Interconnect.
CloudflareEndpoint string `json:"cloudflare_endpoint"`
JSON cfInterconnectListResponseInterconnectsGREJSON `json:"-"`
}
The configuration specific to GRE interconnects.
func (*CfInterconnectListResponseInterconnectsGRE) UnmarshalJSON ¶
func (r *CfInterconnectListResponseInterconnectsGRE) UnmarshalJSON(data []byte) (err error)
type CfInterconnectService ¶
type CfInterconnectService struct {
Options []option.RequestOption
}
CfInterconnectService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCfInterconnectService method instead.
func NewCfInterconnectService ¶
func NewCfInterconnectService(opts ...option.RequestOption) (r *CfInterconnectService)
NewCfInterconnectService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CfInterconnectService) BulkUpdate ¶
func (r *CfInterconnectService) BulkUpdate(ctx context.Context, params CfInterconnectBulkUpdateParams, opts ...option.RequestOption) (res *CfInterconnectBulkUpdateResponse, err error)
Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*CfInterconnectService) Get ¶
func (r *CfInterconnectService) Get(ctx context.Context, cfInterconnectID string, params CfInterconnectGetParams, opts ...option.RequestOption) (res *CfInterconnectGetResponse, err error)
Lists details for a specific interconnect.
func (*CfInterconnectService) List ¶
func (r *CfInterconnectService) List(ctx context.Context, params CfInterconnectListParams, opts ...option.RequestOption) (res *CfInterconnectListResponse, err error)
Lists interconnects associated with an account.
func (*CfInterconnectService) Update ¶
func (r *CfInterconnectService) Update(ctx context.Context, cfInterconnectID string, params CfInterconnectUpdateParams, opts ...option.RequestOption) (res *CfInterconnectUpdateResponse, err error)
Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
type CfInterconnectUpdateParams ¶
type CfInterconnectUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// An optional description of the interconnect.
Description param.Field[string] `json:"description"`
// The configuration specific to GRE interconnects.
GRE param.Field[CfInterconnectUpdateParamsGRE] `json:"gre"`
HealthCheck param.Field[HealthCheckParam] `json:"health_check"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress param.Field[string] `json:"interface_address"`
// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum
// value is 576.
Mtu param.Field[int64] `json:"mtu"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (CfInterconnectUpdateParams) MarshalJSON ¶
func (r CfInterconnectUpdateParams) MarshalJSON() (data []byte, err error)
type CfInterconnectUpdateParamsGRE ¶
type CfInterconnectUpdateParamsGRE struct {
// The IP address assigned to the Cloudflare side of the GRE tunnel created as part
// of the Interconnect.
CloudflareEndpoint param.Field[string] `json:"cloudflare_endpoint"`
}
The configuration specific to GRE interconnects.
func (CfInterconnectUpdateParamsGRE) MarshalJSON ¶
func (r CfInterconnectUpdateParamsGRE) MarshalJSON() (data []byte, err error)
type CfInterconnectUpdateResponse ¶
type CfInterconnectUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedInterconnect CfInterconnectUpdateResponseModifiedInterconnect `json:"modified_interconnect"`
JSON cfInterconnectUpdateResponseJSON `json:"-"`
}
func (*CfInterconnectUpdateResponse) UnmarshalJSON ¶
func (r *CfInterconnectUpdateResponse) UnmarshalJSON(data []byte) (err error)
type CfInterconnectUpdateResponseEnvelope ¶
type CfInterconnectUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result CfInterconnectUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success CfInterconnectUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON cfInterconnectUpdateResponseEnvelopeJSON `json:"-"`
}
func (*CfInterconnectUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CfInterconnectUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CfInterconnectUpdateResponseEnvelopeSuccess ¶
type CfInterconnectUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CfInterconnectUpdateResponseEnvelopeSuccessTrue CfInterconnectUpdateResponseEnvelopeSuccess = true
)
func (CfInterconnectUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r CfInterconnectUpdateResponseEnvelopeSuccess) IsKnown() bool
type CfInterconnectUpdateResponseModifiedInterconnect ¶
type CfInterconnectUpdateResponseModifiedInterconnect struct {
// Identifier
ID string `json:"id"`
// The name of the interconnect. The name cannot share a name with other tunnels.
ColoName string `json:"colo_name"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the interconnect.
Description string `json:"description"`
// The configuration specific to GRE interconnects.
GRE CfInterconnectUpdateResponseModifiedInterconnectGRE `json:"gre"`
HealthCheck HealthCheck `json:"health_check"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum
// value is 576.
Mtu int64 `json:"mtu"`
// The name of the interconnect. The name cannot share a name with other tunnels.
Name string `json:"name"`
JSON cfInterconnectUpdateResponseModifiedInterconnectJSON `json:"-"`
}
func (*CfInterconnectUpdateResponseModifiedInterconnect) UnmarshalJSON ¶
func (r *CfInterconnectUpdateResponseModifiedInterconnect) UnmarshalJSON(data []byte) (err error)
type CfInterconnectUpdateResponseModifiedInterconnectGRE ¶
type CfInterconnectUpdateResponseModifiedInterconnectGRE struct {
// The IP address assigned to the Cloudflare side of the GRE tunnel created as part
// of the Interconnect.
CloudflareEndpoint string `json:"cloudflare_endpoint"`
JSON cfInterconnectUpdateResponseModifiedInterconnectGREJSON `json:"-"`
}
The configuration specific to GRE interconnects.
func (*CfInterconnectUpdateResponseModifiedInterconnectGRE) UnmarshalJSON ¶
func (r *CfInterconnectUpdateResponseModifiedInterconnectGRE) UnmarshalJSON(data []byte) (err error)
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type ConnectorEditParams ¶
type ConnectorEditParams struct {
AccountID param.Field[string] `path:"account_id,required"`
Activated param.Field[bool] `json:"activated"`
InterruptWindowDurationHours param.Field[float64] `json:"interrupt_window_duration_hours"`
InterruptWindowHourOfDay param.Field[float64] `json:"interrupt_window_hour_of_day"`
Notes param.Field[string] `json:"notes"`
Timezone param.Field[string] `json:"timezone"`
}
func (ConnectorEditParams) MarshalJSON ¶
func (r ConnectorEditParams) MarshalJSON() (data []byte, err error)
type ConnectorEditResponse ¶
type ConnectorEditResponse struct {
ID string `json:"id,required"`
Activated bool `json:"activated,required"`
InterruptWindowDurationHours float64 `json:"interrupt_window_duration_hours,required"`
InterruptWindowHourOfDay float64 `json:"interrupt_window_hour_of_day,required"`
LastUpdated string `json:"last_updated,required"`
Notes string `json:"notes,required"`
Timezone string `json:"timezone,required"`
Device ConnectorEditResponseDevice `json:"device"`
LastHeartbeat string `json:"last_heartbeat"`
LastSeenVersion string `json:"last_seen_version"`
JSON connectorEditResponseJSON `json:"-"`
}
func (*ConnectorEditResponse) UnmarshalJSON ¶
func (r *ConnectorEditResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorEditResponseDevice ¶
type ConnectorEditResponseDevice struct {
ID string `json:"id,required"`
SerialNumber string `json:"serial_number"`
JSON connectorEditResponseDeviceJSON `json:"-"`
}
func (*ConnectorEditResponseDevice) UnmarshalJSON ¶
func (r *ConnectorEditResponseDevice) UnmarshalJSON(data []byte) (err error)
type ConnectorEditResponseEnvelope ¶
type ConnectorEditResponseEnvelope struct {
Errors []ConnectorEditResponseEnvelopeErrors `json:"errors,required"`
Messages []ConnectorEditResponseEnvelopeMessages `json:"messages,required"`
Result ConnectorEditResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON connectorEditResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorEditResponseEnvelope) UnmarshalJSON ¶
func (r *ConnectorEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorEditResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorEditResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorEditResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorEditResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetParams ¶ added in v4.2.0
type ConnectorEventGetResponse ¶ added in v4.2.0
type ConnectorEventGetResponse struct {
E ConnectorEventGetResponseE `json:"e,required"`
// Sequence number, used to order events with the same timestamp
N float64 `json:"n,required"`
// Time the Event was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
JSON connectorEventGetResponseJSON `json:"-"`
}
Recorded Event
func (*ConnectorEventGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseE ¶ added in v4.2.0
type ConnectorEventGetResponseE struct {
// Initialized process
K ConnectorEventGetResponseEK `json:"k,required"`
// Location of upgrade bundle
URL string `json:"url"`
JSON connectorEventGetResponseEJSON `json:"-"`
// contains filtered or unexported fields
}
func (ConnectorEventGetResponseE) AsUnion ¶ added in v4.2.0
func (r ConnectorEventGetResponseE) AsUnion() ConnectorEventGetResponseEUnion
AsUnion returns a ConnectorEventGetResponseEUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ConnectorEventGetResponseEInit, ConnectorEventGetResponseELeave, ConnectorEventGetResponseEStartAttestation, ConnectorEventGetResponseEFinishAttestationSuccess, ConnectorEventGetResponseEFinishAttestationFailure, ConnectorEventGetResponseEStartRotateCryptKey, ConnectorEventGetResponseEFinishRotateCryptKeySuccess, ConnectorEventGetResponseEFinishRotateCryptKeyFailure, ConnectorEventGetResponseEStartRotatePki, ConnectorEventGetResponseEFinishRotatePkiSuccess, ConnectorEventGetResponseEFinishRotatePkiFailure, ConnectorEventGetResponseEStartUpgrade, ConnectorEventGetResponseEFinishUpgradeSuccess, ConnectorEventGetResponseEFinishUpgradeFailure, ConnectorEventGetResponseEReconcile, ConnectorEventGetResponseEConfigureCloudflaredTunnel.
func (*ConnectorEventGetResponseE) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseE) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEConfigureCloudflaredTunnel ¶ added in v4.2.0
type ConnectorEventGetResponseEConfigureCloudflaredTunnel struct {
// Configured Cloudflared tunnel
K ConnectorEventGetResponseEConfigureCloudflaredTunnelK `json:"k,required"`
JSON connectorEventGetResponseEConfigureCloudflaredTunnelJSON `json:"-"`
}
func (*ConnectorEventGetResponseEConfigureCloudflaredTunnel) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEConfigureCloudflaredTunnel) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEConfigureCloudflaredTunnelK ¶ added in v4.2.0
type ConnectorEventGetResponseEConfigureCloudflaredTunnelK string
Configured Cloudflared tunnel
const (
ConnectorEventGetResponseEConfigureCloudflaredTunnelKConfigureCloudflaredTunnel ConnectorEventGetResponseEConfigureCloudflaredTunnelK = "ConfigureCloudflaredTunnel"
)
func (ConnectorEventGetResponseEConfigureCloudflaredTunnelK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEConfigureCloudflaredTunnelK) IsKnown() bool
type ConnectorEventGetResponseEFinishAttestationFailure ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishAttestationFailure struct {
// Failed attestation
K ConnectorEventGetResponseEFinishAttestationFailureK `json:"k,required"`
JSON connectorEventGetResponseEFinishAttestationFailureJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishAttestationFailure) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishAttestationFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishAttestationFailureK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishAttestationFailureK string
Failed attestation
const (
ConnectorEventGetResponseEFinishAttestationFailureKFinishAttestationFailure ConnectorEventGetResponseEFinishAttestationFailureK = "FinishAttestationFailure"
)
func (ConnectorEventGetResponseEFinishAttestationFailureK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishAttestationFailureK) IsKnown() bool
type ConnectorEventGetResponseEFinishAttestationSuccess ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishAttestationSuccess struct {
// Finished attestation
K ConnectorEventGetResponseEFinishAttestationSuccessK `json:"k,required"`
JSON connectorEventGetResponseEFinishAttestationSuccessJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishAttestationSuccess) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishAttestationSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishAttestationSuccessK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishAttestationSuccessK string
Finished attestation
const (
ConnectorEventGetResponseEFinishAttestationSuccessKFinishAttestationSuccess ConnectorEventGetResponseEFinishAttestationSuccessK = "FinishAttestationSuccess"
)
func (ConnectorEventGetResponseEFinishAttestationSuccessK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishAttestationSuccessK) IsKnown() bool
type ConnectorEventGetResponseEFinishRotateCryptKeyFailure ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishRotateCryptKeyFailure struct {
// Failed crypt key rotation
K ConnectorEventGetResponseEFinishRotateCryptKeyFailureK `json:"k,required"`
JSON connectorEventGetResponseEFinishRotateCryptKeyFailureJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishRotateCryptKeyFailure) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishRotateCryptKeyFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishRotateCryptKeyFailureK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishRotateCryptKeyFailureK string
Failed crypt key rotation
const (
ConnectorEventGetResponseEFinishRotateCryptKeyFailureKFinishRotateCryptKeyFailure ConnectorEventGetResponseEFinishRotateCryptKeyFailureK = "FinishRotateCryptKeyFailure"
)
func (ConnectorEventGetResponseEFinishRotateCryptKeyFailureK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishRotateCryptKeyFailureK) IsKnown() bool
type ConnectorEventGetResponseEFinishRotateCryptKeySuccess ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishRotateCryptKeySuccess struct {
// Finished crypt key rotation
K ConnectorEventGetResponseEFinishRotateCryptKeySuccessK `json:"k,required"`
JSON connectorEventGetResponseEFinishRotateCryptKeySuccessJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishRotateCryptKeySuccess) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishRotateCryptKeySuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishRotateCryptKeySuccessK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishRotateCryptKeySuccessK string
Finished crypt key rotation
const (
ConnectorEventGetResponseEFinishRotateCryptKeySuccessKFinishRotateCryptKeySuccess ConnectorEventGetResponseEFinishRotateCryptKeySuccessK = "FinishRotateCryptKeySuccess"
)
func (ConnectorEventGetResponseEFinishRotateCryptKeySuccessK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishRotateCryptKeySuccessK) IsKnown() bool
type ConnectorEventGetResponseEFinishRotatePkiFailure ¶ added in v4.4.0
type ConnectorEventGetResponseEFinishRotatePkiFailure struct {
// Failed PKI rotation
K ConnectorEventGetResponseEFinishRotatePkiFailureK `json:"k,required"`
JSON connectorEventGetResponseEFinishRotatePkiFailureJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishRotatePkiFailure) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventGetResponseEFinishRotatePkiFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishRotatePkiFailureK ¶ added in v4.4.0
type ConnectorEventGetResponseEFinishRotatePkiFailureK string
Failed PKI rotation
const (
ConnectorEventGetResponseEFinishRotatePkiFailureKFinishRotatePkiFailure ConnectorEventGetResponseEFinishRotatePkiFailureK = "FinishRotatePkiFailure"
)
func (ConnectorEventGetResponseEFinishRotatePkiFailureK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventGetResponseEFinishRotatePkiFailureK) IsKnown() bool
type ConnectorEventGetResponseEFinishRotatePkiSuccess ¶ added in v4.4.0
type ConnectorEventGetResponseEFinishRotatePkiSuccess struct {
// Finished PKI rotation
K ConnectorEventGetResponseEFinishRotatePkiSuccessK `json:"k,required"`
JSON connectorEventGetResponseEFinishRotatePkiSuccessJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishRotatePkiSuccess) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventGetResponseEFinishRotatePkiSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishRotatePkiSuccessK ¶ added in v4.4.0
type ConnectorEventGetResponseEFinishRotatePkiSuccessK string
Finished PKI rotation
const (
ConnectorEventGetResponseEFinishRotatePkiSuccessKFinishRotatePkiSuccess ConnectorEventGetResponseEFinishRotatePkiSuccessK = "FinishRotatePkiSuccess"
)
func (ConnectorEventGetResponseEFinishRotatePkiSuccessK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventGetResponseEFinishRotatePkiSuccessK) IsKnown() bool
type ConnectorEventGetResponseEFinishUpgradeFailure ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishUpgradeFailure struct {
// Failed upgrade
K ConnectorEventGetResponseEFinishUpgradeFailureK `json:"k,required"`
JSON connectorEventGetResponseEFinishUpgradeFailureJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishUpgradeFailure) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishUpgradeFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishUpgradeFailureK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishUpgradeFailureK string
Failed upgrade
const (
ConnectorEventGetResponseEFinishUpgradeFailureKFinishUpgradeFailure ConnectorEventGetResponseEFinishUpgradeFailureK = "FinishUpgradeFailure"
)
func (ConnectorEventGetResponseEFinishUpgradeFailureK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishUpgradeFailureK) IsKnown() bool
type ConnectorEventGetResponseEFinishUpgradeSuccess ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishUpgradeSuccess struct {
// Finished upgrade
K ConnectorEventGetResponseEFinishUpgradeSuccessK `json:"k,required"`
JSON connectorEventGetResponseEFinishUpgradeSuccessJSON `json:"-"`
}
func (*ConnectorEventGetResponseEFinishUpgradeSuccess) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEFinishUpgradeSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEFinishUpgradeSuccessK ¶ added in v4.2.0
type ConnectorEventGetResponseEFinishUpgradeSuccessK string
Finished upgrade
const (
ConnectorEventGetResponseEFinishUpgradeSuccessKFinishUpgradeSuccess ConnectorEventGetResponseEFinishUpgradeSuccessK = "FinishUpgradeSuccess"
)
func (ConnectorEventGetResponseEFinishUpgradeSuccessK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEFinishUpgradeSuccessK) IsKnown() bool
type ConnectorEventGetResponseEInit ¶ added in v4.2.0
type ConnectorEventGetResponseEInit struct {
// Initialized process
K ConnectorEventGetResponseEInitK `json:"k,required"`
JSON connectorEventGetResponseEInitJSON `json:"-"`
}
func (*ConnectorEventGetResponseEInit) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEInit) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEInitK ¶ added in v4.2.0
type ConnectorEventGetResponseEInitK string
Initialized process
const (
ConnectorEventGetResponseEInitKInit ConnectorEventGetResponseEInitK = "Init"
)
func (ConnectorEventGetResponseEInitK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEInitK) IsKnown() bool
type ConnectorEventGetResponseEK ¶ added in v4.2.0
type ConnectorEventGetResponseEK string
Initialized process
const ( ConnectorEventGetResponseEKInit ConnectorEventGetResponseEK = "Init" ConnectorEventGetResponseEKLeave ConnectorEventGetResponseEK = "Leave" ConnectorEventGetResponseEKStartAttestation ConnectorEventGetResponseEK = "StartAttestation" ConnectorEventGetResponseEKFinishAttestationSuccess ConnectorEventGetResponseEK = "FinishAttestationSuccess" ConnectorEventGetResponseEKFinishAttestationFailure ConnectorEventGetResponseEK = "FinishAttestationFailure" ConnectorEventGetResponseEKStartRotateCryptKey ConnectorEventGetResponseEK = "StartRotateCryptKey" ConnectorEventGetResponseEKFinishRotateCryptKeySuccess ConnectorEventGetResponseEK = "FinishRotateCryptKeySuccess" ConnectorEventGetResponseEKFinishRotateCryptKeyFailure ConnectorEventGetResponseEK = "FinishRotateCryptKeyFailure" ConnectorEventGetResponseEKStartRotatePki ConnectorEventGetResponseEK = "StartRotatePki" ConnectorEventGetResponseEKFinishRotatePkiSuccess ConnectorEventGetResponseEK = "FinishRotatePkiSuccess" ConnectorEventGetResponseEKFinishRotatePkiFailure ConnectorEventGetResponseEK = "FinishRotatePkiFailure" ConnectorEventGetResponseEKStartUpgrade ConnectorEventGetResponseEK = "StartUpgrade" ConnectorEventGetResponseEKFinishUpgradeSuccess ConnectorEventGetResponseEK = "FinishUpgradeSuccess" ConnectorEventGetResponseEKFinishUpgradeFailure ConnectorEventGetResponseEK = "FinishUpgradeFailure" ConnectorEventGetResponseEKReconcile ConnectorEventGetResponseEK = "Reconcile" ConnectorEventGetResponseEKConfigureCloudflaredTunnel ConnectorEventGetResponseEK = "ConfigureCloudflaredTunnel" )
func (ConnectorEventGetResponseEK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEK) IsKnown() bool
type ConnectorEventGetResponseELeave ¶ added in v4.2.0
type ConnectorEventGetResponseELeave struct {
// Stopped process
K ConnectorEventGetResponseELeaveK `json:"k,required"`
JSON connectorEventGetResponseELeaveJSON `json:"-"`
}
func (*ConnectorEventGetResponseELeave) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseELeave) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseELeaveK ¶ added in v4.2.0
type ConnectorEventGetResponseELeaveK string
Stopped process
const (
ConnectorEventGetResponseELeaveKLeave ConnectorEventGetResponseELeaveK = "Leave"
)
func (ConnectorEventGetResponseELeaveK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseELeaveK) IsKnown() bool
type ConnectorEventGetResponseEReconcile ¶ added in v4.2.0
type ConnectorEventGetResponseEReconcile struct {
// Reconciled
K ConnectorEventGetResponseEReconcileK `json:"k,required"`
JSON connectorEventGetResponseEReconcileJSON `json:"-"`
}
func (*ConnectorEventGetResponseEReconcile) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEReconcile) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEReconcileK ¶ added in v4.2.0
type ConnectorEventGetResponseEReconcileK string
Reconciled
const (
ConnectorEventGetResponseEReconcileKReconcile ConnectorEventGetResponseEReconcileK = "Reconcile"
)
func (ConnectorEventGetResponseEReconcileK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEReconcileK) IsKnown() bool
type ConnectorEventGetResponseEStartAttestation ¶ added in v4.2.0
type ConnectorEventGetResponseEStartAttestation struct {
// Started attestation
K ConnectorEventGetResponseEStartAttestationK `json:"k,required"`
JSON connectorEventGetResponseEStartAttestationJSON `json:"-"`
}
func (*ConnectorEventGetResponseEStartAttestation) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEStartAttestation) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEStartAttestationK ¶ added in v4.2.0
type ConnectorEventGetResponseEStartAttestationK string
Started attestation
const (
ConnectorEventGetResponseEStartAttestationKStartAttestation ConnectorEventGetResponseEStartAttestationK = "StartAttestation"
)
func (ConnectorEventGetResponseEStartAttestationK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEStartAttestationK) IsKnown() bool
type ConnectorEventGetResponseEStartRotateCryptKey ¶ added in v4.2.0
type ConnectorEventGetResponseEStartRotateCryptKey struct {
// Started crypt key rotation
K ConnectorEventGetResponseEStartRotateCryptKeyK `json:"k,required"`
JSON connectorEventGetResponseEStartRotateCryptKeyJSON `json:"-"`
}
func (*ConnectorEventGetResponseEStartRotateCryptKey) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEStartRotateCryptKey) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEStartRotateCryptKeyK ¶ added in v4.2.0
type ConnectorEventGetResponseEStartRotateCryptKeyK string
Started crypt key rotation
const (
ConnectorEventGetResponseEStartRotateCryptKeyKStartRotateCryptKey ConnectorEventGetResponseEStartRotateCryptKeyK = "StartRotateCryptKey"
)
func (ConnectorEventGetResponseEStartRotateCryptKeyK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEStartRotateCryptKeyK) IsKnown() bool
type ConnectorEventGetResponseEStartRotatePki ¶ added in v4.4.0
type ConnectorEventGetResponseEStartRotatePki struct {
// Started PKI rotation
K ConnectorEventGetResponseEStartRotatePkiK `json:"k,required"`
JSON connectorEventGetResponseEStartRotatePkiJSON `json:"-"`
}
func (*ConnectorEventGetResponseEStartRotatePki) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventGetResponseEStartRotatePki) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEStartRotatePkiK ¶ added in v4.4.0
type ConnectorEventGetResponseEStartRotatePkiK string
Started PKI rotation
const (
ConnectorEventGetResponseEStartRotatePkiKStartRotatePki ConnectorEventGetResponseEStartRotatePkiK = "StartRotatePki"
)
func (ConnectorEventGetResponseEStartRotatePkiK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventGetResponseEStartRotatePkiK) IsKnown() bool
type ConnectorEventGetResponseEStartUpgrade ¶ added in v4.2.0
type ConnectorEventGetResponseEStartUpgrade struct {
// Started upgrade
K ConnectorEventGetResponseEStartUpgradeK `json:"k,required"`
// Location of upgrade bundle
URL string `json:"url,required"`
JSON connectorEventGetResponseEStartUpgradeJSON `json:"-"`
}
func (*ConnectorEventGetResponseEStartUpgrade) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEStartUpgrade) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEStartUpgradeK ¶ added in v4.2.0
type ConnectorEventGetResponseEStartUpgradeK string
Started upgrade
const (
ConnectorEventGetResponseEStartUpgradeKStartUpgrade ConnectorEventGetResponseEStartUpgradeK = "StartUpgrade"
)
func (ConnectorEventGetResponseEStartUpgradeK) IsKnown ¶ added in v4.2.0
func (r ConnectorEventGetResponseEStartUpgradeK) IsKnown() bool
type ConnectorEventGetResponseEUnion ¶ added in v4.2.0
type ConnectorEventGetResponseEUnion interface {
// contains filtered or unexported methods
}
Union satisfied by ConnectorEventGetResponseEInit, ConnectorEventGetResponseELeave, ConnectorEventGetResponseEStartAttestation, ConnectorEventGetResponseEFinishAttestationSuccess, ConnectorEventGetResponseEFinishAttestationFailure, ConnectorEventGetResponseEStartRotateCryptKey, ConnectorEventGetResponseEFinishRotateCryptKeySuccess, ConnectorEventGetResponseEFinishRotateCryptKeyFailure, ConnectorEventGetResponseEStartRotatePki, ConnectorEventGetResponseEFinishRotatePkiSuccess, ConnectorEventGetResponseEFinishRotatePkiFailure, ConnectorEventGetResponseEStartUpgrade, ConnectorEventGetResponseEFinishUpgradeSuccess, ConnectorEventGetResponseEFinishUpgradeFailure, ConnectorEventGetResponseEReconcile or ConnectorEventGetResponseEConfigureCloudflaredTunnel.
type ConnectorEventGetResponseEnvelope ¶ added in v4.2.0
type ConnectorEventGetResponseEnvelope struct {
// Recorded Event
Result ConnectorEventGetResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorEventGetResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorEventGetResponseEnvelopeMessages `json:"messages"`
JSON connectorEventGetResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorEventGetResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorEventGetResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorEventGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorEventGetResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorEventGetResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorEventGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListParams ¶ added in v4.4.0
type ConnectorEventLatestListResponse ¶ added in v4.4.0
type ConnectorEventLatestListResponse struct {
Count float64 `json:"count,required"`
Items []ConnectorEventLatestListResponseItem `json:"items,required"`
JSON connectorEventLatestListResponseJSON `json:"-"`
}
func (*ConnectorEventLatestListResponse) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseEnvelope ¶ added in v4.4.0
type ConnectorEventLatestListResponseEnvelope struct {
Result ConnectorEventLatestListResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorEventLatestListResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorEventLatestListResponseEnvelopeMessages `json:"messages"`
JSON connectorEventLatestListResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseEnvelope) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseEnvelopeErrors ¶ added in v4.4.0
type ConnectorEventLatestListResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventLatestListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseEnvelopeMessages ¶ added in v4.4.0
type ConnectorEventLatestListResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventLatestListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItem ¶ added in v4.4.0
type ConnectorEventLatestListResponseItem struct {
E ConnectorEventLatestListResponseItemsE `json:"e,required"`
// Sequence number, used to order events with the same timestamp
N float64 `json:"n,required"`
// Time the Event was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
JSON connectorEventLatestListResponseItemJSON `json:"-"`
}
Recorded Event
func (*ConnectorEventLatestListResponseItem) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItem) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsE ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsE struct {
// Initialized process
K ConnectorEventLatestListResponseItemsEK `json:"k,required"`
// Location of upgrade bundle
URL string `json:"url"`
JSON connectorEventLatestListResponseItemsEJSON `json:"-"`
// contains filtered or unexported fields
}
func (ConnectorEventLatestListResponseItemsE) AsUnion ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsE) AsUnion() ConnectorEventLatestListResponseItemsEUnion
AsUnion returns a ConnectorEventLatestListResponseItemsEUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ConnectorEventLatestListResponseItemsEInit, ConnectorEventLatestListResponseItemsELeave, ConnectorEventLatestListResponseItemsEStartAttestation, ConnectorEventLatestListResponseItemsEFinishAttestationSuccess, ConnectorEventLatestListResponseItemsEFinishAttestationFailure, ConnectorEventLatestListResponseItemsEStartRotateCryptKey, ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess, ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure, ConnectorEventLatestListResponseItemsEStartRotatePki, ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess, ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure, ConnectorEventLatestListResponseItemsEStartUpgrade, ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess, ConnectorEventLatestListResponseItemsEFinishUpgradeFailure, ConnectorEventLatestListResponseItemsEReconcile, ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel.
func (*ConnectorEventLatestListResponseItemsE) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsE) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel struct {
// Configured Cloudflared tunnel
K ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEConfigureCloudflaredTunnelJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK string
Configured Cloudflared tunnel
const (
ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelKConfigureCloudflaredTunnel ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK = "ConfigureCloudflaredTunnel"
)
func (ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishAttestationFailure ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishAttestationFailure struct {
// Failed attestation
K ConnectorEventLatestListResponseItemsEFinishAttestationFailureK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishAttestationFailureJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishAttestationFailure) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishAttestationFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishAttestationFailureK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishAttestationFailureK string
Failed attestation
const (
ConnectorEventLatestListResponseItemsEFinishAttestationFailureKFinishAttestationFailure ConnectorEventLatestListResponseItemsEFinishAttestationFailureK = "FinishAttestationFailure"
)
func (ConnectorEventLatestListResponseItemsEFinishAttestationFailureK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishAttestationFailureK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishAttestationSuccess ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishAttestationSuccess struct {
// Finished attestation
K ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishAttestationSuccessJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishAttestationSuccess) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishAttestationSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK string
Finished attestation
const (
ConnectorEventLatestListResponseItemsEFinishAttestationSuccessKFinishAttestationSuccess ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK = "FinishAttestationSuccess"
)
func (ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure struct {
// Failed crypt key rotation
K ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK string
Failed crypt key rotation
const (
ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureKFinishRotateCryptKeyFailure ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK = "FinishRotateCryptKeyFailure"
)
func (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess struct {
// Finished crypt key rotation
K ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK string
Finished crypt key rotation
const (
ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessKFinishRotateCryptKeySuccess ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK = "FinishRotateCryptKeySuccess"
)
func (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure struct {
// Failed PKI rotation
K ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishRotatePkiFailureJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK string
Failed PKI rotation
const (
ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureKFinishRotatePkiFailure ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK = "FinishRotatePkiFailure"
)
func (ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess struct {
// Finished PKI rotation
K ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishRotatePkiSuccessJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK string
Finished PKI rotation
const (
ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessKFinishRotatePkiSuccess ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK = "FinishRotatePkiSuccess"
)
func (ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishUpgradeFailure ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishUpgradeFailure struct {
// Failed upgrade
K ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishUpgradeFailureJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishUpgradeFailure) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishUpgradeFailure) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK string
Failed upgrade
const (
ConnectorEventLatestListResponseItemsEFinishUpgradeFailureKFinishUpgradeFailure ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK = "FinishUpgradeFailure"
)
func (ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess struct {
// Finished upgrade
K ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEFinishUpgradeSuccessJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK string
Finished upgrade
const (
ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessKFinishUpgradeSuccess ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK = "FinishUpgradeSuccess"
)
func (ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEInit ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEInit struct {
// Initialized process
K ConnectorEventLatestListResponseItemsEInitK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEInitJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEInit) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEInit) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEInitK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEInitK string
Initialized process
const (
ConnectorEventLatestListResponseItemsEInitKInit ConnectorEventLatestListResponseItemsEInitK = "Init"
)
func (ConnectorEventLatestListResponseItemsEInitK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEInitK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEK string
Initialized process
const ( ConnectorEventLatestListResponseItemsEKInit ConnectorEventLatestListResponseItemsEK = "Init" ConnectorEventLatestListResponseItemsEKLeave ConnectorEventLatestListResponseItemsEK = "Leave" ConnectorEventLatestListResponseItemsEKStartAttestation ConnectorEventLatestListResponseItemsEK = "StartAttestation" ConnectorEventLatestListResponseItemsEKFinishAttestationSuccess ConnectorEventLatestListResponseItemsEK = "FinishAttestationSuccess" ConnectorEventLatestListResponseItemsEKFinishAttestationFailure ConnectorEventLatestListResponseItemsEK = "FinishAttestationFailure" ConnectorEventLatestListResponseItemsEKStartRotateCryptKey ConnectorEventLatestListResponseItemsEK = "StartRotateCryptKey" ConnectorEventLatestListResponseItemsEKFinishRotateCryptKeySuccess ConnectorEventLatestListResponseItemsEK = "FinishRotateCryptKeySuccess" ConnectorEventLatestListResponseItemsEKFinishRotateCryptKeyFailure ConnectorEventLatestListResponseItemsEK = "FinishRotateCryptKeyFailure" ConnectorEventLatestListResponseItemsEKStartRotatePki ConnectorEventLatestListResponseItemsEK = "StartRotatePki" ConnectorEventLatestListResponseItemsEKFinishRotatePkiSuccess ConnectorEventLatestListResponseItemsEK = "FinishRotatePkiSuccess" ConnectorEventLatestListResponseItemsEKFinishRotatePkiFailure ConnectorEventLatestListResponseItemsEK = "FinishRotatePkiFailure" ConnectorEventLatestListResponseItemsEKStartUpgrade ConnectorEventLatestListResponseItemsEK = "StartUpgrade" ConnectorEventLatestListResponseItemsEKFinishUpgradeSuccess ConnectorEventLatestListResponseItemsEK = "FinishUpgradeSuccess" ConnectorEventLatestListResponseItemsEKFinishUpgradeFailure ConnectorEventLatestListResponseItemsEK = "FinishUpgradeFailure" ConnectorEventLatestListResponseItemsEKReconcile ConnectorEventLatestListResponseItemsEK = "Reconcile" ConnectorEventLatestListResponseItemsEKConfigureCloudflaredTunnel ConnectorEventLatestListResponseItemsEK = "ConfigureCloudflaredTunnel" )
func (ConnectorEventLatestListResponseItemsEK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEK) IsKnown() bool
type ConnectorEventLatestListResponseItemsELeave ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsELeave struct {
// Stopped process
K ConnectorEventLatestListResponseItemsELeaveK `json:"k,required"`
JSON connectorEventLatestListResponseItemsELeaveJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsELeave) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsELeave) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsELeaveK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsELeaveK string
Stopped process
const (
ConnectorEventLatestListResponseItemsELeaveKLeave ConnectorEventLatestListResponseItemsELeaveK = "Leave"
)
func (ConnectorEventLatestListResponseItemsELeaveK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsELeaveK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEReconcile ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEReconcile struct {
// Reconciled
K ConnectorEventLatestListResponseItemsEReconcileK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEReconcileJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEReconcile) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEReconcile) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEReconcileK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEReconcileK string
Reconciled
const (
ConnectorEventLatestListResponseItemsEReconcileKReconcile ConnectorEventLatestListResponseItemsEReconcileK = "Reconcile"
)
func (ConnectorEventLatestListResponseItemsEReconcileK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEReconcileK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEStartAttestation ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartAttestation struct {
// Started attestation
K ConnectorEventLatestListResponseItemsEStartAttestationK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEStartAttestationJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEStartAttestation) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEStartAttestation) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEStartAttestationK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartAttestationK string
Started attestation
const (
ConnectorEventLatestListResponseItemsEStartAttestationKStartAttestation ConnectorEventLatestListResponseItemsEStartAttestationK = "StartAttestation"
)
func (ConnectorEventLatestListResponseItemsEStartAttestationK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEStartAttestationK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEStartRotateCryptKey ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartRotateCryptKey struct {
// Started crypt key rotation
K ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEStartRotateCryptKeyJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEStartRotateCryptKey) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEStartRotateCryptKey) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK string
Started crypt key rotation
const (
ConnectorEventLatestListResponseItemsEStartRotateCryptKeyKStartRotateCryptKey ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK = "StartRotateCryptKey"
)
func (ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEStartRotatePki ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartRotatePki struct {
// Started PKI rotation
K ConnectorEventLatestListResponseItemsEStartRotatePkiK `json:"k,required"`
JSON connectorEventLatestListResponseItemsEStartRotatePkiJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEStartRotatePki) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEStartRotatePki) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEStartRotatePkiK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartRotatePkiK string
Started PKI rotation
const (
ConnectorEventLatestListResponseItemsEStartRotatePkiKStartRotatePki ConnectorEventLatestListResponseItemsEStartRotatePkiK = "StartRotatePki"
)
func (ConnectorEventLatestListResponseItemsEStartRotatePkiK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEStartRotatePkiK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEStartUpgrade ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartUpgrade struct {
// Started upgrade
K ConnectorEventLatestListResponseItemsEStartUpgradeK `json:"k,required"`
// Location of upgrade bundle
URL string `json:"url,required"`
JSON connectorEventLatestListResponseItemsEStartUpgradeJSON `json:"-"`
}
func (*ConnectorEventLatestListResponseItemsEStartUpgrade) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorEventLatestListResponseItemsEStartUpgrade) UnmarshalJSON(data []byte) (err error)
type ConnectorEventLatestListResponseItemsEStartUpgradeK ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEStartUpgradeK string
Started upgrade
const (
ConnectorEventLatestListResponseItemsEStartUpgradeKStartUpgrade ConnectorEventLatestListResponseItemsEStartUpgradeK = "StartUpgrade"
)
func (ConnectorEventLatestListResponseItemsEStartUpgradeK) IsKnown ¶ added in v4.4.0
func (r ConnectorEventLatestListResponseItemsEStartUpgradeK) IsKnown() bool
type ConnectorEventLatestListResponseItemsEUnion ¶ added in v4.4.0
type ConnectorEventLatestListResponseItemsEUnion interface {
// contains filtered or unexported methods
}
Union satisfied by ConnectorEventLatestListResponseItemsEInit, ConnectorEventLatestListResponseItemsELeave, ConnectorEventLatestListResponseItemsEStartAttestation, ConnectorEventLatestListResponseItemsEFinishAttestationSuccess, ConnectorEventLatestListResponseItemsEFinishAttestationFailure, ConnectorEventLatestListResponseItemsEStartRotateCryptKey, ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess, ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure, ConnectorEventLatestListResponseItemsEStartRotatePki, ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess, ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure, ConnectorEventLatestListResponseItemsEStartUpgrade, ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess, ConnectorEventLatestListResponseItemsEFinishUpgradeFailure, ConnectorEventLatestListResponseItemsEReconcile or ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel.
type ConnectorEventLatestService ¶ added in v4.4.0
type ConnectorEventLatestService struct {
Options []option.RequestOption
}
ConnectorEventLatestService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewConnectorEventLatestService method instead.
func NewConnectorEventLatestService ¶ added in v4.4.0
func NewConnectorEventLatestService(opts ...option.RequestOption) (r *ConnectorEventLatestService)
NewConnectorEventLatestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ConnectorEventLatestService) List ¶ added in v4.4.0
func (r *ConnectorEventLatestService) List(ctx context.Context, connectorID string, query ConnectorEventLatestListParams, opts ...option.RequestOption) (res *ConnectorEventLatestListResponse, err error)
Get latest Events
type ConnectorEventListParams ¶ added in v4.2.0
type ConnectorEventListParams struct {
AccountID param.Field[float64] `path:"account_id,required"`
From param.Field[float64] `query:"from,required"`
To param.Field[float64] `query:"to,required"`
Cursor param.Field[string] `query:"cursor"`
Limit param.Field[float64] `query:"limit"`
}
func (ConnectorEventListParams) URLQuery ¶ added in v4.2.0
func (r ConnectorEventListParams) URLQuery() (v url.Values)
URLQuery serializes ConnectorEventListParams's query parameters as `url.Values`.
type ConnectorEventListResponse ¶ added in v4.2.0
type ConnectorEventListResponse struct {
Count float64 `json:"count,required"`
Items []ConnectorEventListResponseItem `json:"items,required"`
Cursor string `json:"cursor"`
JSON connectorEventListResponseJSON `json:"-"`
}
func (*ConnectorEventListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventListResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorEventListResponseEnvelope ¶ added in v4.2.0
type ConnectorEventListResponseEnvelope struct {
Result ConnectorEventListResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorEventListResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorEventListResponseEnvelopeMessages `json:"messages"`
JSON connectorEventListResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorEventListResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorEventListResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorEventListResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorEventListResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorEventListResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorEventListResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorEventListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorEventListResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorEventListResponseItem ¶ added in v4.2.0
type ConnectorEventListResponseItem struct {
// Time the Event was collected (seconds since the Unix epoch)
A float64 `json:"a,required"`
// Kind
K string `json:"k,required"`
// Sequence number, used to order events with the same timestamp
N float64 `json:"n,required"`
// Time the Event was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
JSON connectorEventListResponseItemJSON `json:"-"`
}
func (*ConnectorEventListResponseItem) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorEventListResponseItem) UnmarshalJSON(data []byte) (err error)
type ConnectorEventService ¶ added in v4.2.0
type ConnectorEventService struct {
Options []option.RequestOption
Latest *ConnectorEventLatestService
}
ConnectorEventService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewConnectorEventService method instead.
func NewConnectorEventService ¶ added in v4.2.0
func NewConnectorEventService(opts ...option.RequestOption) (r *ConnectorEventService)
NewConnectorEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ConnectorEventService) Get ¶ added in v4.2.0
func (r *ConnectorEventService) Get(ctx context.Context, connectorID string, eventT float64, eventN float64, query ConnectorEventGetParams, opts ...option.RequestOption) (res *ConnectorEventGetResponse, err error)
Get Event
func (*ConnectorEventService) List ¶ added in v4.2.0
func (r *ConnectorEventService) List(ctx context.Context, connectorID string, params ConnectorEventListParams, opts ...option.RequestOption) (res *ConnectorEventListResponse, err error)
List Events
type ConnectorGetParams ¶
type ConnectorGetResponse ¶
type ConnectorGetResponse struct {
ID string `json:"id,required"`
Activated bool `json:"activated,required"`
InterruptWindowDurationHours float64 `json:"interrupt_window_duration_hours,required"`
InterruptWindowHourOfDay float64 `json:"interrupt_window_hour_of_day,required"`
LastUpdated string `json:"last_updated,required"`
Notes string `json:"notes,required"`
Timezone string `json:"timezone,required"`
Device ConnectorGetResponseDevice `json:"device"`
LastHeartbeat string `json:"last_heartbeat"`
LastSeenVersion string `json:"last_seen_version"`
JSON connectorGetResponseJSON `json:"-"`
}
func (*ConnectorGetResponse) UnmarshalJSON ¶
func (r *ConnectorGetResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorGetResponseDevice ¶
type ConnectorGetResponseDevice struct {
ID string `json:"id,required"`
SerialNumber string `json:"serial_number"`
JSON connectorGetResponseDeviceJSON `json:"-"`
}
func (*ConnectorGetResponseDevice) UnmarshalJSON ¶
func (r *ConnectorGetResponseDevice) UnmarshalJSON(data []byte) (err error)
type ConnectorGetResponseEnvelope ¶
type ConnectorGetResponseEnvelope struct {
Errors []ConnectorGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ConnectorGetResponseEnvelopeMessages `json:"messages,required"`
Result ConnectorGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON connectorGetResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorGetResponseEnvelope) UnmarshalJSON ¶
func (r *ConnectorGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorGetResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorGetResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorGetResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorGetResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorListParams ¶
type ConnectorListResponse ¶
type ConnectorListResponse struct {
ID string `json:"id,required"`
Activated bool `json:"activated,required"`
InterruptWindowDurationHours float64 `json:"interrupt_window_duration_hours,required"`
InterruptWindowHourOfDay float64 `json:"interrupt_window_hour_of_day,required"`
LastUpdated string `json:"last_updated,required"`
Notes string `json:"notes,required"`
Timezone string `json:"timezone,required"`
Device ConnectorListResponseDevice `json:"device"`
LastHeartbeat string `json:"last_heartbeat"`
LastSeenVersion string `json:"last_seen_version"`
JSON connectorListResponseJSON `json:"-"`
}
func (*ConnectorListResponse) UnmarshalJSON ¶
func (r *ConnectorListResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorListResponseDevice ¶
type ConnectorListResponseDevice struct {
ID string `json:"id,required"`
SerialNumber string `json:"serial_number"`
JSON connectorListResponseDeviceJSON `json:"-"`
}
func (*ConnectorListResponseDevice) UnmarshalJSON ¶
func (r *ConnectorListResponseDevice) UnmarshalJSON(data []byte) (err error)
type ConnectorService ¶
type ConnectorService struct {
Options []option.RequestOption
Events *ConnectorEventService
Snapshots *ConnectorSnapshotService
}
ConnectorService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewConnectorService method instead.
func NewConnectorService ¶
func NewConnectorService(opts ...option.RequestOption) (r *ConnectorService)
NewConnectorService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ConnectorService) Edit ¶
func (r *ConnectorService) Edit(ctx context.Context, connectorID string, params ConnectorEditParams, opts ...option.RequestOption) (res *ConnectorEditResponse, err error)
Update Connector
func (*ConnectorService) Get ¶
func (r *ConnectorService) Get(ctx context.Context, connectorID string, query ConnectorGetParams, opts ...option.RequestOption) (res *ConnectorGetResponse, err error)
Fetch Connector
func (*ConnectorService) List ¶
func (r *ConnectorService) List(ctx context.Context, query ConnectorListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ConnectorListResponse], err error)
List Connectors
func (*ConnectorService) ListAutoPaging ¶
func (r *ConnectorService) ListAutoPaging(ctx context.Context, query ConnectorListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ConnectorListResponse]
List Connectors
func (*ConnectorService) Update ¶
func (r *ConnectorService) Update(ctx context.Context, connectorID string, params ConnectorUpdateParams, opts ...option.RequestOption) (res *ConnectorUpdateResponse, err error)
Replace Connector
type ConnectorSnapshotGetParams ¶ added in v4.2.0
type ConnectorSnapshotGetResponse ¶ added in v4.2.0
type ConnectorSnapshotGetResponse struct {
// Count of failures to reclaim space
CountReclaimFailures float64 `json:"count_reclaim_failures,required"`
// Count of reclaimed paths
CountReclaimedPaths float64 `json:"count_reclaimed_paths,required"`
// Count of failed snapshot recordings
CountRecordFailed float64 `json:"count_record_failed,required"`
// Count of failed snapshot transmissions
CountTransmitFailures float64 `json:"count_transmit_failures,required"`
// Time the Snapshot was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
// Version
V string `json:"v,required"`
// Count of processors/cores
CPUCount float64 `json:"cpu_count"`
// Percentage of time over a 10 second window that tasks were stalled
CPUPressure10s float64 `json:"cpu_pressure_10s"`
// Percentage of time over a 5 minute window that tasks were stalled
CPUPressure300s float64 `json:"cpu_pressure_300s"`
// Percentage of time over a 1 minute window that tasks were stalled
CPUPressure60s float64 `json:"cpu_pressure_60s"`
// Total stall time (microseconds)
CPUPressureTotalUs float64 `json:"cpu_pressure_total_us"`
// Time spent running a virtual CPU or guest OS (milliseconds)
CPUTimeGuestMs float64 `json:"cpu_time_guest_ms"`
// Time spent running a niced guest (milliseconds)
CPUTimeGuestNiceMs float64 `json:"cpu_time_guest_nice_ms"`
// Time spent in idle state (milliseconds)
CPUTimeIdleMs float64 `json:"cpu_time_idle_ms"`
// Time spent wait for I/O to complete (milliseconds)
CPUTimeIowaitMs float64 `json:"cpu_time_iowait_ms"`
// Time spent servicing interrupts (milliseconds)
CPUTimeIrqMs float64 `json:"cpu_time_irq_ms"`
// Time spent in low-priority user mode (milliseconds)
CPUTimeNiceMs float64 `json:"cpu_time_nice_ms"`
// Time spent servicing softirqs (milliseconds)
CPUTimeSoftirqMs float64 `json:"cpu_time_softirq_ms"`
// Time stolen (milliseconds)
CPUTimeStealMs float64 `json:"cpu_time_steal_ms"`
// Time spent in system mode (milliseconds)
CPUTimeSystemMs float64 `json:"cpu_time_system_ms"`
// Time spent in user mode (milliseconds)
CPUTimeUserMs float64 `json:"cpu_time_user_ms"`
DHCPLeases []ConnectorSnapshotGetResponseDHCPLease `json:"dhcp_leases"`
Disks []ConnectorSnapshotGetResponseDisk `json:"disks"`
// Name of high availability state
HaState string `json:"ha_state"`
// Numeric value associated with high availability state (0 = disabled, 1 = active,
// 2 = standby, 3 = stopped, 4 = fault)
HaValue float64 `json:"ha_value"`
Interfaces []ConnectorSnapshotGetResponseInterface `json:"interfaces"`
// Percentage of time over a 10 second window that all tasks were stalled
IoPressureFull10s float64 `json:"io_pressure_full_10s"`
// Percentage of time over a 5 minute window that all tasks were stalled
IoPressureFull300s float64 `json:"io_pressure_full_300s"`
// Percentage of time over a 1 minute window that all tasks were stalled
IoPressureFull60s float64 `json:"io_pressure_full_60s"`
// Total stall time (microseconds)
IoPressureFullTotalUs float64 `json:"io_pressure_full_total_us"`
// Percentage of time over a 10 second window that some tasks were stalled
IoPressureSome10s float64 `json:"io_pressure_some_10s"`
// Percentage of time over a 3 minute window that some tasks were stalled
IoPressureSome300s float64 `json:"io_pressure_some_300s"`
// Percentage of time over a 1 minute window that some tasks were stalled
IoPressureSome60s float64 `json:"io_pressure_some_60s"`
// Total stall time (microseconds)
IoPressureSomeTotalUs float64 `json:"io_pressure_some_total_us"`
// Boot time (seconds since Unix epoch)
KernelBtime float64 `json:"kernel_btime"`
// Number of context switches that the system underwent
KernelCtxt float64 `json:"kernel_ctxt"`
// Number of forks since boot
KernelProcesses float64 `json:"kernel_processes"`
// Number of processes blocked waiting for I/O
KernelProcessesBlocked float64 `json:"kernel_processes_blocked"`
// Number of processes in runnable state
KernelProcessesRunning float64 `json:"kernel_processes_running"`
// The fifteen-minute load average
LoadAverage15m float64 `json:"load_average_15m"`
// The one-minute load average
LoadAverage1m float64 `json:"load_average_1m"`
// The five-minute load average
LoadAverage5m float64 `json:"load_average_5m"`
// Number of currently runnable kernel scheduling entities
LoadAverageCur float64 `json:"load_average_cur"`
// Number of kernel scheduling entities that currently exist on the system
LoadAverageMax float64 `json:"load_average_max"`
// Memory that has been used more recently
MemoryActiveBytes float64 `json:"memory_active_bytes"`
// Non-file backed huge pages mapped into user-space page tables
MemoryAnonHugepagesBytes float64 `json:"memory_anon_hugepages_bytes"`
// Non-file backed pages mapped into user-space page tables
MemoryAnonPagesBytes float64 `json:"memory_anon_pages_bytes"`
// Estimate of how much memory is available for starting new applications
MemoryAvailableBytes float64 `json:"memory_available_bytes"`
// Memory used for block device bounce buffers
MemoryBounceBytes float64 `json:"memory_bounce_bytes"`
// Relatively temporary storage for raw disk blocks
MemoryBuffersBytes float64 `json:"memory_buffers_bytes"`
// In-memory cache for files read from the disk
MemoryCachedBytes float64 `json:"memory_cached_bytes"`
// Free CMA (Contiguous Memory Allocator) pages
MemoryCmaFreeBytes float64 `json:"memory_cma_free_bytes"`
// Total CMA (Contiguous Memory Allocator) pages
MemoryCmaTotalBytes float64 `json:"memory_cma_total_bytes"`
// Total amount of memory currently available to be allocated on the system
MemoryCommitLimitBytes float64 `json:"memory_commit_limit_bytes"`
// Amount of memory presently allocated on the system
MemoryCommittedAsBytes float64 `json:"memory_committed_as_bytes"`
// Memory which is waiting to get written back to the disk
MemoryDirtyBytes float64 `json:"memory_dirty_bytes"`
// The sum of LowFree and HighFree
MemoryFreeBytes float64 `json:"memory_free_bytes"`
// Amount of free highmem
MemoryHighFreeBytes float64 `json:"memory_high_free_bytes"`
// Total amount of highmem
MemoryHighTotalBytes float64 `json:"memory_high_total_bytes"`
// The number of huge pages in the pool that are not yet allocated
MemoryHugepagesFree float64 `json:"memory_hugepages_free"`
// Number of huge pages for which a commitment has been made, but no allocation has
// yet been made
MemoryHugepagesRsvd float64 `json:"memory_hugepages_rsvd"`
// Number of huge pages in the pool above the threshold
MemoryHugepagesSurp float64 `json:"memory_hugepages_surp"`
// The size of the pool of huge pages
MemoryHugepagesTotal float64 `json:"memory_hugepages_total"`
// The size of huge pages
MemoryHugepagesizeBytes float64 `json:"memory_hugepagesize_bytes"`
// Memory which has been less recently used
MemoryInactiveBytes float64 `json:"memory_inactive_bytes"`
// Kernel allocations that the kernel will attempt to reclaim under memory pressure
MemoryKReclaimableBytes float64 `json:"memory_k_reclaimable_bytes"`
// Amount of memory allocated to kernel stacks
MemoryKernelStackBytes float64 `json:"memory_kernel_stack_bytes"`
// Amount of free lowmem
MemoryLowFreeBytes float64 `json:"memory_low_free_bytes"`
// Total amount of lowmem
MemoryLowTotalBytes float64 `json:"memory_low_total_bytes"`
// Files which have been mapped into memory
MemoryMappedBytes float64 `json:"memory_mapped_bytes"`
// Amount of memory dedicated to the lowest level of page tables
MemoryPageTablesBytes float64 `json:"memory_page_tables_bytes"`
// Memory allocated to the per-cpu alloctor used to back per-cpu allocations
MemoryPerCPUBytes float64 `json:"memory_per_cpu_bytes"`
// Percentage of time over a 10 second window that all tasks were stalled
MemoryPressureFull10s float64 `json:"memory_pressure_full_10s"`
// Percentage of time over a 5 minute window that all tasks were stalled
MemoryPressureFull300s float64 `json:"memory_pressure_full_300s"`
// Percentage of time over a 1 minute window that all tasks were stalled
MemoryPressureFull60s float64 `json:"memory_pressure_full_60s"`
// Total stall time (microseconds)
MemoryPressureFullTotalUs float64 `json:"memory_pressure_full_total_us"`
// Percentage of time over a 10 second window that some tasks were stalled
MemoryPressureSome10s float64 `json:"memory_pressure_some_10s"`
// Percentage of time over a 5 minute window that some tasks were stalled
MemoryPressureSome300s float64 `json:"memory_pressure_some_300s"`
// Percentage of time over a 1 minute window that some tasks were stalled
MemoryPressureSome60s float64 `json:"memory_pressure_some_60s"`
// Total stall time (microseconds)
MemoryPressureSomeTotalUs float64 `json:"memory_pressure_some_total_us"`
// Part of slab that can be reclaimed on memory pressure
MemorySReclaimableBytes float64 `json:"memory_s_reclaimable_bytes"`
// Part of slab that cannot be reclaimed on memory pressure
MemorySUnreclaimBytes float64 `json:"memory_s_unreclaim_bytes"`
// Amount of memory dedicated to the lowest level of page tables
MemorySecondaryPageTablesBytes float64 `json:"memory_secondary_page_tables_bytes"`
// Amount of memory consumed by tmpfs
MemoryShmemBytes float64 `json:"memory_shmem_bytes"`
// Memory used by shmem and tmpfs, allocated with huge pages
MemoryShmemHugepagesBytes float64 `json:"memory_shmem_hugepages_bytes"`
// Shared memory mapped into user space with huge pages
MemoryShmemPmdMappedBytes float64 `json:"memory_shmem_pmd_mapped_bytes"`
// In-kernel data structures cache
MemorySlabBytes float64 `json:"memory_slab_bytes"`
// Memory swapped out and back in while still in swap file
MemorySwapCachedBytes float64 `json:"memory_swap_cached_bytes"`
// Amount of swap space that is currently unused
MemorySwapFreeBytes float64 `json:"memory_swap_free_bytes"`
// Total amount of swap space available
MemorySwapTotalBytes float64 `json:"memory_swap_total_bytes"`
// Total usable RAM
MemoryTotalBytes float64 `json:"memory_total_bytes"`
// Largest contiguous block of vmalloc area which is free
MemoryVmallocChunkBytes float64 `json:"memory_vmalloc_chunk_bytes"`
// Total size of vmalloc memory area
MemoryVmallocTotalBytes float64 `json:"memory_vmalloc_total_bytes"`
// Amount of vmalloc area which is used
MemoryVmallocUsedBytes float64 `json:"memory_vmalloc_used_bytes"`
// Memory which is actively being written back to the disk
MemoryWritebackBytes float64 `json:"memory_writeback_bytes"`
// Memory used by FUSE for temporary writeback buffers
MemoryWritebackTmpBytes float64 `json:"memory_writeback_tmp_bytes"`
// Memory consumed by the zswap backend, compressed
MemoryZSwapBytes float64 `json:"memory_z_swap_bytes"`
// Amount of anonymous memory stored in zswap, uncompressed
MemoryZSwappedBytes float64 `json:"memory_z_swapped_bytes"`
Mounts []ConnectorSnapshotGetResponseMount `json:"mounts"`
Netdevs []ConnectorSnapshotGetResponseNetdev `json:"netdevs"`
// Number of ICMP Address Mask Reply messages received
SnmpIcmpInAddrMaskReps float64 `json:"snmp_icmp_in_addr_mask_reps"`
// Number of ICMP Address Mask Request messages received
SnmpIcmpInAddrMasks float64 `json:"snmp_icmp_in_addr_masks"`
// Number of ICMP messages received with bad checksums
SnmpIcmpInCsumErrors float64 `json:"snmp_icmp_in_csum_errors"`
// Number of ICMP Destination Unreachable messages received
SnmpIcmpInDestUnreachs float64 `json:"snmp_icmp_in_dest_unreachs"`
// Number of ICMP Echo Reply messages received
SnmpIcmpInEchoReps float64 `json:"snmp_icmp_in_echo_reps"`
// Number of ICMP Echo (request) messages received
SnmpIcmpInEchos float64 `json:"snmp_icmp_in_echos"`
// Number of ICMP messages received with ICMP-specific errors
SnmpIcmpInErrors float64 `json:"snmp_icmp_in_errors"`
// Number of ICMP messages received
SnmpIcmpInMsgs float64 `json:"snmp_icmp_in_msgs"`
// Number of ICMP Parameter Problem messages received
SnmpIcmpInParmProbs float64 `json:"snmp_icmp_in_parm_probs"`
// Number of ICMP Redirect messages received
SnmpIcmpInRedirects float64 `json:"snmp_icmp_in_redirects"`
// Number of ICMP Source Quench messages received
SnmpIcmpInSrcQuenchs float64 `json:"snmp_icmp_in_src_quenchs"`
// Number of ICMP Time Exceeded messages received
SnmpIcmpInTimeExcds float64 `json:"snmp_icmp_in_time_excds"`
// Number of ICMP Address Mask Request messages received
SnmpIcmpInTimestampReps float64 `json:"snmp_icmp_in_timestamp_reps"`
// Number of ICMP Timestamp (request) messages received
SnmpIcmpInTimestamps float64 `json:"snmp_icmp_in_timestamps"`
// Number of ICMP Address Mask Reply messages sent
SnmpIcmpOutAddrMaskReps float64 `json:"snmp_icmp_out_addr_mask_reps"`
// Number of ICMP Address Mask Request messages sent
SnmpIcmpOutAddrMasks float64 `json:"snmp_icmp_out_addr_masks"`
// Number of ICMP Destination Unreachable messages sent
SnmpIcmpOutDestUnreachs float64 `json:"snmp_icmp_out_dest_unreachs"`
// Number of ICMP Echo Reply messages sent
SnmpIcmpOutEchoReps float64 `json:"snmp_icmp_out_echo_reps"`
// Number of ICMP Echo (request) messages sent
SnmpIcmpOutEchos float64 `json:"snmp_icmp_out_echos"`
// Number of ICMP messages which this entity did not send due to ICMP-specific
// errors
SnmpIcmpOutErrors float64 `json:"snmp_icmp_out_errors"`
// Number of ICMP messages attempted to send
SnmpIcmpOutMsgs float64 `json:"snmp_icmp_out_msgs"`
// Number of ICMP Parameter Problem messages sent
SnmpIcmpOutParmProbs float64 `json:"snmp_icmp_out_parm_probs"`
// Number of ICMP Redirect messages sent
SnmpIcmpOutRedirects float64 `json:"snmp_icmp_out_redirects"`
// Number of ICMP Source Quench messages sent
SnmpIcmpOutSrcQuenchs float64 `json:"snmp_icmp_out_src_quenchs"`
// Number of ICMP Time Exceeded messages sent
SnmpIcmpOutTimeExcds float64 `json:"snmp_icmp_out_time_excds"`
// Number of ICMP Timestamp Reply messages sent
SnmpIcmpOutTimestampReps float64 `json:"snmp_icmp_out_timestamp_reps"`
// Number of ICMP Timestamp (request) messages sent
SnmpIcmpOutTimestamps float64 `json:"snmp_icmp_out_timestamps"`
// Default value of the Time-To-Live field of the IP header
SnmpIPDefaultTTL float64 `json:"snmp_ip_default_ttl"`
// Number of datagrams forwarded to their final destination
SnmpIPForwDatagrams float64 `json:"snmp_ip_forw_datagrams"`
// Set when acting as an IP gateway
SnmpIPForwardingEnabled bool `json:"snmp_ip_forwarding_enabled"`
// Number of datagrams generated by fragmentation
SnmpIPFragCreates float64 `json:"snmp_ip_frag_creates"`
// Number of datagrams discarded because fragmentation failed
SnmpIPFragFails float64 `json:"snmp_ip_frag_fails"`
// Number of datagrams successfully fragmented
SnmpIPFragOks float64 `json:"snmp_ip_frag_oks"`
// Number of input datagrams discarded due to errors in the IP address
SnmpIPInAddrErrors float64 `json:"snmp_ip_in_addr_errors"`
// Number of input datagrams successfully delivered to IP user-protocols
SnmpIPInDelivers float64 `json:"snmp_ip_in_delivers"`
// Number of input datagrams otherwise discarded
SnmpIPInDiscards float64 `json:"snmp_ip_in_discards"`
// Number of input datagrams discarded due to errors in the IP header
SnmpIPInHdrErrors float64 `json:"snmp_ip_in_hdr_errors"`
// Number of input datagrams received from interfaces
SnmpIPInReceives float64 `json:"snmp_ip_in_receives"`
// Number of input datagrams discarded due unknown or unsupported protocol
SnmpIPInUnknownProtos float64 `json:"snmp_ip_in_unknown_protos"`
// Number of output datagrams otherwise discarded
SnmpIPOutDiscards float64 `json:"snmp_ip_out_discards"`
// Number of output datagrams discarded because no route matched
SnmpIPOutNoRoutes float64 `json:"snmp_ip_out_no_routes"`
// Number of datagrams supplied for transmission
SnmpIPOutRequests float64 `json:"snmp_ip_out_requests"`
// Number of failures detected by the reassembly algorithm
SnmpIPReasmFails float64 `json:"snmp_ip_reasm_fails"`
// Number of datagrams successfully reassembled
SnmpIPReasmOks float64 `json:"snmp_ip_reasm_oks"`
// Number of fragments received which needed to be reassembled
SnmpIPReasmReqds float64 `json:"snmp_ip_reasm_reqds"`
// Number of seconds fragments are held while awaiting reassembly
SnmpIPReasmTimeout float64 `json:"snmp_ip_reasm_timeout"`
// Number of times TCP transitions to SYN-SENT from CLOSED
SnmpTCPActiveOpens float64 `json:"snmp_tcp_active_opens"`
// Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus
// transitions to LISTEN from SYN-RCVD
SnmpTCPAttemptFails float64 `json:"snmp_tcp_attempt_fails"`
// Number of TCP connections in ESTABLISHED or CLOSE-WAIT
SnmpTCPCurrEstab float64 `json:"snmp_tcp_curr_estab"`
// Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT
SnmpTCPEstabResets float64 `json:"snmp_tcp_estab_resets"`
// Number of TCP segments received with checksum errors
SnmpTCPInCsumErrors float64 `json:"snmp_tcp_in_csum_errors"`
// Number of TCP segments received in error
SnmpTCPInErrs float64 `json:"snmp_tcp_in_errs"`
// Number of TCP segments received
SnmpTCPInSegs float64 `json:"snmp_tcp_in_segs"`
// Limit on the total number of TCP connections
SnmpTCPMaxConn float64 `json:"snmp_tcp_max_conn"`
// Number of TCP segments sent with RST flag
SnmpTCPOutRsts float64 `json:"snmp_tcp_out_rsts"`
// Number of TCP segments sent
SnmpTCPOutSegs float64 `json:"snmp_tcp_out_segs"`
// Number of times TCP transitions to SYN-RCVD from LISTEN
SnmpTCPPassiveOpens float64 `json:"snmp_tcp_passive_opens"`
// Number of TCP segments retransmitted
SnmpTCPRetransSegs float64 `json:"snmp_tcp_retrans_segs"`
// Maximum value permitted by a TCP implementation for the retransmission timeout
// (milliseconds)
SnmpTCPRtoMax float64 `json:"snmp_tcp_rto_max"`
// Minimum value permitted by a TCP implementation for the retransmission timeout
// (milliseconds)
SnmpTCPRtoMin float64 `json:"snmp_tcp_rto_min"`
// Number of UDP datagrams delivered to UDP applications
SnmpUdpInDatagrams float64 `json:"snmp_udp_in_datagrams"`
// Number of UDP datagrams failed to be delivered for reasons other than lack of
// application at the destination port
SnmpUdpInErrors float64 `json:"snmp_udp_in_errors"`
// Number of UDP datagrams received for which there was not application at the
// destination port
SnmpUdpNoPorts float64 `json:"snmp_udp_no_ports"`
// Number of UDP datagrams sent
SnmpUdpOutDatagrams float64 `json:"snmp_udp_out_datagrams"`
// Boottime of the system (seconds since the Unix epoch)
SystemBootTimeS float64 `json:"system_boot_time_s"`
Thermals []ConnectorSnapshotGetResponseThermal `json:"thermals"`
Tunnels []ConnectorSnapshotGetResponseTunnel `json:"tunnels"`
// Sum of how much time each core has spent idle
UptimeIdleMs float64 `json:"uptime_idle_ms"`
// Uptime of the system, including time spent in suspend
UptimeTotalMs float64 `json:"uptime_total_ms"`
JSON connectorSnapshotGetResponseJSON `json:"-"`
}
Snapshot
func (*ConnectorSnapshotGetResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseDHCPLease ¶ added in v4.3.0
type ConnectorSnapshotGetResponseDHCPLease struct {
// Client ID of the device the IP Address was leased to
ClientID string `json:"client_id,required"`
// Expiry time of the DHCP lease (seconds since the Unix epoch)
ExpiryTime float64 `json:"expiry_time,required"`
// Hostname of the device the IP Address was leased to
Hostname string `json:"hostname,required"`
// Name of the network interface
InterfaceName string `json:"interface_name,required"`
// IP Address that was leased
IPAddress string `json:"ip_address,required"`
// MAC Address of the device the IP Address was leased to
MacAddress string `json:"mac_address,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotGetResponseDHCPLeaseJSON `json:"-"`
}
Snapshot DHCP lease
func (*ConnectorSnapshotGetResponseDHCPLease) UnmarshalJSON ¶ added in v4.3.0
func (r *ConnectorSnapshotGetResponseDHCPLease) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseDisk ¶ added in v4.2.0
type ConnectorSnapshotGetResponseDisk struct {
// I/Os currently in progress
InProgress float64 `json:"in_progress,required"`
// Device major number
Major float64 `json:"major,required"`
// Reads merged
Merged float64 `json:"merged,required"`
// Device minor number
Minor float64 `json:"minor,required"`
// Device name
Name string `json:"name,required"`
// Reads completed successfully
Reads float64 `json:"reads,required"`
// Sectors read successfully
SectorsRead float64 `json:"sectors_read,required"`
// Sectors written successfully
SectorsWritten float64 `json:"sectors_written,required"`
// Time spent doing I/Os (milliseconds)
TimeInProgressMs float64 `json:"time_in_progress_ms,required"`
// Time spent reading (milliseconds)
TimeReadingMs float64 `json:"time_reading_ms,required"`
// Time spent writing (milliseconds)
TimeWritingMs float64 `json:"time_writing_ms,required"`
// Weighted time spent doing I/Os (milliseconds)
WeightedTimeInProgressMs float64 `json:"weighted_time_in_progress_ms,required"`
// Writes completed
Writes float64 `json:"writes,required"`
// Writes merged
WritesMerged float64 `json:"writes_merged,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Discards completed successfully
Discards float64 `json:"discards"`
// Discards merged
DiscardsMerged float64 `json:"discards_merged"`
// Flushes completed successfully
Flushes float64 `json:"flushes"`
// Sectors discarded
SectorsDiscarded float64 `json:"sectors_discarded"`
// Time spent discarding (milliseconds)
TimeDiscardingMs float64 `json:"time_discarding_ms"`
// Time spent flushing (milliseconds)
TimeFlushingMs float64 `json:"time_flushing_ms"`
JSON connectorSnapshotGetResponseDiskJSON `json:"-"`
}
Snapshot Disk
func (*ConnectorSnapshotGetResponseDisk) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseDisk) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseEnvelope ¶ added in v4.2.0
type ConnectorSnapshotGetResponseEnvelope struct {
// Snapshot
Result ConnectorSnapshotGetResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorSnapshotGetResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorSnapshotGetResponseEnvelopeMessages `json:"messages"`
JSON connectorSnapshotGetResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorSnapshotGetResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorSnapshotGetResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorSnapshotGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorSnapshotGetResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorSnapshotGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseInterface ¶ added in v4.3.0
type ConnectorSnapshotGetResponseInterface struct {
// Name of the network interface
Name string `json:"name,required"`
// UP/DOWN state of the network interface
Operstate string `json:"operstate,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
IPAddresses []ConnectorSnapshotGetResponseInterfacesIPAddress `json:"ip_addresses"`
// Speed of the network interface (bits per second)
Speed float64 `json:"speed"`
JSON connectorSnapshotGetResponseInterfaceJSON `json:"-"`
}
Snapshot Interface
func (*ConnectorSnapshotGetResponseInterface) UnmarshalJSON ¶ added in v4.3.0
func (r *ConnectorSnapshotGetResponseInterface) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseInterfacesIPAddress ¶ added in v4.3.0
type ConnectorSnapshotGetResponseInterfacesIPAddress struct {
// Name of the network interface
InterfaceName string `json:"interface_name,required"`
// IP address of the network interface
IPAddress string `json:"ip_address,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotGetResponseInterfacesIPAddressJSON `json:"-"`
}
Snapshot Interface Address
func (*ConnectorSnapshotGetResponseInterfacesIPAddress) UnmarshalJSON ¶ added in v4.3.0
func (r *ConnectorSnapshotGetResponseInterfacesIPAddress) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseMount ¶ added in v4.2.0
type ConnectorSnapshotGetResponseMount struct {
// File system on disk (EXT4, NTFS, etc.)
FileSystem string `json:"file_system,required"`
// Kind of disk (HDD, SSD, etc.)
Kind string `json:"kind,required"`
// Path where disk is mounted
MountPoint string `json:"mount_point,required"`
// Name of the disk mount
Name string `json:"name,required"`
// Available disk size (bytes)
AvailableBytes float64 `json:"available_bytes"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Determines whether the disk is read-only
IsReadOnly bool `json:"is_read_only"`
// Determines whether the disk is removable
IsRemovable bool `json:"is_removable"`
// Total disk size (bytes)
TotalBytes float64 `json:"total_bytes"`
JSON connectorSnapshotGetResponseMountJSON `json:"-"`
}
Snapshot Mount
func (*ConnectorSnapshotGetResponseMount) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseMount) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseNetdev ¶ added in v4.2.0
type ConnectorSnapshotGetResponseNetdev struct {
// Name of the network device
Name string `json:"name,required"`
// Total bytes received
RecvBytes float64 `json:"recv_bytes,required"`
// Compressed packets received
RecvCompressed float64 `json:"recv_compressed,required"`
// Packets dropped
RecvDrop float64 `json:"recv_drop,required"`
// Bad packets received
RecvErrs float64 `json:"recv_errs,required"`
// FIFO overruns
RecvFifo float64 `json:"recv_fifo,required"`
// Frame alignment errors
RecvFrame float64 `json:"recv_frame,required"`
// Multicast packets received
RecvMulticast float64 `json:"recv_multicast,required"`
// Total packets received
RecvPackets float64 `json:"recv_packets,required"`
// Total bytes transmitted
SentBytes float64 `json:"sent_bytes,required"`
// Number of packets not sent due to carrier errors
SentCarrier float64 `json:"sent_carrier,required"`
// Number of collisions
SentColls float64 `json:"sent_colls,required"`
// Number of compressed packets transmitted
SentCompressed float64 `json:"sent_compressed,required"`
// Number of packets dropped during transmission
SentDrop float64 `json:"sent_drop,required"`
// Number of transmission errors
SentErrs float64 `json:"sent_errs,required"`
// FIFO overruns
SentFifo float64 `json:"sent_fifo,required"`
// Total packets transmitted
SentPackets float64 `json:"sent_packets,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotGetResponseNetdevJSON `json:"-"`
}
Snapshot Netdev
func (*ConnectorSnapshotGetResponseNetdev) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseNetdev) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseThermal ¶ added in v4.2.0
type ConnectorSnapshotGetResponseThermal struct {
// Sensor identifier for the component
Label string `json:"label,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Critical failure temperature of the component (degrees Celsius)
CriticalCelcius float64 `json:"critical_celcius"`
// Current temperature of the component (degrees Celsius)
CurrentCelcius float64 `json:"current_celcius"`
// Maximum temperature of the component (degrees Celsius)
MaxCelcius float64 `json:"max_celcius"`
JSON connectorSnapshotGetResponseThermalJSON `json:"-"`
}
Snapshot Thermal
func (*ConnectorSnapshotGetResponseThermal) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotGetResponseThermal) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotGetResponseTunnel ¶ added in v4.3.0
type ConnectorSnapshotGetResponseTunnel struct {
// Name of tunnel health state (unknown, healthy, degraded, down)
HealthState string `json:"health_state,required"`
// Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 =
// degraded, 3 = down)
HealthValue float64 `json:"health_value,required"`
// The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.)
InterfaceName string `json:"interface_name,required"`
// Tunnel identifier
TunnelID string `json:"tunnel_id,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotGetResponseTunnelJSON `json:"-"`
}
Snapshot Tunnels
func (*ConnectorSnapshotGetResponseTunnel) UnmarshalJSON ¶ added in v4.3.0
func (r *ConnectorSnapshotGetResponseTunnel) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListParams ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponse ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponse struct {
Count float64 `json:"count,required"`
Items []ConnectorSnapshotLatestListResponseItem `json:"items,required"`
JSON connectorSnapshotLatestListResponseJSON `json:"-"`
}
func (*ConnectorSnapshotLatestListResponse) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseEnvelope ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseEnvelope struct {
Result ConnectorSnapshotLatestListResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorSnapshotLatestListResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorSnapshotLatestListResponseEnvelopeMessages `json:"messages"`
JSON connectorSnapshotLatestListResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorSnapshotLatestListResponseEnvelope) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseEnvelopeErrors ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotLatestListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorSnapshotLatestListResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseEnvelopeMessages ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotLatestListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorSnapshotLatestListResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItem ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItem struct {
// Count of failures to reclaim space
CountReclaimFailures float64 `json:"count_reclaim_failures,required"`
// Count of reclaimed paths
CountReclaimedPaths float64 `json:"count_reclaimed_paths,required"`
// Count of failed snapshot recordings
CountRecordFailed float64 `json:"count_record_failed,required"`
// Count of failed snapshot transmissions
CountTransmitFailures float64 `json:"count_transmit_failures,required"`
// Time the Snapshot was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
// Version
V string `json:"v,required"`
// Count of processors/cores
CPUCount float64 `json:"cpu_count"`
// Percentage of time over a 10 second window that tasks were stalled
CPUPressure10s float64 `json:"cpu_pressure_10s"`
// Percentage of time over a 5 minute window that tasks were stalled
CPUPressure300s float64 `json:"cpu_pressure_300s"`
// Percentage of time over a 1 minute window that tasks were stalled
CPUPressure60s float64 `json:"cpu_pressure_60s"`
// Total stall time (microseconds)
CPUPressureTotalUs float64 `json:"cpu_pressure_total_us"`
// Time spent running a virtual CPU or guest OS (milliseconds)
CPUTimeGuestMs float64 `json:"cpu_time_guest_ms"`
// Time spent running a niced guest (milliseconds)
CPUTimeGuestNiceMs float64 `json:"cpu_time_guest_nice_ms"`
// Time spent in idle state (milliseconds)
CPUTimeIdleMs float64 `json:"cpu_time_idle_ms"`
// Time spent wait for I/O to complete (milliseconds)
CPUTimeIowaitMs float64 `json:"cpu_time_iowait_ms"`
// Time spent servicing interrupts (milliseconds)
CPUTimeIrqMs float64 `json:"cpu_time_irq_ms"`
// Time spent in low-priority user mode (milliseconds)
CPUTimeNiceMs float64 `json:"cpu_time_nice_ms"`
// Time spent servicing softirqs (milliseconds)
CPUTimeSoftirqMs float64 `json:"cpu_time_softirq_ms"`
// Time stolen (milliseconds)
CPUTimeStealMs float64 `json:"cpu_time_steal_ms"`
// Time spent in system mode (milliseconds)
CPUTimeSystemMs float64 `json:"cpu_time_system_ms"`
// Time spent in user mode (milliseconds)
CPUTimeUserMs float64 `json:"cpu_time_user_ms"`
DHCPLeases []ConnectorSnapshotLatestListResponseItemsDHCPLease `json:"dhcp_leases"`
Disks []ConnectorSnapshotLatestListResponseItemsDisk `json:"disks"`
// Name of high availability state
HaState string `json:"ha_state"`
// Numeric value associated with high availability state (0 = disabled, 1 = active,
// 2 = standby, 3 = stopped, 4 = fault)
HaValue float64 `json:"ha_value"`
Interfaces []ConnectorSnapshotLatestListResponseItemsInterface `json:"interfaces"`
// Percentage of time over a 10 second window that all tasks were stalled
IoPressureFull10s float64 `json:"io_pressure_full_10s"`
// Percentage of time over a 5 minute window that all tasks were stalled
IoPressureFull300s float64 `json:"io_pressure_full_300s"`
// Percentage of time over a 1 minute window that all tasks were stalled
IoPressureFull60s float64 `json:"io_pressure_full_60s"`
// Total stall time (microseconds)
IoPressureFullTotalUs float64 `json:"io_pressure_full_total_us"`
// Percentage of time over a 10 second window that some tasks were stalled
IoPressureSome10s float64 `json:"io_pressure_some_10s"`
// Percentage of time over a 3 minute window that some tasks were stalled
IoPressureSome300s float64 `json:"io_pressure_some_300s"`
// Percentage of time over a 1 minute window that some tasks were stalled
IoPressureSome60s float64 `json:"io_pressure_some_60s"`
// Total stall time (microseconds)
IoPressureSomeTotalUs float64 `json:"io_pressure_some_total_us"`
// Boot time (seconds since Unix epoch)
KernelBtime float64 `json:"kernel_btime"`
// Number of context switches that the system underwent
KernelCtxt float64 `json:"kernel_ctxt"`
// Number of forks since boot
KernelProcesses float64 `json:"kernel_processes"`
// Number of processes blocked waiting for I/O
KernelProcessesBlocked float64 `json:"kernel_processes_blocked"`
// Number of processes in runnable state
KernelProcessesRunning float64 `json:"kernel_processes_running"`
// The fifteen-minute load average
LoadAverage15m float64 `json:"load_average_15m"`
// The one-minute load average
LoadAverage1m float64 `json:"load_average_1m"`
// The five-minute load average
LoadAverage5m float64 `json:"load_average_5m"`
// Number of currently runnable kernel scheduling entities
LoadAverageCur float64 `json:"load_average_cur"`
// Number of kernel scheduling entities that currently exist on the system
LoadAverageMax float64 `json:"load_average_max"`
// Memory that has been used more recently
MemoryActiveBytes float64 `json:"memory_active_bytes"`
// Non-file backed huge pages mapped into user-space page tables
MemoryAnonHugepagesBytes float64 `json:"memory_anon_hugepages_bytes"`
// Non-file backed pages mapped into user-space page tables
MemoryAnonPagesBytes float64 `json:"memory_anon_pages_bytes"`
// Estimate of how much memory is available for starting new applications
MemoryAvailableBytes float64 `json:"memory_available_bytes"`
// Memory used for block device bounce buffers
MemoryBounceBytes float64 `json:"memory_bounce_bytes"`
// Relatively temporary storage for raw disk blocks
MemoryBuffersBytes float64 `json:"memory_buffers_bytes"`
// In-memory cache for files read from the disk
MemoryCachedBytes float64 `json:"memory_cached_bytes"`
// Free CMA (Contiguous Memory Allocator) pages
MemoryCmaFreeBytes float64 `json:"memory_cma_free_bytes"`
// Total CMA (Contiguous Memory Allocator) pages
MemoryCmaTotalBytes float64 `json:"memory_cma_total_bytes"`
// Total amount of memory currently available to be allocated on the system
MemoryCommitLimitBytes float64 `json:"memory_commit_limit_bytes"`
// Amount of memory presently allocated on the system
MemoryCommittedAsBytes float64 `json:"memory_committed_as_bytes"`
// Memory which is waiting to get written back to the disk
MemoryDirtyBytes float64 `json:"memory_dirty_bytes"`
// The sum of LowFree and HighFree
MemoryFreeBytes float64 `json:"memory_free_bytes"`
// Amount of free highmem
MemoryHighFreeBytes float64 `json:"memory_high_free_bytes"`
// Total amount of highmem
MemoryHighTotalBytes float64 `json:"memory_high_total_bytes"`
// The number of huge pages in the pool that are not yet allocated
MemoryHugepagesFree float64 `json:"memory_hugepages_free"`
// Number of huge pages for which a commitment has been made, but no allocation has
// yet been made
MemoryHugepagesRsvd float64 `json:"memory_hugepages_rsvd"`
// Number of huge pages in the pool above the threshold
MemoryHugepagesSurp float64 `json:"memory_hugepages_surp"`
// The size of the pool of huge pages
MemoryHugepagesTotal float64 `json:"memory_hugepages_total"`
// The size of huge pages
MemoryHugepagesizeBytes float64 `json:"memory_hugepagesize_bytes"`
// Memory which has been less recently used
MemoryInactiveBytes float64 `json:"memory_inactive_bytes"`
// Kernel allocations that the kernel will attempt to reclaim under memory pressure
MemoryKReclaimableBytes float64 `json:"memory_k_reclaimable_bytes"`
// Amount of memory allocated to kernel stacks
MemoryKernelStackBytes float64 `json:"memory_kernel_stack_bytes"`
// Amount of free lowmem
MemoryLowFreeBytes float64 `json:"memory_low_free_bytes"`
// Total amount of lowmem
MemoryLowTotalBytes float64 `json:"memory_low_total_bytes"`
// Files which have been mapped into memory
MemoryMappedBytes float64 `json:"memory_mapped_bytes"`
// Amount of memory dedicated to the lowest level of page tables
MemoryPageTablesBytes float64 `json:"memory_page_tables_bytes"`
// Memory allocated to the per-cpu alloctor used to back per-cpu allocations
MemoryPerCPUBytes float64 `json:"memory_per_cpu_bytes"`
// Percentage of time over a 10 second window that all tasks were stalled
MemoryPressureFull10s float64 `json:"memory_pressure_full_10s"`
// Percentage of time over a 5 minute window that all tasks were stalled
MemoryPressureFull300s float64 `json:"memory_pressure_full_300s"`
// Percentage of time over a 1 minute window that all tasks were stalled
MemoryPressureFull60s float64 `json:"memory_pressure_full_60s"`
// Total stall time (microseconds)
MemoryPressureFullTotalUs float64 `json:"memory_pressure_full_total_us"`
// Percentage of time over a 10 second window that some tasks were stalled
MemoryPressureSome10s float64 `json:"memory_pressure_some_10s"`
// Percentage of time over a 5 minute window that some tasks were stalled
MemoryPressureSome300s float64 `json:"memory_pressure_some_300s"`
// Percentage of time over a 1 minute window that some tasks were stalled
MemoryPressureSome60s float64 `json:"memory_pressure_some_60s"`
// Total stall time (microseconds)
MemoryPressureSomeTotalUs float64 `json:"memory_pressure_some_total_us"`
// Part of slab that can be reclaimed on memory pressure
MemorySReclaimableBytes float64 `json:"memory_s_reclaimable_bytes"`
// Part of slab that cannot be reclaimed on memory pressure
MemorySUnreclaimBytes float64 `json:"memory_s_unreclaim_bytes"`
// Amount of memory dedicated to the lowest level of page tables
MemorySecondaryPageTablesBytes float64 `json:"memory_secondary_page_tables_bytes"`
// Amount of memory consumed by tmpfs
MemoryShmemBytes float64 `json:"memory_shmem_bytes"`
// Memory used by shmem and tmpfs, allocated with huge pages
MemoryShmemHugepagesBytes float64 `json:"memory_shmem_hugepages_bytes"`
// Shared memory mapped into user space with huge pages
MemoryShmemPmdMappedBytes float64 `json:"memory_shmem_pmd_mapped_bytes"`
// In-kernel data structures cache
MemorySlabBytes float64 `json:"memory_slab_bytes"`
// Memory swapped out and back in while still in swap file
MemorySwapCachedBytes float64 `json:"memory_swap_cached_bytes"`
// Amount of swap space that is currently unused
MemorySwapFreeBytes float64 `json:"memory_swap_free_bytes"`
// Total amount of swap space available
MemorySwapTotalBytes float64 `json:"memory_swap_total_bytes"`
// Total usable RAM
MemoryTotalBytes float64 `json:"memory_total_bytes"`
// Largest contiguous block of vmalloc area which is free
MemoryVmallocChunkBytes float64 `json:"memory_vmalloc_chunk_bytes"`
// Total size of vmalloc memory area
MemoryVmallocTotalBytes float64 `json:"memory_vmalloc_total_bytes"`
// Amount of vmalloc area which is used
MemoryVmallocUsedBytes float64 `json:"memory_vmalloc_used_bytes"`
// Memory which is actively being written back to the disk
MemoryWritebackBytes float64 `json:"memory_writeback_bytes"`
// Memory used by FUSE for temporary writeback buffers
MemoryWritebackTmpBytes float64 `json:"memory_writeback_tmp_bytes"`
// Memory consumed by the zswap backend, compressed
MemoryZSwapBytes float64 `json:"memory_z_swap_bytes"`
// Amount of anonymous memory stored in zswap, uncompressed
MemoryZSwappedBytes float64 `json:"memory_z_swapped_bytes"`
Mounts []ConnectorSnapshotLatestListResponseItemsMount `json:"mounts"`
Netdevs []ConnectorSnapshotLatestListResponseItemsNetdev `json:"netdevs"`
// Number of ICMP Address Mask Reply messages received
SnmpIcmpInAddrMaskReps float64 `json:"snmp_icmp_in_addr_mask_reps"`
// Number of ICMP Address Mask Request messages received
SnmpIcmpInAddrMasks float64 `json:"snmp_icmp_in_addr_masks"`
// Number of ICMP messages received with bad checksums
SnmpIcmpInCsumErrors float64 `json:"snmp_icmp_in_csum_errors"`
// Number of ICMP Destination Unreachable messages received
SnmpIcmpInDestUnreachs float64 `json:"snmp_icmp_in_dest_unreachs"`
// Number of ICMP Echo Reply messages received
SnmpIcmpInEchoReps float64 `json:"snmp_icmp_in_echo_reps"`
// Number of ICMP Echo (request) messages received
SnmpIcmpInEchos float64 `json:"snmp_icmp_in_echos"`
// Number of ICMP messages received with ICMP-specific errors
SnmpIcmpInErrors float64 `json:"snmp_icmp_in_errors"`
// Number of ICMP messages received
SnmpIcmpInMsgs float64 `json:"snmp_icmp_in_msgs"`
// Number of ICMP Parameter Problem messages received
SnmpIcmpInParmProbs float64 `json:"snmp_icmp_in_parm_probs"`
// Number of ICMP Redirect messages received
SnmpIcmpInRedirects float64 `json:"snmp_icmp_in_redirects"`
// Number of ICMP Source Quench messages received
SnmpIcmpInSrcQuenchs float64 `json:"snmp_icmp_in_src_quenchs"`
// Number of ICMP Time Exceeded messages received
SnmpIcmpInTimeExcds float64 `json:"snmp_icmp_in_time_excds"`
// Number of ICMP Address Mask Request messages received
SnmpIcmpInTimestampReps float64 `json:"snmp_icmp_in_timestamp_reps"`
// Number of ICMP Timestamp (request) messages received
SnmpIcmpInTimestamps float64 `json:"snmp_icmp_in_timestamps"`
// Number of ICMP Address Mask Reply messages sent
SnmpIcmpOutAddrMaskReps float64 `json:"snmp_icmp_out_addr_mask_reps"`
// Number of ICMP Address Mask Request messages sent
SnmpIcmpOutAddrMasks float64 `json:"snmp_icmp_out_addr_masks"`
// Number of ICMP Destination Unreachable messages sent
SnmpIcmpOutDestUnreachs float64 `json:"snmp_icmp_out_dest_unreachs"`
// Number of ICMP Echo Reply messages sent
SnmpIcmpOutEchoReps float64 `json:"snmp_icmp_out_echo_reps"`
// Number of ICMP Echo (request) messages sent
SnmpIcmpOutEchos float64 `json:"snmp_icmp_out_echos"`
// Number of ICMP messages which this entity did not send due to ICMP-specific
// errors
SnmpIcmpOutErrors float64 `json:"snmp_icmp_out_errors"`
// Number of ICMP messages attempted to send
SnmpIcmpOutMsgs float64 `json:"snmp_icmp_out_msgs"`
// Number of ICMP Parameter Problem messages sent
SnmpIcmpOutParmProbs float64 `json:"snmp_icmp_out_parm_probs"`
// Number of ICMP Redirect messages sent
SnmpIcmpOutRedirects float64 `json:"snmp_icmp_out_redirects"`
// Number of ICMP Source Quench messages sent
SnmpIcmpOutSrcQuenchs float64 `json:"snmp_icmp_out_src_quenchs"`
// Number of ICMP Time Exceeded messages sent
SnmpIcmpOutTimeExcds float64 `json:"snmp_icmp_out_time_excds"`
// Number of ICMP Timestamp Reply messages sent
SnmpIcmpOutTimestampReps float64 `json:"snmp_icmp_out_timestamp_reps"`
// Number of ICMP Timestamp (request) messages sent
SnmpIcmpOutTimestamps float64 `json:"snmp_icmp_out_timestamps"`
// Default value of the Time-To-Live field of the IP header
SnmpIPDefaultTTL float64 `json:"snmp_ip_default_ttl"`
// Number of datagrams forwarded to their final destination
SnmpIPForwDatagrams float64 `json:"snmp_ip_forw_datagrams"`
// Set when acting as an IP gateway
SnmpIPForwardingEnabled bool `json:"snmp_ip_forwarding_enabled"`
// Number of datagrams generated by fragmentation
SnmpIPFragCreates float64 `json:"snmp_ip_frag_creates"`
// Number of datagrams discarded because fragmentation failed
SnmpIPFragFails float64 `json:"snmp_ip_frag_fails"`
// Number of datagrams successfully fragmented
SnmpIPFragOks float64 `json:"snmp_ip_frag_oks"`
// Number of input datagrams discarded due to errors in the IP address
SnmpIPInAddrErrors float64 `json:"snmp_ip_in_addr_errors"`
// Number of input datagrams successfully delivered to IP user-protocols
SnmpIPInDelivers float64 `json:"snmp_ip_in_delivers"`
// Number of input datagrams otherwise discarded
SnmpIPInDiscards float64 `json:"snmp_ip_in_discards"`
// Number of input datagrams discarded due to errors in the IP header
SnmpIPInHdrErrors float64 `json:"snmp_ip_in_hdr_errors"`
// Number of input datagrams received from interfaces
SnmpIPInReceives float64 `json:"snmp_ip_in_receives"`
// Number of input datagrams discarded due unknown or unsupported protocol
SnmpIPInUnknownProtos float64 `json:"snmp_ip_in_unknown_protos"`
// Number of output datagrams otherwise discarded
SnmpIPOutDiscards float64 `json:"snmp_ip_out_discards"`
// Number of output datagrams discarded because no route matched
SnmpIPOutNoRoutes float64 `json:"snmp_ip_out_no_routes"`
// Number of datagrams supplied for transmission
SnmpIPOutRequests float64 `json:"snmp_ip_out_requests"`
// Number of failures detected by the reassembly algorithm
SnmpIPReasmFails float64 `json:"snmp_ip_reasm_fails"`
// Number of datagrams successfully reassembled
SnmpIPReasmOks float64 `json:"snmp_ip_reasm_oks"`
// Number of fragments received which needed to be reassembled
SnmpIPReasmReqds float64 `json:"snmp_ip_reasm_reqds"`
// Number of seconds fragments are held while awaiting reassembly
SnmpIPReasmTimeout float64 `json:"snmp_ip_reasm_timeout"`
// Number of times TCP transitions to SYN-SENT from CLOSED
SnmpTCPActiveOpens float64 `json:"snmp_tcp_active_opens"`
// Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus
// transitions to LISTEN from SYN-RCVD
SnmpTCPAttemptFails float64 `json:"snmp_tcp_attempt_fails"`
// Number of TCP connections in ESTABLISHED or CLOSE-WAIT
SnmpTCPCurrEstab float64 `json:"snmp_tcp_curr_estab"`
// Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT
SnmpTCPEstabResets float64 `json:"snmp_tcp_estab_resets"`
// Number of TCP segments received with checksum errors
SnmpTCPInCsumErrors float64 `json:"snmp_tcp_in_csum_errors"`
// Number of TCP segments received in error
SnmpTCPInErrs float64 `json:"snmp_tcp_in_errs"`
// Number of TCP segments received
SnmpTCPInSegs float64 `json:"snmp_tcp_in_segs"`
// Limit on the total number of TCP connections
SnmpTCPMaxConn float64 `json:"snmp_tcp_max_conn"`
// Number of TCP segments sent with RST flag
SnmpTCPOutRsts float64 `json:"snmp_tcp_out_rsts"`
// Number of TCP segments sent
SnmpTCPOutSegs float64 `json:"snmp_tcp_out_segs"`
// Number of times TCP transitions to SYN-RCVD from LISTEN
SnmpTCPPassiveOpens float64 `json:"snmp_tcp_passive_opens"`
// Number of TCP segments retransmitted
SnmpTCPRetransSegs float64 `json:"snmp_tcp_retrans_segs"`
// Maximum value permitted by a TCP implementation for the retransmission timeout
// (milliseconds)
SnmpTCPRtoMax float64 `json:"snmp_tcp_rto_max"`
// Minimum value permitted by a TCP implementation for the retransmission timeout
// (milliseconds)
SnmpTCPRtoMin float64 `json:"snmp_tcp_rto_min"`
// Number of UDP datagrams delivered to UDP applications
SnmpUdpInDatagrams float64 `json:"snmp_udp_in_datagrams"`
// Number of UDP datagrams failed to be delivered for reasons other than lack of
// application at the destination port
SnmpUdpInErrors float64 `json:"snmp_udp_in_errors"`
// Number of UDP datagrams received for which there was not application at the
// destination port
SnmpUdpNoPorts float64 `json:"snmp_udp_no_ports"`
// Number of UDP datagrams sent
SnmpUdpOutDatagrams float64 `json:"snmp_udp_out_datagrams"`
// Boottime of the system (seconds since the Unix epoch)
SystemBootTimeS float64 `json:"system_boot_time_s"`
Thermals []ConnectorSnapshotLatestListResponseItemsThermal `json:"thermals"`
Tunnels []ConnectorSnapshotLatestListResponseItemsTunnel `json:"tunnels"`
// Sum of how much time each core has spent idle
UptimeIdleMs float64 `json:"uptime_idle_ms"`
// Uptime of the system, including time spent in suspend
UptimeTotalMs float64 `json:"uptime_total_ms"`
JSON connectorSnapshotLatestListResponseItemJSON `json:"-"`
}
Snapshot
func (*ConnectorSnapshotLatestListResponseItem) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItem) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsDHCPLease ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsDHCPLease struct {
// Client ID of the device the IP Address was leased to
ClientID string `json:"client_id,required"`
// Expiry time of the DHCP lease (seconds since the Unix epoch)
ExpiryTime float64 `json:"expiry_time,required"`
// Hostname of the device the IP Address was leased to
Hostname string `json:"hostname,required"`
// Name of the network interface
InterfaceName string `json:"interface_name,required"`
// IP Address that was leased
IPAddress string `json:"ip_address,required"`
// MAC Address of the device the IP Address was leased to
MacAddress string `json:"mac_address,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotLatestListResponseItemsDHCPLeaseJSON `json:"-"`
}
Snapshot DHCP lease
func (*ConnectorSnapshotLatestListResponseItemsDHCPLease) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsDHCPLease) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsDisk ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsDisk struct {
// I/Os currently in progress
InProgress float64 `json:"in_progress,required"`
// Device major number
Major float64 `json:"major,required"`
// Reads merged
Merged float64 `json:"merged,required"`
// Device minor number
Minor float64 `json:"minor,required"`
// Device name
Name string `json:"name,required"`
// Reads completed successfully
Reads float64 `json:"reads,required"`
// Sectors read successfully
SectorsRead float64 `json:"sectors_read,required"`
// Sectors written successfully
SectorsWritten float64 `json:"sectors_written,required"`
// Time spent doing I/Os (milliseconds)
TimeInProgressMs float64 `json:"time_in_progress_ms,required"`
// Time spent reading (milliseconds)
TimeReadingMs float64 `json:"time_reading_ms,required"`
// Time spent writing (milliseconds)
TimeWritingMs float64 `json:"time_writing_ms,required"`
// Weighted time spent doing I/Os (milliseconds)
WeightedTimeInProgressMs float64 `json:"weighted_time_in_progress_ms,required"`
// Writes completed
Writes float64 `json:"writes,required"`
// Writes merged
WritesMerged float64 `json:"writes_merged,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Discards completed successfully
Discards float64 `json:"discards"`
// Discards merged
DiscardsMerged float64 `json:"discards_merged"`
// Flushes completed successfully
Flushes float64 `json:"flushes"`
// Sectors discarded
SectorsDiscarded float64 `json:"sectors_discarded"`
// Time spent discarding (milliseconds)
TimeDiscardingMs float64 `json:"time_discarding_ms"`
// Time spent flushing (milliseconds)
TimeFlushingMs float64 `json:"time_flushing_ms"`
JSON connectorSnapshotLatestListResponseItemsDiskJSON `json:"-"`
}
Snapshot Disk
func (*ConnectorSnapshotLatestListResponseItemsDisk) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsDisk) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsInterface ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsInterface struct {
// Name of the network interface
Name string `json:"name,required"`
// UP/DOWN state of the network interface
Operstate string `json:"operstate,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
IPAddresses []ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress `json:"ip_addresses"`
// Speed of the network interface (bits per second)
Speed float64 `json:"speed"`
JSON connectorSnapshotLatestListResponseItemsInterfaceJSON `json:"-"`
}
Snapshot Interface
func (*ConnectorSnapshotLatestListResponseItemsInterface) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsInterface) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress struct {
// Name of the network interface
InterfaceName string `json:"interface_name,required"`
// IP address of the network interface
IPAddress string `json:"ip_address,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotLatestListResponseItemsInterfacesIPAddressJSON `json:"-"`
}
Snapshot Interface Address
func (*ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsMount ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsMount struct {
// File system on disk (EXT4, NTFS, etc.)
FileSystem string `json:"file_system,required"`
// Kind of disk (HDD, SSD, etc.)
Kind string `json:"kind,required"`
// Path where disk is mounted
MountPoint string `json:"mount_point,required"`
// Name of the disk mount
Name string `json:"name,required"`
// Available disk size (bytes)
AvailableBytes float64 `json:"available_bytes"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Determines whether the disk is read-only
IsReadOnly bool `json:"is_read_only"`
// Determines whether the disk is removable
IsRemovable bool `json:"is_removable"`
// Total disk size (bytes)
TotalBytes float64 `json:"total_bytes"`
JSON connectorSnapshotLatestListResponseItemsMountJSON `json:"-"`
}
Snapshot Mount
func (*ConnectorSnapshotLatestListResponseItemsMount) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsMount) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsNetdev ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsNetdev struct {
// Name of the network device
Name string `json:"name,required"`
// Total bytes received
RecvBytes float64 `json:"recv_bytes,required"`
// Compressed packets received
RecvCompressed float64 `json:"recv_compressed,required"`
// Packets dropped
RecvDrop float64 `json:"recv_drop,required"`
// Bad packets received
RecvErrs float64 `json:"recv_errs,required"`
// FIFO overruns
RecvFifo float64 `json:"recv_fifo,required"`
// Frame alignment errors
RecvFrame float64 `json:"recv_frame,required"`
// Multicast packets received
RecvMulticast float64 `json:"recv_multicast,required"`
// Total packets received
RecvPackets float64 `json:"recv_packets,required"`
// Total bytes transmitted
SentBytes float64 `json:"sent_bytes,required"`
// Number of packets not sent due to carrier errors
SentCarrier float64 `json:"sent_carrier,required"`
// Number of collisions
SentColls float64 `json:"sent_colls,required"`
// Number of compressed packets transmitted
SentCompressed float64 `json:"sent_compressed,required"`
// Number of packets dropped during transmission
SentDrop float64 `json:"sent_drop,required"`
// Number of transmission errors
SentErrs float64 `json:"sent_errs,required"`
// FIFO overruns
SentFifo float64 `json:"sent_fifo,required"`
// Total packets transmitted
SentPackets float64 `json:"sent_packets,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotLatestListResponseItemsNetdevJSON `json:"-"`
}
Snapshot Netdev
func (*ConnectorSnapshotLatestListResponseItemsNetdev) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsNetdev) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsThermal ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsThermal struct {
// Sensor identifier for the component
Label string `json:"label,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
// Critical failure temperature of the component (degrees Celsius)
CriticalCelcius float64 `json:"critical_celcius"`
// Current temperature of the component (degrees Celsius)
CurrentCelcius float64 `json:"current_celcius"`
// Maximum temperature of the component (degrees Celsius)
MaxCelcius float64 `json:"max_celcius"`
JSON connectorSnapshotLatestListResponseItemsThermalJSON `json:"-"`
}
Snapshot Thermal
func (*ConnectorSnapshotLatestListResponseItemsThermal) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsThermal) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestListResponseItemsTunnel ¶ added in v4.4.0
type ConnectorSnapshotLatestListResponseItemsTunnel struct {
// Name of tunnel health state (unknown, healthy, degraded, down)
HealthState string `json:"health_state,required"`
// Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 =
// degraded, 3 = down)
HealthValue float64 `json:"health_value,required"`
// The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.)
InterfaceName string `json:"interface_name,required"`
// Tunnel identifier
TunnelID string `json:"tunnel_id,required"`
// Connector identifier
ConnectorID string `json:"connector_id"`
JSON connectorSnapshotLatestListResponseItemsTunnelJSON `json:"-"`
}
Snapshot Tunnels
func (*ConnectorSnapshotLatestListResponseItemsTunnel) UnmarshalJSON ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestListResponseItemsTunnel) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotLatestService ¶ added in v4.4.0
type ConnectorSnapshotLatestService struct {
Options []option.RequestOption
}
ConnectorSnapshotLatestService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewConnectorSnapshotLatestService method instead.
func NewConnectorSnapshotLatestService ¶ added in v4.4.0
func NewConnectorSnapshotLatestService(opts ...option.RequestOption) (r *ConnectorSnapshotLatestService)
NewConnectorSnapshotLatestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ConnectorSnapshotLatestService) List ¶ added in v4.4.0
func (r *ConnectorSnapshotLatestService) List(ctx context.Context, connectorID string, query ConnectorSnapshotLatestListParams, opts ...option.RequestOption) (res *ConnectorSnapshotLatestListResponse, err error)
Get latest Snapshots
type ConnectorSnapshotListParams ¶ added in v4.2.0
type ConnectorSnapshotListParams struct {
AccountID param.Field[float64] `path:"account_id,required"`
From param.Field[float64] `query:"from,required"`
To param.Field[float64] `query:"to,required"`
Cursor param.Field[string] `query:"cursor"`
Limit param.Field[float64] `query:"limit"`
}
func (ConnectorSnapshotListParams) URLQuery ¶ added in v4.2.0
func (r ConnectorSnapshotListParams) URLQuery() (v url.Values)
URLQuery serializes ConnectorSnapshotListParams's query parameters as `url.Values`.
type ConnectorSnapshotListResponse ¶ added in v4.2.0
type ConnectorSnapshotListResponse struct {
Count float64 `json:"count,required"`
Items []ConnectorSnapshotListResponseItem `json:"items,required"`
Cursor string `json:"cursor"`
JSON connectorSnapshotListResponseJSON `json:"-"`
}
func (*ConnectorSnapshotListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotListResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotListResponseEnvelope ¶ added in v4.2.0
type ConnectorSnapshotListResponseEnvelope struct {
Result ConnectorSnapshotListResponse `json:"result,required"`
Success bool `json:"success,required"`
Errors []ConnectorSnapshotListResponseEnvelopeErrors `json:"errors"`
Messages []ConnectorSnapshotListResponseEnvelopeMessages `json:"messages"`
JSON connectorSnapshotListResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorSnapshotListResponseEnvelope) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotListResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorSnapshotListResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorSnapshotListResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotListResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorSnapshotListResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorSnapshotListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorSnapshotListResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotListResponseItem ¶ added in v4.2.0
type ConnectorSnapshotListResponseItem struct {
// Time the Snapshot was collected (seconds since the Unix epoch)
A float64 `json:"a,required"`
// Time the Snapshot was recorded (seconds since the Unix epoch)
T float64 `json:"t,required"`
JSON connectorSnapshotListResponseItemJSON `json:"-"`
}
func (*ConnectorSnapshotListResponseItem) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorSnapshotListResponseItem) UnmarshalJSON(data []byte) (err error)
type ConnectorSnapshotService ¶ added in v4.2.0
type ConnectorSnapshotService struct {
Options []option.RequestOption
Latest *ConnectorSnapshotLatestService
}
ConnectorSnapshotService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewConnectorSnapshotService method instead.
func NewConnectorSnapshotService ¶ added in v4.2.0
func NewConnectorSnapshotService(opts ...option.RequestOption) (r *ConnectorSnapshotService)
NewConnectorSnapshotService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ConnectorSnapshotService) Get ¶ added in v4.2.0
func (r *ConnectorSnapshotService) Get(ctx context.Context, connectorID string, snapshotT float64, query ConnectorSnapshotGetParams, opts ...option.RequestOption) (res *ConnectorSnapshotGetResponse, err error)
Get Snapshot
func (*ConnectorSnapshotService) List ¶ added in v4.2.0
func (r *ConnectorSnapshotService) List(ctx context.Context, connectorID string, params ConnectorSnapshotListParams, opts ...option.RequestOption) (res *ConnectorSnapshotListResponse, err error)
List Snapshots
type ConnectorUpdateParams ¶
type ConnectorUpdateParams struct {
AccountID param.Field[string] `path:"account_id,required"`
Activated param.Field[bool] `json:"activated"`
InterruptWindowDurationHours param.Field[float64] `json:"interrupt_window_duration_hours"`
InterruptWindowHourOfDay param.Field[float64] `json:"interrupt_window_hour_of_day"`
Notes param.Field[string] `json:"notes"`
Timezone param.Field[string] `json:"timezone"`
}
func (ConnectorUpdateParams) MarshalJSON ¶
func (r ConnectorUpdateParams) MarshalJSON() (data []byte, err error)
type ConnectorUpdateResponse ¶
type ConnectorUpdateResponse struct {
ID string `json:"id,required"`
Activated bool `json:"activated,required"`
InterruptWindowDurationHours float64 `json:"interrupt_window_duration_hours,required"`
InterruptWindowHourOfDay float64 `json:"interrupt_window_hour_of_day,required"`
LastUpdated string `json:"last_updated,required"`
Notes string `json:"notes,required"`
Timezone string `json:"timezone,required"`
Device ConnectorUpdateResponseDevice `json:"device"`
LastHeartbeat string `json:"last_heartbeat"`
LastSeenVersion string `json:"last_seen_version"`
JSON connectorUpdateResponseJSON `json:"-"`
}
func (*ConnectorUpdateResponse) UnmarshalJSON ¶
func (r *ConnectorUpdateResponse) UnmarshalJSON(data []byte) (err error)
type ConnectorUpdateResponseDevice ¶
type ConnectorUpdateResponseDevice struct {
ID string `json:"id,required"`
SerialNumber string `json:"serial_number"`
JSON connectorUpdateResponseDeviceJSON `json:"-"`
}
func (*ConnectorUpdateResponseDevice) UnmarshalJSON ¶
func (r *ConnectorUpdateResponseDevice) UnmarshalJSON(data []byte) (err error)
type ConnectorUpdateResponseEnvelope ¶
type ConnectorUpdateResponseEnvelope struct {
Errors []ConnectorUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []ConnectorUpdateResponseEnvelopeMessages `json:"messages,required"`
Result ConnectorUpdateResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON connectorUpdateResponseEnvelopeJSON `json:"-"`
}
func (*ConnectorUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *ConnectorUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ConnectorUpdateResponseEnvelopeErrors ¶ added in v4.2.0
type ConnectorUpdateResponseEnvelopeErrors struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ConnectorUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ConnectorUpdateResponseEnvelopeMessages ¶ added in v4.2.0
type ConnectorUpdateResponseEnvelopeMessages struct {
Code float64 `json:"code,required"`
Message string `json:"message,required"`
JSON connectorUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ConnectorUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.2.0
func (r *ConnectorUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DHCPRelay ¶
type DHCPRelay struct {
// List of DHCP server IPs.
ServerAddresses []string `json:"server_addresses"`
JSON dhcpRelayJSON `json:"-"`
}
func (*DHCPRelay) UnmarshalJSON ¶
type DHCPRelayParam ¶
type DHCPRelayParam struct {
// List of DHCP server IPs.
ServerAddresses param.Field[[]string] `json:"server_addresses"`
}
func (DHCPRelayParam) MarshalJSON ¶
func (r DHCPRelayParam) MarshalJSON() (data []byte, err error)
type DHCPServer ¶
type DHCPServer struct {
// A valid IPv4 address.
DHCPPoolEnd string `json:"dhcp_pool_end"`
// A valid IPv4 address.
DHCPPoolStart string `json:"dhcp_pool_start"`
// A valid IPv4 address.
DNSServer string `json:"dns_server"`
DNSServers []string `json:"dns_servers"`
// Mapping of MAC addresses to IP addresses
Reservations map[string]string `json:"reservations"`
JSON dhcpServerJSON `json:"-"`
}
func (*DHCPServer) UnmarshalJSON ¶
func (r *DHCPServer) UnmarshalJSON(data []byte) (err error)
type DHCPServerParam ¶
type DHCPServerParam struct {
// A valid IPv4 address.
DHCPPoolEnd param.Field[string] `json:"dhcp_pool_end"`
// A valid IPv4 address.
DHCPPoolStart param.Field[string] `json:"dhcp_pool_start"`
// A valid IPv4 address.
DNSServer param.Field[string] `json:"dns_server"`
DNSServers param.Field[[]string] `json:"dns_servers"`
// Mapping of MAC addresses to IP addresses
Reservations param.Field[map[string]string] `json:"reservations"`
}
func (DHCPServerParam) MarshalJSON ¶
func (r DHCPServerParam) MarshalJSON() (data []byte, err error)
type ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type GRETunnelBulkUpdateParams ¶
type GRETunnelBulkUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body interface{} `json:"body,required"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (GRETunnelBulkUpdateParams) MarshalJSON ¶
func (r GRETunnelBulkUpdateParams) MarshalJSON() (data []byte, err error)
type GRETunnelBulkUpdateResponse ¶
type GRETunnelBulkUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedGRETunnels []GRETunnelBulkUpdateResponseModifiedGRETunnel `json:"modified_gre_tunnels"`
JSON greTunnelBulkUpdateResponseJSON `json:"-"`
}
func (*GRETunnelBulkUpdateResponse) UnmarshalJSON ¶
func (r *GRETunnelBulkUpdateResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelBulkUpdateResponseEnvelope ¶
type GRETunnelBulkUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelBulkUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelBulkUpdateResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelBulkUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelBulkUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelBulkUpdateResponseEnvelopeSuccess ¶
type GRETunnelBulkUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelBulkUpdateResponseEnvelopeSuccessTrue GRETunnelBulkUpdateResponseEnvelopeSuccess = true
)
func (GRETunnelBulkUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelBulkUpdateResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelBulkUpdateResponseModifiedGRETunnel ¶
type GRETunnelBulkUpdateResponseModifiedGRETunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelBulkUpdateResponseModifiedGRETunnelJSON `json:"-"`
}
func (*GRETunnelBulkUpdateResponseModifiedGRETunnel) UnmarshalJSON ¶
func (r *GRETunnelBulkUpdateResponseModifiedGRETunnel) UnmarshalJSON(data []byte) (err error)
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck ¶
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckJSON `json:"-"`
}
func (*GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck) UnmarshalJSON ¶
func (r *GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection ¶
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirectionUnidirectional GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection = "unidirectional" GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirectionBidirectional GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection = "bidirectional" )
func (GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection) IsKnown ¶
func (r GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection) IsKnown() bool
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion()
func (*GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion ¶
type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion interface {
ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type GRETunnelDeleteParams ¶
type GRETunnelDeleteResponse ¶
type GRETunnelDeleteResponse struct {
Deleted bool `json:"deleted"`
DeletedGRETunnel GRETunnelDeleteResponseDeletedGRETunnel `json:"deleted_gre_tunnel"`
JSON greTunnelDeleteResponseJSON `json:"-"`
}
func (*GRETunnelDeleteResponse) UnmarshalJSON ¶
func (r *GRETunnelDeleteResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelDeleteResponseDeletedGRETunnel ¶
type GRETunnelDeleteResponseDeletedGRETunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelDeleteResponseDeletedGRETunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelDeleteResponseDeletedGRETunnelJSON `json:"-"`
}
func (*GRETunnelDeleteResponseDeletedGRETunnel) UnmarshalJSON ¶
func (r *GRETunnelDeleteResponseDeletedGRETunnel) UnmarshalJSON(data []byte) (err error)
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheck ¶
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelDeleteResponseDeletedGRETunnelHealthCheckJSON `json:"-"`
}
func (*GRETunnelDeleteResponseDeletedGRETunnelHealthCheck) UnmarshalJSON ¶
func (r *GRETunnelDeleteResponseDeletedGRETunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection ¶
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirectionUnidirectional GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection = "unidirectional" GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirectionBidirectional GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection = "bidirectional" )
func (GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection) IsKnown ¶
func (r GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection) IsKnown() bool
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion()
func (*GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion ¶
type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion interface {
ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type GRETunnelDeleteResponseEnvelope ¶
type GRETunnelDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelDeleteResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelDeleteResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelDeleteResponseEnvelopeSuccess ¶
type GRETunnelDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelDeleteResponseEnvelopeSuccessTrue GRETunnelDeleteResponseEnvelopeSuccess = true
)
func (GRETunnelDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelDeleteResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelGetParams ¶
type GRETunnelGetResponse ¶
type GRETunnelGetResponse struct {
GRETunnel GRETunnelGetResponseGRETunnel `json:"gre_tunnel"`
JSON greTunnelGetResponseJSON `json:"-"`
}
func (*GRETunnelGetResponse) UnmarshalJSON ¶
func (r *GRETunnelGetResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelGetResponseEnvelope ¶
type GRETunnelGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelGetResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelGetResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelGetResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelGetResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelGetResponseEnvelopeSuccess ¶
type GRETunnelGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelGetResponseEnvelopeSuccessTrue GRETunnelGetResponseEnvelopeSuccess = true
)
func (GRETunnelGetResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelGetResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelGetResponseGRETunnel ¶
type GRETunnelGetResponseGRETunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelGetResponseGRETunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelGetResponseGRETunnelJSON `json:"-"`
}
func (*GRETunnelGetResponseGRETunnel) UnmarshalJSON ¶
func (r *GRETunnelGetResponseGRETunnel) UnmarshalJSON(data []byte) (err error)
type GRETunnelGetResponseGRETunnelHealthCheck ¶
type GRETunnelGetResponseGRETunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelGetResponseGRETunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelGetResponseGRETunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelGetResponseGRETunnelHealthCheckJSON `json:"-"`
}
func (*GRETunnelGetResponseGRETunnelHealthCheck) UnmarshalJSON ¶
func (r *GRETunnelGetResponseGRETunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelGetResponseGRETunnelHealthCheckDirection ¶
type GRETunnelGetResponseGRETunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelGetResponseGRETunnelHealthCheckDirectionUnidirectional GRETunnelGetResponseGRETunnelHealthCheckDirection = "unidirectional" GRETunnelGetResponseGRETunnelHealthCheckDirectionBidirectional GRETunnelGetResponseGRETunnelHealthCheckDirection = "bidirectional" )
func (GRETunnelGetResponseGRETunnelHealthCheckDirection) IsKnown ¶
func (r GRETunnelGetResponseGRETunnelHealthCheckDirection) IsKnown() bool
type GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion()
func (*GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelGetResponseGRETunnelHealthCheckTargetUnion ¶
type GRETunnelGetResponseGRETunnelHealthCheckTargetUnion interface {
ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type GRETunnelListParams ¶
type GRETunnelListResponse ¶
type GRETunnelListResponse struct {
GRETunnels []GRETunnelListResponseGRETunnel `json:"gre_tunnels"`
JSON greTunnelListResponseJSON `json:"-"`
}
func (*GRETunnelListResponse) UnmarshalJSON ¶
func (r *GRETunnelListResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelListResponseEnvelope ¶
type GRETunnelListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelListResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelListResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelListResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelListResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelListResponseEnvelopeSuccess ¶
type GRETunnelListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelListResponseEnvelopeSuccessTrue GRETunnelListResponseEnvelopeSuccess = true
)
func (GRETunnelListResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelListResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelListResponseGRETunnel ¶
type GRETunnelListResponseGRETunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelListResponseGRETunnelsHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelListResponseGRETunnelJSON `json:"-"`
}
func (*GRETunnelListResponseGRETunnel) UnmarshalJSON ¶
func (r *GRETunnelListResponseGRETunnel) UnmarshalJSON(data []byte) (err error)
type GRETunnelListResponseGRETunnelsHealthCheck ¶
type GRETunnelListResponseGRETunnelsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelListResponseGRETunnelsHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelListResponseGRETunnelsHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelListResponseGRETunnelsHealthCheckJSON `json:"-"`
}
func (*GRETunnelListResponseGRETunnelsHealthCheck) UnmarshalJSON ¶
func (r *GRETunnelListResponseGRETunnelsHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelListResponseGRETunnelsHealthCheckDirection ¶
type GRETunnelListResponseGRETunnelsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelListResponseGRETunnelsHealthCheckDirectionUnidirectional GRETunnelListResponseGRETunnelsHealthCheckDirection = "unidirectional" GRETunnelListResponseGRETunnelsHealthCheckDirectionBidirectional GRETunnelListResponseGRETunnelsHealthCheckDirection = "bidirectional" )
func (GRETunnelListResponseGRETunnelsHealthCheckDirection) IsKnown ¶
func (r GRETunnelListResponseGRETunnelsHealthCheckDirection) IsKnown() bool
type GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion()
func (*GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelListResponseGRETunnelsHealthCheckTargetUnion ¶
type GRETunnelListResponseGRETunnelsHealthCheckTargetUnion interface {
ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type GRETunnelNewParams ¶
type GRETunnelNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint param.Field[string] `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint param.Field[string] `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress param.Field[string] `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name param.Field[string] `json:"name,required"`
// An optional description of the GRE tunnel.
Description param.Field[string] `json:"description"`
HealthCheck param.Field[GRETunnelNewParamsHealthCheck] `json:"health_check"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu param.Field[int64] `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL param.Field[int64] `json:"ttl"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (GRETunnelNewParams) MarshalJSON ¶
func (r GRETunnelNewParams) MarshalJSON() (data []byte, err error)
type GRETunnelNewParamsHealthCheck ¶ added in v4.3.0
type GRETunnelNewParamsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction param.Field[GRETunnelNewParamsHealthCheckDirection] `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled param.Field[bool] `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate param.Field[HealthCheckRate] `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target param.Field[GRETunnelNewParamsHealthCheckTargetUnion] `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type param.Field[HealthCheckType] `json:"type"`
}
func (GRETunnelNewParamsHealthCheck) MarshalJSON ¶ added in v4.3.0
func (r GRETunnelNewParamsHealthCheck) MarshalJSON() (data []byte, err error)
type GRETunnelNewParamsHealthCheckDirection ¶ added in v4.3.0
type GRETunnelNewParamsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelNewParamsHealthCheckDirectionUnidirectional GRETunnelNewParamsHealthCheckDirection = "unidirectional" GRETunnelNewParamsHealthCheckDirectionBidirectional GRETunnelNewParamsHealthCheckDirection = "bidirectional" )
func (GRETunnelNewParamsHealthCheckDirection) IsKnown ¶ added in v4.3.0
func (r GRETunnelNewParamsHealthCheckDirection) IsKnown() bool
type GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget ¶ added in v4.3.0
type GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget struct {
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved param.Field[string] `json:"saved"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewParamsHealthCheckTargetUnion ¶ added in v4.3.0
func (r GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewParamsHealthCheckTargetUnion()
func (GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON ¶ added in v4.3.0
func (r GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON() (data []byte, err error)
type GRETunnelNewParamsHealthCheckTargetUnion ¶ added in v4.3.0
type GRETunnelNewParamsHealthCheckTargetUnion interface {
ImplementsGRETunnelNewParamsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Satisfied by magic_transit.GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget, shared.UnionString.
type GRETunnelNewResponse ¶
type GRETunnelNewResponse struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelNewResponseHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelNewResponseJSON `json:"-"`
}
func (*GRETunnelNewResponse) UnmarshalJSON ¶
func (r *GRETunnelNewResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelNewResponseEnvelope ¶
type GRETunnelNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelNewResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelNewResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelNewResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelNewResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelNewResponseEnvelopeSuccess ¶
type GRETunnelNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelNewResponseEnvelopeSuccessTrue GRETunnelNewResponseEnvelopeSuccess = true
)
func (GRETunnelNewResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelNewResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelNewResponseHealthCheck ¶ added in v4.3.0
type GRETunnelNewResponseHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelNewResponseHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelNewResponseHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelNewResponseHealthCheckJSON `json:"-"`
}
func (*GRETunnelNewResponseHealthCheck) UnmarshalJSON ¶ added in v4.3.0
func (r *GRETunnelNewResponseHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelNewResponseHealthCheckDirection ¶ added in v4.3.0
type GRETunnelNewResponseHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelNewResponseHealthCheckDirectionUnidirectional GRETunnelNewResponseHealthCheckDirection = "unidirectional" GRETunnelNewResponseHealthCheckDirectionBidirectional GRETunnelNewResponseHealthCheckDirection = "bidirectional" )
func (GRETunnelNewResponseHealthCheckDirection) IsKnown ¶ added in v4.3.0
func (r GRETunnelNewResponseHealthCheckDirection) IsKnown() bool
type GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget ¶ added in v4.3.0
type GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelNewResponseHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewResponseHealthCheckTargetUnion ¶ added in v4.3.0
func (r GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewResponseHealthCheckTargetUnion()
func (*GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶ added in v4.3.0
func (r *GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelNewResponseHealthCheckTargetUnion ¶ added in v4.3.0
type GRETunnelNewResponseHealthCheckTargetUnion interface {
ImplementsGRETunnelNewResponseHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type GRETunnelService ¶
type GRETunnelService struct {
Options []option.RequestOption
}
GRETunnelService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewGRETunnelService method instead.
func NewGRETunnelService ¶
func NewGRETunnelService(opts ...option.RequestOption) (r *GRETunnelService)
NewGRETunnelService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*GRETunnelService) BulkUpdate ¶
func (r *GRETunnelService) BulkUpdate(ctx context.Context, params GRETunnelBulkUpdateParams, opts ...option.RequestOption) (res *GRETunnelBulkUpdateResponse, err error)
Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*GRETunnelService) Delete ¶
func (r *GRETunnelService) Delete(ctx context.Context, greTunnelID string, params GRETunnelDeleteParams, opts ...option.RequestOption) (res *GRETunnelDeleteResponse, err error)
Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*GRETunnelService) Get ¶
func (r *GRETunnelService) Get(ctx context.Context, greTunnelID string, params GRETunnelGetParams, opts ...option.RequestOption) (res *GRETunnelGetResponse, err error)
Lists informtion for a specific GRE tunnel.
func (*GRETunnelService) List ¶
func (r *GRETunnelService) List(ctx context.Context, params GRETunnelListParams, opts ...option.RequestOption) (res *GRETunnelListResponse, err error)
Lists GRE tunnels associated with an account.
func (*GRETunnelService) New ¶
func (r *GRETunnelService) New(ctx context.Context, params GRETunnelNewParams, opts ...option.RequestOption) (res *GRETunnelNewResponse, err error)
Creates a new GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*GRETunnelService) Update ¶
func (r *GRETunnelService) Update(ctx context.Context, greTunnelID string, params GRETunnelUpdateParams, opts ...option.RequestOption) (res *GRETunnelUpdateResponse, err error)
Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
type GRETunnelUpdateParams ¶
type GRETunnelUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint param.Field[string] `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint param.Field[string] `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress param.Field[string] `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name param.Field[string] `json:"name,required"`
// An optional description of the GRE tunnel.
Description param.Field[string] `json:"description"`
HealthCheck param.Field[GRETunnelUpdateParamsHealthCheck] `json:"health_check"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu param.Field[int64] `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL param.Field[int64] `json:"ttl"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (GRETunnelUpdateParams) MarshalJSON ¶
func (r GRETunnelUpdateParams) MarshalJSON() (data []byte, err error)
type GRETunnelUpdateParamsHealthCheck ¶
type GRETunnelUpdateParamsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction param.Field[GRETunnelUpdateParamsHealthCheckDirection] `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled param.Field[bool] `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate param.Field[HealthCheckRate] `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target param.Field[GRETunnelUpdateParamsHealthCheckTargetUnion] `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type param.Field[HealthCheckType] `json:"type"`
}
func (GRETunnelUpdateParamsHealthCheck) MarshalJSON ¶
func (r GRETunnelUpdateParamsHealthCheck) MarshalJSON() (data []byte, err error)
type GRETunnelUpdateParamsHealthCheckDirection ¶
type GRETunnelUpdateParamsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelUpdateParamsHealthCheckDirectionUnidirectional GRETunnelUpdateParamsHealthCheckDirection = "unidirectional" GRETunnelUpdateParamsHealthCheckDirectionBidirectional GRETunnelUpdateParamsHealthCheckDirection = "bidirectional" )
func (GRETunnelUpdateParamsHealthCheckDirection) IsKnown ¶
func (r GRETunnelUpdateParamsHealthCheckDirection) IsKnown() bool
type GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget struct {
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved param.Field[string] `json:"saved"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion()
func (GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON ¶
func (r GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON() (data []byte, err error)
type GRETunnelUpdateParamsHealthCheckTargetUnion ¶
type GRETunnelUpdateParamsHealthCheckTargetUnion interface {
ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Satisfied by magic_transit.GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget, shared.UnionString.
type GRETunnelUpdateResponse ¶
type GRETunnelUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedGRETunnel GRETunnelUpdateResponseModifiedGRETunnel `json:"modified_gre_tunnel"`
JSON greTunnelUpdateResponseJSON `json:"-"`
}
func (*GRETunnelUpdateResponse) UnmarshalJSON ¶
func (r *GRETunnelUpdateResponse) UnmarshalJSON(data []byte) (err error)
type GRETunnelUpdateResponseEnvelope ¶
type GRETunnelUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result GRETunnelUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success GRETunnelUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON greTunnelUpdateResponseEnvelopeJSON `json:"-"`
}
func (*GRETunnelUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *GRETunnelUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type GRETunnelUpdateResponseEnvelopeSuccess ¶
type GRETunnelUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
GRETunnelUpdateResponseEnvelopeSuccessTrue GRETunnelUpdateResponseEnvelopeSuccess = true
)
func (GRETunnelUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r GRETunnelUpdateResponseEnvelopeSuccess) IsKnown() bool
type GRETunnelUpdateResponseModifiedGRETunnel ¶
type GRETunnelUpdateResponseModifiedGRETunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the GRE tunnel.
CloudflareGREEndpoint string `json:"cloudflare_gre_endpoint,required"`
// The IP address assigned to the customer side of the GRE tunnel.
CustomerGREEndpoint string `json:"customer_gre_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the tunnel. The name cannot contain spaces or special characters,
// must be 15 characters or less, and cannot share a name with another GRE tunnel.
Name string `json:"name,required"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional description of the GRE tunnel.
Description string `json:"description"`
HealthCheck GRETunnelUpdateResponseModifiedGRETunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
// is 576.
Mtu int64 `json:"mtu"`
// Time To Live (TTL) in number of hops of the GRE tunnel.
TTL int64 `json:"ttl"`
JSON greTunnelUpdateResponseModifiedGRETunnelJSON `json:"-"`
}
func (*GRETunnelUpdateResponseModifiedGRETunnel) UnmarshalJSON ¶
func (r *GRETunnelUpdateResponseModifiedGRETunnel) UnmarshalJSON(data []byte) (err error)
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheck ¶
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON greTunnelUpdateResponseModifiedGRETunnelHealthCheckJSON `json:"-"`
}
func (*GRETunnelUpdateResponseModifiedGRETunnelHealthCheck) UnmarshalJSON ¶
func (r *GRETunnelUpdateResponseModifiedGRETunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection ¶
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirectionUnidirectional GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection = "unidirectional" GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirectionBidirectional GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection = "bidirectional" )
func (GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection) IsKnown ¶
func (r GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection) IsKnown() bool
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON greTunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion()
func (*GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion ¶
type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion interface {
ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type HealthCheck ¶
type HealthCheck struct {
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target HealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON healthCheckJSON `json:"-"`
}
func (*HealthCheck) UnmarshalJSON ¶
func (r *HealthCheck) UnmarshalJSON(data []byte) (err error)
type HealthCheckParam ¶
type HealthCheckParam struct {
// Determines whether to run healthchecks for a tunnel.
Enabled param.Field[bool] `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate param.Field[HealthCheckRate] `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target param.Field[HealthCheckTargetUnionParam] `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type param.Field[HealthCheckType] `json:"type"`
}
func (HealthCheckParam) MarshalJSON ¶
func (r HealthCheckParam) MarshalJSON() (data []byte, err error)
type HealthCheckRate ¶
type HealthCheckRate string
How frequent the health check is run. The default value is `mid`.
const ( HealthCheckRateLow HealthCheckRate = "low" HealthCheckRateMid HealthCheckRate = "mid" HealthCheckRateHigh HealthCheckRate = "high" )
func (HealthCheckRate) IsKnown ¶
func (r HealthCheckRate) IsKnown() bool
type HealthCheckTargetMagicHealthCheckTarget ¶
type HealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON healthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (HealthCheckTargetMagicHealthCheckTarget) ImplementsHealthCheckTargetUnion ¶ added in v4.1.0
func (r HealthCheckTargetMagicHealthCheckTarget) ImplementsHealthCheckTargetUnion()
func (*HealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *HealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type HealthCheckTargetMagicHealthCheckTargetParam ¶
type HealthCheckTargetMagicHealthCheckTargetParam struct {
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved param.Field[string] `json:"saved"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (HealthCheckTargetMagicHealthCheckTargetParam) ImplementsHealthCheckTargetUnionParam ¶ added in v4.1.0
func (r HealthCheckTargetMagicHealthCheckTargetParam) ImplementsHealthCheckTargetUnionParam()
func (HealthCheckTargetMagicHealthCheckTargetParam) MarshalJSON ¶
func (r HealthCheckTargetMagicHealthCheckTargetParam) MarshalJSON() (data []byte, err error)
type HealthCheckTargetUnion ¶
type HealthCheckTargetUnion interface {
ImplementsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by HealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type HealthCheckTargetUnionParam ¶
type HealthCheckTargetUnionParam interface {
ImplementsHealthCheckTargetUnionParam()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Satisfied by magic_transit.HealthCheckTargetMagicHealthCheckTargetParam, shared.UnionString.
type HealthCheckType ¶
type HealthCheckType string
The type of healthcheck to run, reply or request. The default value is `reply`.
const ( HealthCheckTypeReply HealthCheckType = "reply" HealthCheckTypeRequest HealthCheckType = "request" )
func (HealthCheckType) IsKnown ¶
func (r HealthCheckType) IsKnown() bool
type IPSECTunnelBulkUpdateParams ¶
type IPSECTunnelBulkUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body interface{} `json:"body,required"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (IPSECTunnelBulkUpdateParams) MarshalJSON ¶
func (r IPSECTunnelBulkUpdateParams) MarshalJSON() (data []byte, err error)
type IPSECTunnelBulkUpdateResponse ¶
type IPSECTunnelBulkUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedIPSECTunnels []IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel `json:"modified_ipsec_tunnels"`
JSON ipsecTunnelBulkUpdateResponseJSON `json:"-"`
}
func (*IPSECTunnelBulkUpdateResponse) UnmarshalJSON ¶
func (r *IPSECTunnelBulkUpdateResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelBulkUpdateResponseEnvelope ¶
type IPSECTunnelBulkUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelBulkUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelBulkUpdateResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelBulkUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelBulkUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelBulkUpdateResponseEnvelopeSuccess ¶
type IPSECTunnelBulkUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelBulkUpdateResponseEnvelopeSuccessTrue IPSECTunnelBulkUpdateResponseEnvelopeSuccess = true
)
func (IPSECTunnelBulkUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelBulkUpdateResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel ¶
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelJSON `json:"-"`
}
func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel) UnmarshalJSON ¶
func (r *IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck ¶
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck) UnmarshalJSON ¶
func (r *IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection ¶
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionUnidirectional IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "unidirectional" IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionBidirectional IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "bidirectional" )
func (IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection) IsKnown() bool
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion()
func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion ¶
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion interface {
ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type IPSECTunnelDeleteParams ¶
type IPSECTunnelDeleteResponse ¶
type IPSECTunnelDeleteResponse struct {
Deleted bool `json:"deleted"`
DeletedIPSECTunnel IPSECTunnelDeleteResponseDeletedIPSECTunnel `json:"deleted_ipsec_tunnel"`
JSON ipsecTunnelDeleteResponseJSON `json:"-"`
}
func (*IPSECTunnelDeleteResponse) UnmarshalJSON ¶
func (r *IPSECTunnelDeleteResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelDeleteResponseDeletedIPSECTunnel ¶
type IPSECTunnelDeleteResponseDeletedIPSECTunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelDeleteResponseDeletedIPSECTunnelJSON `json:"-"`
}
func (*IPSECTunnelDeleteResponseDeletedIPSECTunnel) UnmarshalJSON ¶
func (r *IPSECTunnelDeleteResponseDeletedIPSECTunnel) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck ¶
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelDeleteResponseDeletedIPSECTunnelHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck) UnmarshalJSON ¶
func (r *IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection ¶
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirectionUnidirectional IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection = "unidirectional" IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirectionBidirectional IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection = "bidirectional" )
func (IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection) IsKnown() bool
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion()
func (*IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion ¶
type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion interface {
ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type IPSECTunnelDeleteResponseEnvelope ¶
type IPSECTunnelDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelDeleteResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelDeleteResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelDeleteResponseEnvelopeSuccess ¶
type IPSECTunnelDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelDeleteResponseEnvelopeSuccessTrue IPSECTunnelDeleteResponseEnvelopeSuccess = true
)
func (IPSECTunnelDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelDeleteResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelGetParams ¶
type IPSECTunnelGetResponse ¶
type IPSECTunnelGetResponse struct {
IPSECTunnel IPSECTunnelGetResponseIPSECTunnel `json:"ipsec_tunnel"`
JSON ipsecTunnelGetResponseJSON `json:"-"`
}
func (*IPSECTunnelGetResponse) UnmarshalJSON ¶
func (r *IPSECTunnelGetResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelGetResponseEnvelope ¶
type IPSECTunnelGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelGetResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelGetResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelGetResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelGetResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelGetResponseEnvelopeSuccess ¶
type IPSECTunnelGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelGetResponseEnvelopeSuccessTrue IPSECTunnelGetResponseEnvelopeSuccess = true
)
func (IPSECTunnelGetResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelGetResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelGetResponseIPSECTunnel ¶
type IPSECTunnelGetResponseIPSECTunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelGetResponseIPSECTunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelGetResponseIPSECTunnelJSON `json:"-"`
}
func (*IPSECTunnelGetResponseIPSECTunnel) UnmarshalJSON ¶
func (r *IPSECTunnelGetResponseIPSECTunnel) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelGetResponseIPSECTunnelHealthCheck ¶
type IPSECTunnelGetResponseIPSECTunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelGetResponseIPSECTunnelHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelGetResponseIPSECTunnelHealthCheck) UnmarshalJSON ¶
func (r *IPSECTunnelGetResponseIPSECTunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection ¶
type IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelGetResponseIPSECTunnelHealthCheckDirectionUnidirectional IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection = "unidirectional" IPSECTunnelGetResponseIPSECTunnelHealthCheckDirectionBidirectional IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection = "bidirectional" )
func (IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection) IsKnown() bool
type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion()
func (*IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion ¶
type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion interface {
ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type IPSECTunnelListParams ¶
type IPSECTunnelListResponse ¶
type IPSECTunnelListResponse struct {
IPSECTunnels []IPSECTunnelListResponseIPSECTunnel `json:"ipsec_tunnels"`
JSON ipsecTunnelListResponseJSON `json:"-"`
}
func (*IPSECTunnelListResponse) UnmarshalJSON ¶
func (r *IPSECTunnelListResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelListResponseEnvelope ¶
type IPSECTunnelListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelListResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelListResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelListResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelListResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelListResponseEnvelopeSuccess ¶
type IPSECTunnelListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelListResponseEnvelopeSuccessTrue IPSECTunnelListResponseEnvelopeSuccess = true
)
func (IPSECTunnelListResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelListResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelListResponseIPSECTunnel ¶
type IPSECTunnelListResponseIPSECTunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelListResponseIPSECTunnelsHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelListResponseIPSECTunnelJSON `json:"-"`
}
func (*IPSECTunnelListResponseIPSECTunnel) UnmarshalJSON ¶
func (r *IPSECTunnelListResponseIPSECTunnel) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelListResponseIPSECTunnelsHealthCheck ¶
type IPSECTunnelListResponseIPSECTunnelsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelListResponseIPSECTunnelsHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelListResponseIPSECTunnelsHealthCheck) UnmarshalJSON ¶
func (r *IPSECTunnelListResponseIPSECTunnelsHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection ¶
type IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelListResponseIPSECTunnelsHealthCheckDirectionUnidirectional IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection = "unidirectional" IPSECTunnelListResponseIPSECTunnelsHealthCheckDirectionBidirectional IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection = "bidirectional" )
func (IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection) IsKnown() bool
type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion()
func (*IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion ¶
type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion interface {
ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type IPSECTunnelNewParams ¶
type IPSECTunnelNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint param.Field[string] `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress param.Field[string] `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name param.Field[string] `json:"name,required"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint param.Field[string] `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description param.Field[string] `json:"description"`
HealthCheck param.Field[IPSECTunnelNewParamsHealthCheck] `json:"health_check"`
// A randomly generated or provided string for use in the IPsec tunnel.
PSK param.Field[string] `json:"psk"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection param.Field[bool] `json:"replay_protection"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (IPSECTunnelNewParams) MarshalJSON ¶
func (r IPSECTunnelNewParams) MarshalJSON() (data []byte, err error)
type IPSECTunnelNewParamsHealthCheck ¶
type IPSECTunnelNewParamsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction param.Field[IPSECTunnelNewParamsHealthCheckDirection] `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled param.Field[bool] `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate param.Field[HealthCheckRate] `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target param.Field[IPSECTunnelNewParamsHealthCheckTargetUnion] `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type param.Field[HealthCheckType] `json:"type"`
}
func (IPSECTunnelNewParamsHealthCheck) MarshalJSON ¶
func (r IPSECTunnelNewParamsHealthCheck) MarshalJSON() (data []byte, err error)
type IPSECTunnelNewParamsHealthCheckDirection ¶
type IPSECTunnelNewParamsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelNewParamsHealthCheckDirectionUnidirectional IPSECTunnelNewParamsHealthCheckDirection = "unidirectional" IPSECTunnelNewParamsHealthCheckDirectionBidirectional IPSECTunnelNewParamsHealthCheckDirection = "bidirectional" )
func (IPSECTunnelNewParamsHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelNewParamsHealthCheckDirection) IsKnown() bool
type IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget struct {
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved param.Field[string] `json:"saved"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion()
func (IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON ¶
func (r IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON() (data []byte, err error)
type IPSECTunnelNewParamsHealthCheckTargetUnion ¶
type IPSECTunnelNewParamsHealthCheckTargetUnion interface {
ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Satisfied by magic_transit.IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget, shared.UnionString.
type IPSECTunnelNewResponse ¶
type IPSECTunnelNewResponse struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelNewResponseHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelNewResponseJSON `json:"-"`
}
func (*IPSECTunnelNewResponse) UnmarshalJSON ¶
func (r *IPSECTunnelNewResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelNewResponseEnvelope ¶
type IPSECTunnelNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelNewResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelNewResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelNewResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelNewResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelNewResponseEnvelopeSuccess ¶
type IPSECTunnelNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelNewResponseEnvelopeSuccessTrue IPSECTunnelNewResponseEnvelopeSuccess = true
)
func (IPSECTunnelNewResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelNewResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelNewResponseHealthCheck ¶ added in v4.3.0
type IPSECTunnelNewResponseHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelNewResponseHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelNewResponseHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelNewResponseHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelNewResponseHealthCheck) UnmarshalJSON ¶ added in v4.3.0
func (r *IPSECTunnelNewResponseHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelNewResponseHealthCheckDirection ¶ added in v4.3.0
type IPSECTunnelNewResponseHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelNewResponseHealthCheckDirectionUnidirectional IPSECTunnelNewResponseHealthCheckDirection = "unidirectional" IPSECTunnelNewResponseHealthCheckDirectionBidirectional IPSECTunnelNewResponseHealthCheckDirection = "bidirectional" )
func (IPSECTunnelNewResponseHealthCheckDirection) IsKnown ¶ added in v4.3.0
func (r IPSECTunnelNewResponseHealthCheckDirection) IsKnown() bool
type IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget ¶ added in v4.3.0
type IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelNewResponseHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion ¶ added in v4.3.0
func (r IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion()
func (*IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶ added in v4.3.0
func (r *IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelNewResponseHealthCheckTargetUnion ¶ added in v4.3.0
type IPSECTunnelNewResponseHealthCheckTargetUnion interface {
ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type IPSECTunnelPSKGenerateParams ¶
type IPSECTunnelPSKGenerateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body interface{} `json:"body,required"`
}
func (IPSECTunnelPSKGenerateParams) MarshalJSON ¶
func (r IPSECTunnelPSKGenerateParams) MarshalJSON() (data []byte, err error)
type IPSECTunnelPSKGenerateResponse ¶
type IPSECTunnelPSKGenerateResponse struct {
// Identifier
IPSECTunnelID string `json:"ipsec_tunnel_id"`
// A randomly generated or provided string for use in the IPsec tunnel.
PSK string `json:"psk"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
JSON ipsecTunnelPSKGenerateResponseJSON `json:"-"`
}
func (*IPSECTunnelPSKGenerateResponse) UnmarshalJSON ¶
func (r *IPSECTunnelPSKGenerateResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelPSKGenerateResponseEnvelope ¶
type IPSECTunnelPSKGenerateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelPSKGenerateResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelPSKGenerateResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelPSKGenerateResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelPSKGenerateResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelPSKGenerateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelPSKGenerateResponseEnvelopeSuccess ¶
type IPSECTunnelPSKGenerateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelPSKGenerateResponseEnvelopeSuccessTrue IPSECTunnelPSKGenerateResponseEnvelopeSuccess = true
)
func (IPSECTunnelPSKGenerateResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelPSKGenerateResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelService ¶
type IPSECTunnelService struct {
Options []option.RequestOption
}
IPSECTunnelService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewIPSECTunnelService method instead.
func NewIPSECTunnelService ¶
func NewIPSECTunnelService(opts ...option.RequestOption) (r *IPSECTunnelService)
NewIPSECTunnelService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*IPSECTunnelService) BulkUpdate ¶
func (r *IPSECTunnelService) BulkUpdate(ctx context.Context, params IPSECTunnelBulkUpdateParams, opts ...option.RequestOption) (res *IPSECTunnelBulkUpdateResponse, err error)
Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*IPSECTunnelService) Delete ¶
func (r *IPSECTunnelService) Delete(ctx context.Context, ipsecTunnelID string, params IPSECTunnelDeleteParams, opts ...option.RequestOption) (res *IPSECTunnelDeleteResponse, err error)
Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*IPSECTunnelService) Get ¶
func (r *IPSECTunnelService) Get(ctx context.Context, ipsecTunnelID string, params IPSECTunnelGetParams, opts ...option.RequestOption) (res *IPSECTunnelGetResponse, err error)
Lists details for a specific IPsec tunnel.
func (*IPSECTunnelService) List ¶
func (r *IPSECTunnelService) List(ctx context.Context, params IPSECTunnelListParams, opts ...option.RequestOption) (res *IPSECTunnelListResponse, err error)
Lists IPsec tunnels associated with an account.
func (*IPSECTunnelService) New ¶
func (r *IPSECTunnelService) New(ctx context.Context, params IPSECTunnelNewParams, opts ...option.RequestOption) (res *IPSECTunnelNewResponse, err error)
Creates a new IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
func (*IPSECTunnelService) PSKGenerate ¶
func (r *IPSECTunnelService) PSKGenerate(ctx context.Context, ipsecTunnelID string, params IPSECTunnelPSKGenerateParams, opts ...option.RequestOption) (res *IPSECTunnelPSKGenerateResponse, err error)
Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.
func (*IPSECTunnelService) Update ¶
func (r *IPSECTunnelService) Update(ctx context.Context, ipsecTunnelID string, params IPSECTunnelUpdateParams, opts ...option.RequestOption) (res *IPSECTunnelUpdateResponse, err error)
Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
type IPSECTunnelUpdateParams ¶
type IPSECTunnelUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint param.Field[string] `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress param.Field[string] `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name param.Field[string] `json:"name,required"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint param.Field[string] `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description param.Field[string] `json:"description"`
HealthCheck param.Field[IPSECTunnelUpdateParamsHealthCheck] `json:"health_check"`
// A randomly generated or provided string for use in the IPsec tunnel.
PSK param.Field[string] `json:"psk"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection param.Field[bool] `json:"replay_protection"`
XMagicNewHcTarget param.Field[bool] `header:"x-magic-new-hc-target"`
}
func (IPSECTunnelUpdateParams) MarshalJSON ¶
func (r IPSECTunnelUpdateParams) MarshalJSON() (data []byte, err error)
type IPSECTunnelUpdateParamsHealthCheck ¶
type IPSECTunnelUpdateParamsHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction param.Field[IPSECTunnelUpdateParamsHealthCheckDirection] `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled param.Field[bool] `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate param.Field[HealthCheckRate] `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target param.Field[IPSECTunnelUpdateParamsHealthCheckTargetUnion] `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type param.Field[HealthCheckType] `json:"type"`
}
func (IPSECTunnelUpdateParamsHealthCheck) MarshalJSON ¶
func (r IPSECTunnelUpdateParamsHealthCheck) MarshalJSON() (data []byte, err error)
type IPSECTunnelUpdateParamsHealthCheckDirection ¶
type IPSECTunnelUpdateParamsHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelUpdateParamsHealthCheckDirectionUnidirectional IPSECTunnelUpdateParamsHealthCheckDirection = "unidirectional" IPSECTunnelUpdateParamsHealthCheckDirectionBidirectional IPSECTunnelUpdateParamsHealthCheckDirection = "bidirectional" )
func (IPSECTunnelUpdateParamsHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelUpdateParamsHealthCheckDirection) IsKnown() bool
type IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget struct {
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved param.Field[string] `json:"saved"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion()
func (IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON ¶
func (r IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) MarshalJSON() (data []byte, err error)
type IPSECTunnelUpdateParamsHealthCheckTargetUnion ¶
type IPSECTunnelUpdateParamsHealthCheckTargetUnion interface {
ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Satisfied by magic_transit.IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget, shared.UnionString.
type IPSECTunnelUpdateResponse ¶
type IPSECTunnelUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedIPSECTunnel IPSECTunnelUpdateResponseModifiedIPSECTunnel `json:"modified_ipsec_tunnel"`
JSON ipsecTunnelUpdateResponseJSON `json:"-"`
}
func (*IPSECTunnelUpdateResponse) UnmarshalJSON ¶
func (r *IPSECTunnelUpdateResponse) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelUpdateResponseEnvelope ¶
type IPSECTunnelUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result IPSECTunnelUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success IPSECTunnelUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON ipsecTunnelUpdateResponseEnvelopeJSON `json:"-"`
}
func (*IPSECTunnelUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *IPSECTunnelUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelUpdateResponseEnvelopeSuccess ¶
type IPSECTunnelUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
IPSECTunnelUpdateResponseEnvelopeSuccessTrue IPSECTunnelUpdateResponseEnvelopeSuccess = true
)
func (IPSECTunnelUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r IPSECTunnelUpdateResponseEnvelopeSuccess) IsKnown() bool
type IPSECTunnelUpdateResponseModifiedIPSECTunnel ¶
type IPSECTunnelUpdateResponseModifiedIPSECTunnel struct {
// Identifier
ID string `json:"id,required"`
// The IP address assigned to the Cloudflare side of the IPsec tunnel.
CloudflareEndpoint string `json:"cloudflare_endpoint,required"`
// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side
// of the tunnel. Select the subnet from the following private IP space:
// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
InterfaceAddress string `json:"interface_address,required"`
// The name of the IPsec tunnel. The name cannot share a name with other tunnels.
Name string `json:"name,required"`
// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel
// (Phase 2).
AllowNullCipher bool `json:"allow_null_cipher"`
// The date and time the tunnel was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// The IP address assigned to the customer side of the IPsec tunnel. Not required,
// but must be set for proactive traceroutes to work.
CustomerEndpoint string `json:"customer_endpoint"`
// An optional description forthe IPsec tunnel.
Description string `json:"description"`
HealthCheck IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck `json:"health_check"`
// The date and time the tunnel was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// The PSK metadata that includes when the PSK was generated.
PSKMetadata PSKMetadata `json:"psk_metadata"`
// If `true`, then IPsec replay protection will be supported in the
// Cloudflare-to-customer direction.
ReplayProtection bool `json:"replay_protection"`
JSON ipsecTunnelUpdateResponseModifiedIPSECTunnelJSON `json:"-"`
}
func (*IPSECTunnelUpdateResponseModifiedIPSECTunnel) UnmarshalJSON ¶
func (r *IPSECTunnelUpdateResponseModifiedIPSECTunnel) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck ¶
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck struct {
// The direction of the flow of the healthcheck. Either unidirectional, where the
// probe comes to you via the tunnel and the result comes back to Cloudflare via
// the open Internet, or bidirectional where both the probe and result come and go
// via the tunnel.
Direction IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection `json:"direction"`
// Determines whether to run healthchecks for a tunnel.
Enabled bool `json:"enabled"`
// How frequent the health check is run. The default value is `mid`.
Rate HealthCheckRate `json:"rate"`
// The destination address in a request type health check. After the healthcheck is
// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
// to this address. This field defaults to `customer_gre_endpoint address`. This
// field is ignored for bidirectional healthchecks as the interface_address (not
// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in
// object form if the x-magic-new-hc-target header is set to true and string form
// if x-magic-new-hc-target is absent or set to false.
Target IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion `json:"target"`
// The type of healthcheck to run, reply or request. The default value is `reply`.
Type HealthCheckType `json:"type"`
JSON ipsecTunnelUpdateResponseModifiedIPSECTunnelHealthCheckJSON `json:"-"`
}
func (*IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck) UnmarshalJSON ¶
func (r *IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection ¶
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection string
The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
const ( IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirectionUnidirectional IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection = "unidirectional" IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirectionBidirectional IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection = "bidirectional" )
func (IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection) IsKnown ¶
func (r IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection) IsKnown() bool
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {
// The effective health check target. If 'saved' is empty, then this field will be
// populated with the calculated default value on GET requests. Ignored in POST,
// PUT, and PATCH requests.
Effective string `json:"effective"`
// The saved health check target. Setting the value to the empty string indicates
// that the calculated default value will be used.
Saved string `json:"saved"`
JSON ipsecTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
func (IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion ¶ added in v4.1.0
func (r IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion()
func (*IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON ¶
func (r *IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) UnmarshalJSON(data []byte) (err error)
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion ¶
type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion interface {
ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion()
}
The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.
Union satisfied by IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget or shared.UnionString.
type LAN ¶
type LAN struct {
// Identifier
ID string `json:"id"`
// mark true to use this LAN for HA probing. only works for site with HA turned on.
// only one LAN can be set as the ha_link.
HaLink bool `json:"ha_link"`
Name string `json:"name"`
Nat Nat `json:"nat"`
Physport int64 `json:"physport"`
RoutedSubnets []RoutedSubnet `json:"routed_subnets"`
// Identifier
SiteID string `json:"site_id"`
// If the site is not configured in high availability mode, this configuration is
// optional (if omitted, use DHCP). However, if in high availability mode,
// static_address is required along with secondary and virtual address.
StaticAddressing LANStaticAddressing `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag int64 `json:"vlan_tag"`
JSON lanJSON `json:"-"`
}
func (*LAN) UnmarshalJSON ¶
type LANStaticAddressing ¶
type LANStaticAddressing struct {
// A valid CIDR notation representing an IP range.
Address string `json:"address,required"`
DHCPRelay DHCPRelay `json:"dhcp_relay"`
DHCPServer DHCPServer `json:"dhcp_server"`
// A valid CIDR notation representing an IP range.
SecondaryAddress string `json:"secondary_address"`
// A valid CIDR notation representing an IP range.
VirtualAddress string `json:"virtual_address"`
JSON lanStaticAddressingJSON `json:"-"`
}
If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.
func (*LANStaticAddressing) UnmarshalJSON ¶
func (r *LANStaticAddressing) UnmarshalJSON(data []byte) (err error)
type LANStaticAddressingParam ¶
type LANStaticAddressingParam struct {
// A valid CIDR notation representing an IP range.
Address param.Field[string] `json:"address,required"`
DHCPRelay param.Field[DHCPRelayParam] `json:"dhcp_relay"`
DHCPServer param.Field[DHCPServerParam] `json:"dhcp_server"`
// A valid CIDR notation representing an IP range.
SecondaryAddress param.Field[string] `json:"secondary_address"`
// A valid CIDR notation representing an IP range.
VirtualAddress param.Field[string] `json:"virtual_address"`
}
If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.
func (LANStaticAddressingParam) MarshalJSON ¶
func (r LANStaticAddressingParam) MarshalJSON() (data []byte, err error)
type MagicTransitService ¶
type MagicTransitService struct {
Options []option.RequestOption
Apps *AppService
CfInterconnects *CfInterconnectService
GRETunnels *GRETunnelService
IPSECTunnels *IPSECTunnelService
Routes *RouteService
Sites *SiteService
Connectors *ConnectorService
PCAPs *PCAPService
}
MagicTransitService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewMagicTransitService method instead.
func NewMagicTransitService ¶
func NewMagicTransitService(opts ...option.RequestOption) (r *MagicTransitService)
NewMagicTransitService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type Nat ¶
type Nat struct {
// A valid CIDR notation representing an IP range.
StaticPrefix string `json:"static_prefix"`
JSON natJSON `json:"-"`
}
func (*Nat) UnmarshalJSON ¶
type NatParam ¶
type NatParam struct {
// A valid CIDR notation representing an IP range.
StaticPrefix param.Field[string] `json:"static_prefix"`
}
func (NatParam) MarshalJSON ¶
type Ownership ¶
type Ownership struct {
// The bucket ID associated with the packet captures API.
ID string `json:"id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf,required"`
// The ownership challenge filename stored in the bucket.
Filename string `json:"filename,required"`
// The status of the ownership challenge. Can be pending, success or failed.
Status OwnershipStatus `json:"status,required"`
// The RFC 3339 timestamp when the bucket was added to packet captures API.
Submitted string `json:"submitted,required"`
// The RFC 3339 timestamp when the bucket was validated.
Validated string `json:"validated"`
JSON ownershipJSON `json:"-"`
}
func (*Ownership) UnmarshalJSON ¶
type OwnershipStatus ¶
type OwnershipStatus string
The status of the ownership challenge. Can be pending, success or failed.
const ( OwnershipStatusPending OwnershipStatus = "pending" OwnershipStatusSuccess OwnershipStatus = "success" OwnershipStatusFailed OwnershipStatus = "failed" )
func (OwnershipStatus) IsKnown ¶
func (r OwnershipStatus) IsKnown() bool
type PCAP ¶
type PCAP struct {
// The ID for the packet capture.
ID string `json:"id"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime time.Time `json:"offset_time" format:"date-time"`
// The status of the packet capture request.
Status PCAPStatus `json:"status"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPType `json:"type"`
JSON pcapJSON `json:"-"`
}
func (*PCAP) UnmarshalJSON ¶
type PCAPDownloadGetParams ¶
type PCAPDownloadService ¶
type PCAPDownloadService struct {
Options []option.RequestOption
}
PCAPDownloadService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPCAPDownloadService method instead.
func NewPCAPDownloadService ¶
func NewPCAPDownloadService(opts ...option.RequestOption) (r *PCAPDownloadService)
NewPCAPDownloadService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PCAPDownloadService) Get ¶
func (r *PCAPDownloadService) Get(ctx context.Context, pcapID string, query PCAPDownloadGetParams, opts ...option.RequestOption) (res *http.Response, err error)
Download PCAP information into a file. Response is a binary PCAP file.
type PCAPFilter ¶
type PCAPFilter struct {
// The destination IP address of the packet.
DestinationAddress string `json:"destination_address"`
// The destination port of the packet.
DestinationPort float64 `json:"destination_port"`
// The protocol number of the packet.
Protocol float64 `json:"protocol"`
// The source IP address of the packet.
SourceAddress string `json:"source_address"`
// The source port of the packet.
SourcePort float64 `json:"source_port"`
JSON pcapFilterJSON `json:"-"`
}
The packet capture filter. When this field is empty, all packets are captured.
func (*PCAPFilter) UnmarshalJSON ¶
func (r *PCAPFilter) UnmarshalJSON(data []byte) (err error)
type PCAPFilterParam ¶
type PCAPFilterParam struct {
// The destination IP address of the packet.
DestinationAddress param.Field[string] `json:"destination_address"`
// The destination port of the packet.
DestinationPort param.Field[float64] `json:"destination_port"`
// The protocol number of the packet.
Protocol param.Field[float64] `json:"protocol"`
// The source IP address of the packet.
SourceAddress param.Field[string] `json:"source_address"`
// The source port of the packet.
SourcePort param.Field[float64] `json:"source_port"`
}
The packet capture filter. When this field is empty, all packets are captured.
func (PCAPFilterParam) MarshalJSON ¶
func (r PCAPFilterParam) MarshalJSON() (data []byte, err error)
type PCAPGetParams ¶
type PCAPGetResponse ¶
type PCAPGetResponse struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime time.Time `json:"offset_time" format:"date-time"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPGetResponseStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPGetResponseSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPGetResponseType `json:"type"`
JSON pcapGetResponseJSON `json:"-"`
// contains filtered or unexported fields
}
func (PCAPGetResponse) AsUnion ¶
func (r PCAPGetResponse) AsUnion() PCAPGetResponseUnion
AsUnion returns a PCAPGetResponseUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PCAP, PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull.
func (*PCAPGetResponse) UnmarshalJSON ¶
func (r *PCAPGetResponse) UnmarshalJSON(data []byte) (err error)
type PCAPGetResponseEnvelope ¶
type PCAPGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result PCAPGetResponse `json:"result,required"`
// Whether the API call was successful
Success PCAPGetResponseEnvelopeSuccess `json:"success,required"`
JSON pcapGetResponseEnvelopeJSON `json:"-"`
}
func (*PCAPGetResponseEnvelope) UnmarshalJSON ¶
func (r *PCAPGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PCAPGetResponseEnvelopeSuccess ¶
type PCAPGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PCAPGetResponseEnvelopeSuccessTrue PCAPGetResponseEnvelopeSuccess = true
)
func (PCAPGetResponseEnvelopeSuccess) IsKnown ¶
func (r PCAPGetResponseEnvelopeSuccess) IsKnown() bool
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull ¶
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`
JSON pcapGetResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`
}
func (*PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON ¶
func (r *PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON(data []byte) (err error)
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus string
The status of the packet capture request.
const ( PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknown PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccess PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPending PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunning PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPending PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunning PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusComplete PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailed PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed" )
func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown ¶
func (r PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown() bool
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem string
The system used to collect packet captures.
const (
PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransit PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit"
)
func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown ¶
func (r PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown() bool
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶
type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimple PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple" PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFull PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full" )
func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown ¶
func (r PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown() bool
type PCAPGetResponseStatus ¶
type PCAPGetResponseStatus string
The status of the packet capture request.
const ( PCAPGetResponseStatusUnknown PCAPGetResponseStatus = "unknown" PCAPGetResponseStatusSuccess PCAPGetResponseStatus = "success" PCAPGetResponseStatusPending PCAPGetResponseStatus = "pending" PCAPGetResponseStatusRunning PCAPGetResponseStatus = "running" PCAPGetResponseStatusConversionPending PCAPGetResponseStatus = "conversion_pending" PCAPGetResponseStatusConversionRunning PCAPGetResponseStatus = "conversion_running" PCAPGetResponseStatusComplete PCAPGetResponseStatus = "complete" PCAPGetResponseStatusFailed PCAPGetResponseStatus = "failed" )
func (PCAPGetResponseStatus) IsKnown ¶
func (r PCAPGetResponseStatus) IsKnown() bool
type PCAPGetResponseSystem ¶
type PCAPGetResponseSystem string
The system used to collect packet captures.
const (
PCAPGetResponseSystemMagicTransit PCAPGetResponseSystem = "magic-transit"
)
func (PCAPGetResponseSystem) IsKnown ¶
func (r PCAPGetResponseSystem) IsKnown() bool
type PCAPGetResponseType ¶
type PCAPGetResponseType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPGetResponseTypeSimple PCAPGetResponseType = "simple" PCAPGetResponseTypeFull PCAPGetResponseType = "full" )
func (PCAPGetResponseType) IsKnown ¶
func (r PCAPGetResponseType) IsKnown() bool
type PCAPGetResponseUnion ¶
type PCAPGetResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by PCAP or PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull.
type PCAPListParams ¶
type PCAPListResponse ¶
type PCAPListResponse struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime time.Time `json:"offset_time" format:"date-time"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPListResponseStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPListResponseSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPListResponseType `json:"type"`
JSON pcapListResponseJSON `json:"-"`
// contains filtered or unexported fields
}
func (PCAPListResponse) AsUnion ¶
func (r PCAPListResponse) AsUnion() PCAPListResponseUnion
AsUnion returns a PCAPListResponseUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PCAP, PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull.
func (*PCAPListResponse) UnmarshalJSON ¶
func (r *PCAPListResponse) UnmarshalJSON(data []byte) (err error)
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull ¶
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`
JSON pcapListResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`
}
func (*PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON ¶
func (r *PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON(data []byte) (err error)
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus string
The status of the packet capture request.
const ( PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknown PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccess PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPending PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunning PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPending PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunning PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusComplete PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailed PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed" )
func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown ¶
func (r PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown() bool
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem string
The system used to collect packet captures.
const (
PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransit PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit"
)
func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown ¶
func (r PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown() bool
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimple PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple" PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFull PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full" )
func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown ¶
func (r PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown() bool
type PCAPListResponseStatus ¶
type PCAPListResponseStatus string
The status of the packet capture request.
const ( PCAPListResponseStatusUnknown PCAPListResponseStatus = "unknown" PCAPListResponseStatusSuccess PCAPListResponseStatus = "success" PCAPListResponseStatusPending PCAPListResponseStatus = "pending" PCAPListResponseStatusRunning PCAPListResponseStatus = "running" PCAPListResponseStatusConversionPending PCAPListResponseStatus = "conversion_pending" PCAPListResponseStatusConversionRunning PCAPListResponseStatus = "conversion_running" PCAPListResponseStatusComplete PCAPListResponseStatus = "complete" PCAPListResponseStatusFailed PCAPListResponseStatus = "failed" )
func (PCAPListResponseStatus) IsKnown ¶
func (r PCAPListResponseStatus) IsKnown() bool
type PCAPListResponseSystem ¶
type PCAPListResponseSystem string
The system used to collect packet captures.
const (
PCAPListResponseSystemMagicTransit PCAPListResponseSystem = "magic-transit"
)
func (PCAPListResponseSystem) IsKnown ¶
func (r PCAPListResponseSystem) IsKnown() bool
type PCAPListResponseType ¶
type PCAPListResponseType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPListResponseTypeSimple PCAPListResponseType = "simple" PCAPListResponseTypeFull PCAPListResponseType = "full" )
func (PCAPListResponseType) IsKnown ¶
func (r PCAPListResponseType) IsKnown() bool
type PCAPListResponseUnion ¶
type PCAPListResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by PCAP or PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull.
type PCAPNewParams ¶
type PCAPNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body PCAPNewParamsBodyUnion `json:"body,required"`
}
func (PCAPNewParams) MarshalJSON ¶
func (r PCAPNewParams) MarshalJSON() (data []byte, err error)
type PCAPNewParamsBody ¶
type PCAPNewParamsBody struct {
// The system used to collect packet captures.
System param.Field[PCAPNewParamsBodySystem] `json:"system,required"`
// The packet capture duration in seconds.
TimeLimit param.Field[float64] `json:"time_limit,required"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type param.Field[PCAPNewParamsBodyType] `json:"type,required"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit param.Field[float64] `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName param.Field[string] `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 param.Field[PCAPFilterParam] `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime param.Field[time.Time] `json:"offset_time" format:"date-time"`
// The limit of packets contained in a packet capture.
PacketLimit param.Field[float64] `json:"packet_limit"`
}
func (PCAPNewParamsBody) MarshalJSON ¶
func (r PCAPNewParamsBody) MarshalJSON() (data []byte, err error)
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull struct {
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName param.Field[string] `json:"colo_name,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf,required"`
// The system used to collect packet captures.
System param.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem] `json:"system,required"`
// The packet capture duration in seconds.
TimeLimit param.Field[float64] `json:"time_limit,required"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type param.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType] `json:"type,required"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit param.Field[float64] `json:"byte_limit"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 param.Field[PCAPFilterParam] `json:"filter_v1"`
// The limit of packets contained in a packet capture.
PacketLimit param.Field[float64] `json:"packet_limit"`
}
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull) MarshalJSON ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull) MarshalJSON() (data []byte, err error)
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem string
The system used to collect packet captures.
const (
PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystemMagicTransit PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem = "magic-transit"
)
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem) IsKnown ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem) IsKnown() bool
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullTypeSimple PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType = "simple" PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullTypeFull PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType = "full" )
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType) IsKnown ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType) IsKnown() bool
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple struct {
// The limit of packets contained in a packet capture.
PacketLimit param.Field[float64] `json:"packet_limit,required"`
// The system used to collect packet captures.
System param.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem] `json:"system,required"`
// The packet capture duration in seconds.
TimeLimit param.Field[float64] `json:"time_limit,required"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type param.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType] `json:"type,required"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 param.Field[PCAPFilterParam] `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime param.Field[time.Time] `json:"offset_time" format:"date-time"`
}
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple) MarshalJSON ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple) MarshalJSON() (data []byte, err error)
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem string
The system used to collect packet captures.
const (
PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystemMagicTransit PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem = "magic-transit"
)
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem) IsKnown ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem) IsKnown() bool
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType ¶
type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypeSimple PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType = "simple" PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypeFull PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType = "full" )
func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType) IsKnown ¶
func (r PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType) IsKnown() bool
type PCAPNewParamsBodySystem ¶
type PCAPNewParamsBodySystem string
The system used to collect packet captures.
const (
PCAPNewParamsBodySystemMagicTransit PCAPNewParamsBodySystem = "magic-transit"
)
func (PCAPNewParamsBodySystem) IsKnown ¶
func (r PCAPNewParamsBodySystem) IsKnown() bool
type PCAPNewParamsBodyType ¶
type PCAPNewParamsBodyType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPNewParamsBodyTypeSimple PCAPNewParamsBodyType = "simple" PCAPNewParamsBodyTypeFull PCAPNewParamsBodyType = "full" )
func (PCAPNewParamsBodyType) IsKnown ¶
func (r PCAPNewParamsBodyType) IsKnown() bool
type PCAPNewParamsBodyUnion ¶
type PCAPNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple, magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull, PCAPNewParamsBody.
type PCAPNewResponse ¶
type PCAPNewResponse struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The RFC 3339 offset timestamp from which to query backwards for packets. Must be
// within the last 24h. When this field is empty, defaults to time of request.
OffsetTime time.Time `json:"offset_time" format:"date-time"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPNewResponseStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPNewResponseSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPNewResponseType `json:"type"`
JSON pcapNewResponseJSON `json:"-"`
// contains filtered or unexported fields
}
func (PCAPNewResponse) AsUnion ¶
func (r PCAPNewResponse) AsUnion() PCAPNewResponseUnion
AsUnion returns a PCAPNewResponseUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PCAP, PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull.
func (*PCAPNewResponse) UnmarshalJSON ¶
func (r *PCAPNewResponse) UnmarshalJSON(data []byte) (err error)
type PCAPNewResponseEnvelope ¶
type PCAPNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result PCAPNewResponse `json:"result,required"`
// Whether the API call was successful
Success PCAPNewResponseEnvelopeSuccess `json:"success,required"`
JSON pcapNewResponseEnvelopeJSON `json:"-"`
}
func (*PCAPNewResponseEnvelope) UnmarshalJSON ¶
func (r *PCAPNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PCAPNewResponseEnvelopeSuccess ¶
type PCAPNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PCAPNewResponseEnvelopeSuccessTrue PCAPNewResponseEnvelopeSuccess = true
)
func (PCAPNewResponseEnvelopeSuccess) IsKnown ¶
func (r PCAPNewResponseEnvelopeSuccess) IsKnown() bool
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull ¶
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull struct {
// The ID for the packet capture.
ID string `json:"id"`
// The maximum number of bytes to capture. This field only applies to `full` packet
// captures.
ByteLimit float64 `json:"byte_limit"`
// The name of the data center used for the packet capture. This can be a specific
// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`
// packet captures.
ColoName string `json:"colo_name"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf"`
// An error message that describes why the packet capture failed. This field only
// applies to `full` packet captures.
ErrorMessage string `json:"error_message"`
// The packet capture filter. When this field is empty, all packets are captured.
FilterV1 PCAPFilter `json:"filter_v1"`
// The number of packets captured.
PacketsCaptured int64 `json:"packets_captured"`
// The status of the packet capture request.
Status PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`
// The RFC 3339 timestamp when stopping the packet capture was requested. This
// field only applies to `full` packet captures.
StopRequested time.Time `json:"stop_requested" format:"date-time"`
// The RFC 3339 timestamp when the packet capture was created.
Submitted string `json:"submitted"`
// The system used to collect packet captures.
System PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`
// The packet capture duration in seconds.
TimeLimit float64 `json:"time_limit"`
// The type of packet capture. `Simple` captures sampled packets, and `full`
// captures entire payloads and non-sampled packets.
Type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`
JSON pcapNewResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`
}
func (*PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON ¶
func (r *PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull) UnmarshalJSON(data []byte) (err error)
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus string
The status of the packet capture request.
const ( PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknown PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccess PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPending PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunning PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPending PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunning PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusComplete PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailed PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed" )
func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown ¶
func (r PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown() bool
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem string
The system used to collect packet captures.
const (
PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransit PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit"
)
func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown ¶
func (r PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown() bool
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶
type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimple PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple" PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFull PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full" )
func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown ¶
func (r PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown() bool
type PCAPNewResponseStatus ¶
type PCAPNewResponseStatus string
The status of the packet capture request.
const ( PCAPNewResponseStatusUnknown PCAPNewResponseStatus = "unknown" PCAPNewResponseStatusSuccess PCAPNewResponseStatus = "success" PCAPNewResponseStatusPending PCAPNewResponseStatus = "pending" PCAPNewResponseStatusRunning PCAPNewResponseStatus = "running" PCAPNewResponseStatusConversionPending PCAPNewResponseStatus = "conversion_pending" PCAPNewResponseStatusConversionRunning PCAPNewResponseStatus = "conversion_running" PCAPNewResponseStatusComplete PCAPNewResponseStatus = "complete" PCAPNewResponseStatusFailed PCAPNewResponseStatus = "failed" )
func (PCAPNewResponseStatus) IsKnown ¶
func (r PCAPNewResponseStatus) IsKnown() bool
type PCAPNewResponseSystem ¶
type PCAPNewResponseSystem string
The system used to collect packet captures.
const (
PCAPNewResponseSystemMagicTransit PCAPNewResponseSystem = "magic-transit"
)
func (PCAPNewResponseSystem) IsKnown ¶
func (r PCAPNewResponseSystem) IsKnown() bool
type PCAPNewResponseType ¶
type PCAPNewResponseType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
const ( PCAPNewResponseTypeSimple PCAPNewResponseType = "simple" PCAPNewResponseTypeFull PCAPNewResponseType = "full" )
func (PCAPNewResponseType) IsKnown ¶
func (r PCAPNewResponseType) IsKnown() bool
type PCAPNewResponseUnion ¶
type PCAPNewResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by PCAP or PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull.
type PCAPOwnershipGetParams ¶
type PCAPOwnershipNewParams ¶
type PCAPOwnershipNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf,required"`
}
func (PCAPOwnershipNewParams) MarshalJSON ¶
func (r PCAPOwnershipNewParams) MarshalJSON() (data []byte, err error)
type PCAPOwnershipNewResponseEnvelope ¶
type PCAPOwnershipNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Ownership `json:"result,required"`
// Whether the API call was successful
Success PCAPOwnershipNewResponseEnvelopeSuccess `json:"success,required"`
JSON pcapOwnershipNewResponseEnvelopeJSON `json:"-"`
}
func (*PCAPOwnershipNewResponseEnvelope) UnmarshalJSON ¶
func (r *PCAPOwnershipNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PCAPOwnershipNewResponseEnvelopeSuccess ¶
type PCAPOwnershipNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PCAPOwnershipNewResponseEnvelopeSuccessTrue PCAPOwnershipNewResponseEnvelopeSuccess = true
)
func (PCAPOwnershipNewResponseEnvelopeSuccess) IsKnown ¶
func (r PCAPOwnershipNewResponseEnvelopeSuccess) IsKnown() bool
type PCAPOwnershipService ¶
type PCAPOwnershipService struct {
Options []option.RequestOption
}
PCAPOwnershipService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPCAPOwnershipService method instead.
func NewPCAPOwnershipService ¶
func NewPCAPOwnershipService(opts ...option.RequestOption) (r *PCAPOwnershipService)
NewPCAPOwnershipService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PCAPOwnershipService) Delete ¶
func (r *PCAPOwnershipService) Delete(ctx context.Context, ownershipID string, body PCAPOwnershipDeleteParams, opts ...option.RequestOption) (err error)
Deletes buckets added to the packet captures API.
func (*PCAPOwnershipService) Get ¶
func (r *PCAPOwnershipService) Get(ctx context.Context, query PCAPOwnershipGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[Ownership], err error)
List all buckets configured for use with PCAPs API.
func (*PCAPOwnershipService) GetAutoPaging ¶ added in v4.1.0
func (r *PCAPOwnershipService) GetAutoPaging(ctx context.Context, query PCAPOwnershipGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Ownership]
List all buckets configured for use with PCAPs API.
func (*PCAPOwnershipService) New ¶
func (r *PCAPOwnershipService) New(ctx context.Context, params PCAPOwnershipNewParams, opts ...option.RequestOption) (res *Ownership, err error)
Adds an AWS or GCP bucket to use with full packet captures.
func (*PCAPOwnershipService) Validate ¶
func (r *PCAPOwnershipService) Validate(ctx context.Context, params PCAPOwnershipValidateParams, opts ...option.RequestOption) (res *Ownership, err error)
Validates buckets added to the packet captures API.
type PCAPOwnershipValidateParams ¶
type PCAPOwnershipValidateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf,required"`
// The ownership challenge filename stored in the bucket.
OwnershipChallenge param.Field[string] `json:"ownership_challenge,required"`
}
func (PCAPOwnershipValidateParams) MarshalJSON ¶
func (r PCAPOwnershipValidateParams) MarshalJSON() (data []byte, err error)
type PCAPOwnershipValidateResponseEnvelope ¶
type PCAPOwnershipValidateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Ownership `json:"result,required"`
// Whether the API call was successful
Success PCAPOwnershipValidateResponseEnvelopeSuccess `json:"success,required"`
JSON pcapOwnershipValidateResponseEnvelopeJSON `json:"-"`
}
func (*PCAPOwnershipValidateResponseEnvelope) UnmarshalJSON ¶
func (r *PCAPOwnershipValidateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PCAPOwnershipValidateResponseEnvelopeSuccess ¶
type PCAPOwnershipValidateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PCAPOwnershipValidateResponseEnvelopeSuccessTrue PCAPOwnershipValidateResponseEnvelopeSuccess = true
)
func (PCAPOwnershipValidateResponseEnvelopeSuccess) IsKnown ¶
func (r PCAPOwnershipValidateResponseEnvelopeSuccess) IsKnown() bool
type PCAPService ¶
type PCAPService struct {
Options []option.RequestOption
Ownership *PCAPOwnershipService
Download *PCAPDownloadService
}
PCAPService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPCAPService method instead.
func NewPCAPService ¶
func NewPCAPService(opts ...option.RequestOption) (r *PCAPService)
NewPCAPService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PCAPService) Get ¶
func (r *PCAPService) Get(ctx context.Context, pcapID string, query PCAPGetParams, opts ...option.RequestOption) (res *PCAPGetResponse, err error)
Get information for a PCAP request by id.
func (*PCAPService) List ¶
func (r *PCAPService) List(ctx context.Context, query PCAPListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PCAPListResponse], err error)
Lists all packet capture requests for an account.
func (*PCAPService) ListAutoPaging ¶
func (r *PCAPService) ListAutoPaging(ctx context.Context, query PCAPListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PCAPListResponse]
Lists all packet capture requests for an account.
func (*PCAPService) New ¶
func (r *PCAPService) New(ctx context.Context, params PCAPNewParams, opts ...option.RequestOption) (res *PCAPNewResponse, err error)
Create new PCAP request for account.
func (*PCAPService) Stop ¶ added in v4.4.0
func (r *PCAPService) Stop(ctx context.Context, pcapID string, body PCAPStopParams, opts ...option.RequestOption) (err error)
Stop full PCAP
type PCAPStatus ¶
type PCAPStatus string
The status of the packet capture request.
const ( PCAPStatusUnknown PCAPStatus = "unknown" PCAPStatusSuccess PCAPStatus = "success" PCAPStatusPending PCAPStatus = "pending" PCAPStatusRunning PCAPStatus = "running" PCAPStatusConversionPending PCAPStatus = "conversion_pending" PCAPStatusConversionRunning PCAPStatus = "conversion_running" PCAPStatusComplete PCAPStatus = "complete" PCAPStatusFailed PCAPStatus = "failed" )
func (PCAPStatus) IsKnown ¶
func (r PCAPStatus) IsKnown() bool
type PCAPStopParams ¶ added in v4.4.0
type PCAPSystem ¶
type PCAPSystem string
The system used to collect packet captures.
const (
PCAPSystemMagicTransit PCAPSystem = "magic-transit"
)
func (PCAPSystem) IsKnown ¶
func (r PCAPSystem) IsKnown() bool
type PCAPType ¶
type PCAPType string
The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
type PSKMetadata ¶
type PSKMetadata struct {
// The date and time the tunnel was last modified.
LastGeneratedOn time.Time `json:"last_generated_on" format:"date-time"`
JSON pskMetadataJSON `json:"-"`
}
The PSK metadata that includes when the PSK was generated.
func (*PSKMetadata) UnmarshalJSON ¶
func (r *PSKMetadata) UnmarshalJSON(data []byte) (err error)
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type RatePlanID ¶ added in v4.1.0
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type RouteBulkUpdateParams ¶
type RouteBulkUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Routes param.Field[[]RouteBulkUpdateParamsRoute] `json:"routes,required"`
}
func (RouteBulkUpdateParams) MarshalJSON ¶
func (r RouteBulkUpdateParams) MarshalJSON() (data []byte, err error)
type RouteBulkUpdateParamsRoute ¶
type RouteBulkUpdateParamsRoute struct {
// Identifier
ID param.Field[string] `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop param.Field[string] `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix param.Field[string] `json:"prefix,required"`
// Priority of the static route.
Priority param.Field[int64] `json:"priority,required"`
// An optional human provided description of the static route.
Description param.Field[string] `json:"description"`
// Used only for ECMP routes.
Scope param.Field[ScopeParam] `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight param.Field[int64] `json:"weight"`
}
func (RouteBulkUpdateParamsRoute) MarshalJSON ¶
func (r RouteBulkUpdateParamsRoute) MarshalJSON() (data []byte, err error)
type RouteBulkUpdateResponse ¶
type RouteBulkUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedRoutes []RouteBulkUpdateResponseModifiedRoute `json:"modified_routes"`
JSON routeBulkUpdateResponseJSON `json:"-"`
}
func (*RouteBulkUpdateResponse) UnmarshalJSON ¶
func (r *RouteBulkUpdateResponse) UnmarshalJSON(data []byte) (err error)
type RouteBulkUpdateResponseEnvelope ¶
type RouteBulkUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteBulkUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success RouteBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON routeBulkUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RouteBulkUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RouteBulkUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteBulkUpdateResponseEnvelopeSuccess ¶
type RouteBulkUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteBulkUpdateResponseEnvelopeSuccessTrue RouteBulkUpdateResponseEnvelopeSuccess = true
)
func (RouteBulkUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RouteBulkUpdateResponseEnvelopeSuccess) IsKnown() bool
type RouteBulkUpdateResponseModifiedRoute ¶
type RouteBulkUpdateResponseModifiedRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeBulkUpdateResponseModifiedRouteJSON `json:"-"`
}
func (*RouteBulkUpdateResponseModifiedRoute) UnmarshalJSON ¶
func (r *RouteBulkUpdateResponseModifiedRoute) UnmarshalJSON(data []byte) (err error)
type RouteDeleteParams ¶
type RouteDeleteResponse ¶
type RouteDeleteResponse struct {
Deleted bool `json:"deleted"`
DeletedRoute RouteDeleteResponseDeletedRoute `json:"deleted_route"`
JSON routeDeleteResponseJSON `json:"-"`
}
func (*RouteDeleteResponse) UnmarshalJSON ¶
func (r *RouteDeleteResponse) UnmarshalJSON(data []byte) (err error)
type RouteDeleteResponseDeletedRoute ¶
type RouteDeleteResponseDeletedRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeDeleteResponseDeletedRouteJSON `json:"-"`
}
func (*RouteDeleteResponseDeletedRoute) UnmarshalJSON ¶
func (r *RouteDeleteResponseDeletedRoute) UnmarshalJSON(data []byte) (err error)
type RouteDeleteResponseEnvelope ¶
type RouteDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteDeleteResponse `json:"result,required"`
// Whether the API call was successful
Success RouteDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON routeDeleteResponseEnvelopeJSON `json:"-"`
}
func (*RouteDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *RouteDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteDeleteResponseEnvelopeSuccess ¶
type RouteDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteDeleteResponseEnvelopeSuccessTrue RouteDeleteResponseEnvelopeSuccess = true
)
func (RouteDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r RouteDeleteResponseEnvelopeSuccess) IsKnown() bool
type RouteEmptyParams ¶
type RouteEmptyResponse ¶
type RouteEmptyResponse struct {
Deleted bool `json:"deleted"`
DeletedRoutes []RouteEmptyResponseDeletedRoute `json:"deleted_routes"`
JSON routeEmptyResponseJSON `json:"-"`
}
func (*RouteEmptyResponse) UnmarshalJSON ¶
func (r *RouteEmptyResponse) UnmarshalJSON(data []byte) (err error)
type RouteEmptyResponseDeletedRoute ¶
type RouteEmptyResponseDeletedRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeEmptyResponseDeletedRouteJSON `json:"-"`
}
func (*RouteEmptyResponseDeletedRoute) UnmarshalJSON ¶
func (r *RouteEmptyResponseDeletedRoute) UnmarshalJSON(data []byte) (err error)
type RouteEmptyResponseEnvelope ¶
type RouteEmptyResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteEmptyResponse `json:"result,required"`
// Whether the API call was successful
Success RouteEmptyResponseEnvelopeSuccess `json:"success,required"`
JSON routeEmptyResponseEnvelopeJSON `json:"-"`
}
func (*RouteEmptyResponseEnvelope) UnmarshalJSON ¶
func (r *RouteEmptyResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteEmptyResponseEnvelopeSuccess ¶
type RouteEmptyResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteEmptyResponseEnvelopeSuccessTrue RouteEmptyResponseEnvelopeSuccess = true
)
func (RouteEmptyResponseEnvelopeSuccess) IsKnown ¶
func (r RouteEmptyResponseEnvelopeSuccess) IsKnown() bool
type RouteGetParams ¶
type RouteGetResponse ¶
type RouteGetResponse struct {
Route RouteGetResponseRoute `json:"route"`
JSON routeGetResponseJSON `json:"-"`
}
func (*RouteGetResponse) UnmarshalJSON ¶
func (r *RouteGetResponse) UnmarshalJSON(data []byte) (err error)
type RouteGetResponseEnvelope ¶
type RouteGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteGetResponse `json:"result,required"`
// Whether the API call was successful
Success RouteGetResponseEnvelopeSuccess `json:"success,required"`
JSON routeGetResponseEnvelopeJSON `json:"-"`
}
func (*RouteGetResponseEnvelope) UnmarshalJSON ¶
func (r *RouteGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteGetResponseEnvelopeSuccess ¶
type RouteGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteGetResponseEnvelopeSuccessTrue RouteGetResponseEnvelopeSuccess = true
)
func (RouteGetResponseEnvelopeSuccess) IsKnown ¶
func (r RouteGetResponseEnvelopeSuccess) IsKnown() bool
type RouteGetResponseRoute ¶
type RouteGetResponseRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeGetResponseRouteJSON `json:"-"`
}
func (*RouteGetResponseRoute) UnmarshalJSON ¶
func (r *RouteGetResponseRoute) UnmarshalJSON(data []byte) (err error)
type RouteListParams ¶
type RouteListResponse ¶
type RouteListResponse struct {
Routes []RouteListResponseRoute `json:"routes"`
JSON routeListResponseJSON `json:"-"`
}
func (*RouteListResponse) UnmarshalJSON ¶
func (r *RouteListResponse) UnmarshalJSON(data []byte) (err error)
type RouteListResponseEnvelope ¶
type RouteListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteListResponse `json:"result,required"`
// Whether the API call was successful
Success RouteListResponseEnvelopeSuccess `json:"success,required"`
JSON routeListResponseEnvelopeJSON `json:"-"`
}
func (*RouteListResponseEnvelope) UnmarshalJSON ¶
func (r *RouteListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteListResponseEnvelopeSuccess ¶
type RouteListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteListResponseEnvelopeSuccessTrue RouteListResponseEnvelopeSuccess = true
)
func (RouteListResponseEnvelopeSuccess) IsKnown ¶
func (r RouteListResponseEnvelopeSuccess) IsKnown() bool
type RouteListResponseRoute ¶
type RouteListResponseRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeListResponseRouteJSON `json:"-"`
}
func (*RouteListResponseRoute) UnmarshalJSON ¶
func (r *RouteListResponseRoute) UnmarshalJSON(data []byte) (err error)
type RouteNewParams ¶
type RouteNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The next-hop IP Address for the static route.
Nexthop param.Field[string] `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix param.Field[string] `json:"prefix,required"`
// Priority of the static route.
Priority param.Field[int64] `json:"priority,required"`
// An optional human provided description of the static route.
Description param.Field[string] `json:"description"`
// Used only for ECMP routes.
Scope param.Field[ScopeParam] `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight param.Field[int64] `json:"weight"`
}
func (RouteNewParams) MarshalJSON ¶
func (r RouteNewParams) MarshalJSON() (data []byte, err error)
type RouteNewResponse ¶
type RouteNewResponse struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeNewResponseJSON `json:"-"`
}
func (*RouteNewResponse) UnmarshalJSON ¶
func (r *RouteNewResponse) UnmarshalJSON(data []byte) (err error)
type RouteNewResponseEnvelope ¶
type RouteNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteNewResponse `json:"result,required"`
// Whether the API call was successful
Success RouteNewResponseEnvelopeSuccess `json:"success,required"`
JSON routeNewResponseEnvelopeJSON `json:"-"`
}
func (*RouteNewResponseEnvelope) UnmarshalJSON ¶
func (r *RouteNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteNewResponseEnvelopeSuccess ¶
type RouteNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteNewResponseEnvelopeSuccessTrue RouteNewResponseEnvelopeSuccess = true
)
func (RouteNewResponseEnvelopeSuccess) IsKnown ¶
func (r RouteNewResponseEnvelopeSuccess) IsKnown() bool
type RouteService ¶
type RouteService struct {
Options []option.RequestOption
}
RouteService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRouteService method instead.
func NewRouteService ¶
func NewRouteService(opts ...option.RequestOption) (r *RouteService)
NewRouteService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*RouteService) BulkUpdate ¶
func (r *RouteService) BulkUpdate(ctx context.Context, params RouteBulkUpdateParams, opts ...option.RequestOption) (res *RouteBulkUpdateResponse, err error)
Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.
func (*RouteService) Delete ¶
func (r *RouteService) Delete(ctx context.Context, routeID string, body RouteDeleteParams, opts ...option.RequestOption) (res *RouteDeleteResponse, err error)
Disable and remove a specific Magic static route.
func (*RouteService) Empty ¶
func (r *RouteService) Empty(ctx context.Context, body RouteEmptyParams, opts ...option.RequestOption) (res *RouteEmptyResponse, err error)
Delete multiple Magic static routes.
func (*RouteService) Get ¶
func (r *RouteService) Get(ctx context.Context, routeID string, query RouteGetParams, opts ...option.RequestOption) (res *RouteGetResponse, err error)
Get a specific Magic static route.
func (*RouteService) List ¶
func (r *RouteService) List(ctx context.Context, query RouteListParams, opts ...option.RequestOption) (res *RouteListResponse, err error)
List all Magic static routes.
func (*RouteService) New ¶
func (r *RouteService) New(ctx context.Context, params RouteNewParams, opts ...option.RequestOption) (res *RouteNewResponse, err error)
Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
func (*RouteService) Update ¶
func (r *RouteService) Update(ctx context.Context, routeID string, params RouteUpdateParams, opts ...option.RequestOption) (res *RouteUpdateResponse, err error)
Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
type RouteUpdateParams ¶
type RouteUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The next-hop IP Address for the static route.
Nexthop param.Field[string] `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix param.Field[string] `json:"prefix,required"`
// Priority of the static route.
Priority param.Field[int64] `json:"priority,required"`
// An optional human provided description of the static route.
Description param.Field[string] `json:"description"`
// Used only for ECMP routes.
Scope param.Field[ScopeParam] `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight param.Field[int64] `json:"weight"`
}
func (RouteUpdateParams) MarshalJSON ¶
func (r RouteUpdateParams) MarshalJSON() (data []byte, err error)
type RouteUpdateResponse ¶
type RouteUpdateResponse struct {
Modified bool `json:"modified"`
ModifiedRoute RouteUpdateResponseModifiedRoute `json:"modified_route"`
JSON routeUpdateResponseJSON `json:"-"`
}
func (*RouteUpdateResponse) UnmarshalJSON ¶
func (r *RouteUpdateResponse) UnmarshalJSON(data []byte) (err error)
type RouteUpdateResponseEnvelope ¶
type RouteUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RouteUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success RouteUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON routeUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RouteUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RouteUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RouteUpdateResponseEnvelopeSuccess ¶
type RouteUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RouteUpdateResponseEnvelopeSuccessTrue RouteUpdateResponseEnvelopeSuccess = true
)
func (RouteUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RouteUpdateResponseEnvelopeSuccess) IsKnown() bool
type RouteUpdateResponseModifiedRoute ¶
type RouteUpdateResponseModifiedRoute struct {
// Identifier
ID string `json:"id,required"`
// The next-hop IP Address for the static route.
Nexthop string `json:"nexthop,required"`
// IP Prefix in Classless Inter-Domain Routing format.
Prefix string `json:"prefix,required"`
// Priority of the static route.
Priority int64 `json:"priority,required"`
// When the route was created.
CreatedOn time.Time `json:"created_on" format:"date-time"`
// An optional human provided description of the static route.
Description string `json:"description"`
// When the route was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
// Used only for ECMP routes.
Scope Scope `json:"scope"`
// Optional weight of the ECMP scope - if provided.
Weight int64 `json:"weight"`
JSON routeUpdateResponseModifiedRouteJSON `json:"-"`
}
func (*RouteUpdateResponseModifiedRoute) UnmarshalJSON ¶
func (r *RouteUpdateResponseModifiedRoute) UnmarshalJSON(data []byte) (err error)
type RoutedSubnet ¶
type RoutedSubnet struct {
// A valid IPv4 address.
NextHop string `json:"next_hop,required"`
// A valid CIDR notation representing an IP range.
Prefix string `json:"prefix,required"`
Nat Nat `json:"nat"`
JSON routedSubnetJSON `json:"-"`
}
func (*RoutedSubnet) UnmarshalJSON ¶
func (r *RoutedSubnet) UnmarshalJSON(data []byte) (err error)
type RoutedSubnetParam ¶
type RoutedSubnetParam struct {
// A valid IPv4 address.
NextHop param.Field[string] `json:"next_hop,required"`
// A valid CIDR notation representing an IP range.
Prefix param.Field[string] `json:"prefix,required"`
Nat param.Field[NatParam] `json:"nat"`
}
func (RoutedSubnetParam) MarshalJSON ¶
func (r RoutedSubnetParam) MarshalJSON() (data []byte, err error)
type Scope ¶
type Scope struct {
// List of colo names for the ECMP scope.
ColoNames []string `json:"colo_names"`
// List of colo regions for the ECMP scope.
ColoRegions []string `json:"colo_regions"`
JSON scopeJSON `json:"-"`
}
Used only for ECMP routes.
func (*Scope) UnmarshalJSON ¶
type ScopeParam ¶
type ScopeParam struct {
// List of colo names for the ECMP scope.
ColoNames param.Field[[]string] `json:"colo_names"`
// List of colo regions for the ECMP scope.
ColoRegions param.Field[[]string] `json:"colo_regions"`
}
Used only for ECMP routes.
func (ScopeParam) MarshalJSON ¶
func (r ScopeParam) MarshalJSON() (data []byte, err error)
type Site ¶
type Site struct {
// Identifier
ID string `json:"id"`
// Magic Connector identifier tag.
ConnectorID string `json:"connector_id"`
Description string `json:"description"`
// Site high availability mode. If set to true, the site can have two connectors
// and runs in high availability mode.
HaMode bool `json:"ha_mode"`
// Location of site in latitude and longitude.
Location SiteLocation `json:"location"`
// The name of the site.
Name string `json:"name"`
// Magic Connector identifier tag. Used when high availability mode is on.
SecondaryConnectorID string `json:"secondary_connector_id"`
JSON siteJSON `json:"-"`
}
func (*Site) UnmarshalJSON ¶
type SiteACLDeleteParams ¶
type SiteACLDeleteResponseEnvelope ¶
type SiteACLDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Bidirectional ACL policy for network traffic within a site.
Result ACL `json:"result,required"`
// Whether the API call was successful
Success SiteACLDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON siteACLDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SiteACLDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SiteACLDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteACLDeleteResponseEnvelopeSuccess ¶
type SiteACLDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteACLDeleteResponseEnvelopeSuccessTrue SiteACLDeleteResponseEnvelopeSuccess = true
)
func (SiteACLDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SiteACLDeleteResponseEnvelopeSuccess) IsKnown() bool
type SiteACLEditParams ¶
type SiteACLEditParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Description for the ACL.
Description param.Field[string] `json:"description"`
// The desired forwarding action for this ACL policy. If set to "false", the policy
// will forward traffic to Cloudflare. If set to "true", the policy will forward
// traffic locally on the Magic Connector. If not included in request, will default
// to false.
ForwardLocally param.Field[bool] `json:"forward_locally"`
LAN1 param.Field[ACLConfigurationParam] `json:"lan_1"`
LAN2 param.Field[ACLConfigurationParam] `json:"lan_2"`
// The name of the ACL.
Name param.Field[string] `json:"name"`
Protocols param.Field[[]AllowedProtocol] `json:"protocols"`
// The desired traffic direction for this ACL policy. If set to "false", the policy
// will allow bidirectional traffic. If set to "true", the policy will only allow
// traffic in one direction. If not included in request, will default to false.
Unidirectional param.Field[bool] `json:"unidirectional"`
}
func (SiteACLEditParams) MarshalJSON ¶
func (r SiteACLEditParams) MarshalJSON() (data []byte, err error)
type SiteACLEditResponseEnvelope ¶
type SiteACLEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Bidirectional ACL policy for network traffic within a site.
Result ACL `json:"result,required"`
// Whether the API call was successful
Success SiteACLEditResponseEnvelopeSuccess `json:"success,required"`
JSON siteACLEditResponseEnvelopeJSON `json:"-"`
}
func (*SiteACLEditResponseEnvelope) UnmarshalJSON ¶
func (r *SiteACLEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteACLEditResponseEnvelopeSuccess ¶
type SiteACLEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteACLEditResponseEnvelopeSuccessTrue SiteACLEditResponseEnvelopeSuccess = true
)
func (SiteACLEditResponseEnvelopeSuccess) IsKnown ¶
func (r SiteACLEditResponseEnvelopeSuccess) IsKnown() bool
type SiteACLGetParams ¶
type SiteACLGetResponseEnvelope ¶
type SiteACLGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Bidirectional ACL policy for network traffic within a site.
Result ACL `json:"result,required"`
// Whether the API call was successful
Success SiteACLGetResponseEnvelopeSuccess `json:"success,required"`
JSON siteACLGetResponseEnvelopeJSON `json:"-"`
}
func (*SiteACLGetResponseEnvelope) UnmarshalJSON ¶
func (r *SiteACLGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteACLGetResponseEnvelopeSuccess ¶
type SiteACLGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteACLGetResponseEnvelopeSuccessTrue SiteACLGetResponseEnvelopeSuccess = true
)
func (SiteACLGetResponseEnvelopeSuccess) IsKnown ¶
func (r SiteACLGetResponseEnvelopeSuccess) IsKnown() bool
type SiteACLListParams ¶
type SiteACLNewParams ¶
type SiteACLNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
LAN1 param.Field[ACLConfigurationParam] `json:"lan_1,required"`
LAN2 param.Field[ACLConfigurationParam] `json:"lan_2,required"`
// The name of the ACL.
Name param.Field[string] `json:"name,required"`
// Description for the ACL.
Description param.Field[string] `json:"description"`
// The desired forwarding action for this ACL policy. If set to "false", the policy
// will forward traffic to Cloudflare. If set to "true", the policy will forward
// traffic locally on the Magic Connector. If not included in request, will default
// to false.
ForwardLocally param.Field[bool] `json:"forward_locally"`
Protocols param.Field[[]AllowedProtocol] `json:"protocols"`
// The desired traffic direction for this ACL policy. If set to "false", the policy
// will allow bidirectional traffic. If set to "true", the policy will only allow
// traffic in one direction. If not included in request, will default to false.
Unidirectional param.Field[bool] `json:"unidirectional"`
}
func (SiteACLNewParams) MarshalJSON ¶
func (r SiteACLNewParams) MarshalJSON() (data []byte, err error)
type SiteACLNewResponseEnvelope ¶
type SiteACLNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Bidirectional ACL policy for network traffic within a site.
Result ACL `json:"result,required"`
// Whether the API call was successful
Success SiteACLNewResponseEnvelopeSuccess `json:"success,required"`
JSON siteACLNewResponseEnvelopeJSON `json:"-"`
}
func (*SiteACLNewResponseEnvelope) UnmarshalJSON ¶
func (r *SiteACLNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteACLNewResponseEnvelopeSuccess ¶
type SiteACLNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteACLNewResponseEnvelopeSuccessTrue SiteACLNewResponseEnvelopeSuccess = true
)
func (SiteACLNewResponseEnvelopeSuccess) IsKnown ¶
func (r SiteACLNewResponseEnvelopeSuccess) IsKnown() bool
type SiteACLService ¶
type SiteACLService struct {
Options []option.RequestOption
}
SiteACLService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSiteACLService method instead.
func NewSiteACLService ¶
func NewSiteACLService(opts ...option.RequestOption) (r *SiteACLService)
NewSiteACLService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SiteACLService) Delete ¶
func (r *SiteACLService) Delete(ctx context.Context, siteID string, aclID string, body SiteACLDeleteParams, opts ...option.RequestOption) (res *ACL, err error)
Remove a specific Site ACL.
func (*SiteACLService) Edit ¶
func (r *SiteACLService) Edit(ctx context.Context, siteID string, aclID string, params SiteACLEditParams, opts ...option.RequestOption) (res *ACL, err error)
Patch a specific Site ACL.
func (*SiteACLService) Get ¶
func (r *SiteACLService) Get(ctx context.Context, siteID string, aclID string, query SiteACLGetParams, opts ...option.RequestOption) (res *ACL, err error)
Get a specific Site ACL.
func (*SiteACLService) List ¶
func (r *SiteACLService) List(ctx context.Context, siteID string, query SiteACLListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ACL], err error)
Lists Site ACLs associated with an account.
func (*SiteACLService) ListAutoPaging ¶
func (r *SiteACLService) ListAutoPaging(ctx context.Context, siteID string, query SiteACLListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ACL]
Lists Site ACLs associated with an account.
func (*SiteACLService) New ¶
func (r *SiteACLService) New(ctx context.Context, siteID string, params SiteACLNewParams, opts ...option.RequestOption) (res *ACL, err error)
Creates a new Site ACL.
func (*SiteACLService) Update ¶
func (r *SiteACLService) Update(ctx context.Context, siteID string, aclID string, params SiteACLUpdateParams, opts ...option.RequestOption) (res *ACL, err error)
Update a specific Site ACL.
type SiteACLUpdateParams ¶
type SiteACLUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Description for the ACL.
Description param.Field[string] `json:"description"`
// The desired forwarding action for this ACL policy. If set to "false", the policy
// will forward traffic to Cloudflare. If set to "true", the policy will forward
// traffic locally on the Magic Connector. If not included in request, will default
// to false.
ForwardLocally param.Field[bool] `json:"forward_locally"`
LAN1 param.Field[ACLConfigurationParam] `json:"lan_1"`
LAN2 param.Field[ACLConfigurationParam] `json:"lan_2"`
// The name of the ACL.
Name param.Field[string] `json:"name"`
Protocols param.Field[[]AllowedProtocol] `json:"protocols"`
// The desired traffic direction for this ACL policy. If set to "false", the policy
// will allow bidirectional traffic. If set to "true", the policy will only allow
// traffic in one direction. If not included in request, will default to false.
Unidirectional param.Field[bool] `json:"unidirectional"`
}
func (SiteACLUpdateParams) MarshalJSON ¶
func (r SiteACLUpdateParams) MarshalJSON() (data []byte, err error)
type SiteACLUpdateResponseEnvelope ¶
type SiteACLUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Bidirectional ACL policy for network traffic within a site.
Result ACL `json:"result,required"`
// Whether the API call was successful
Success SiteACLUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON siteACLUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SiteACLUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SiteACLUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteACLUpdateResponseEnvelopeSuccess ¶
type SiteACLUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteACLUpdateResponseEnvelopeSuccessTrue SiteACLUpdateResponseEnvelopeSuccess = true
)
func (SiteACLUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SiteACLUpdateResponseEnvelopeSuccess) IsKnown() bool
type SiteDeleteParams ¶
type SiteDeleteResponseEnvelope ¶
type SiteDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Site `json:"result,required"`
// Whether the API call was successful
Success SiteDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON siteDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SiteDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SiteDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteDeleteResponseEnvelopeSuccess ¶
type SiteDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteDeleteResponseEnvelopeSuccessTrue SiteDeleteResponseEnvelopeSuccess = true
)
func (SiteDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SiteDeleteResponseEnvelopeSuccess) IsKnown() bool
type SiteEditParams ¶
type SiteEditParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Magic Connector identifier tag.
ConnectorID param.Field[string] `json:"connector_id"`
Description param.Field[string] `json:"description"`
// Location of site in latitude and longitude.
Location param.Field[SiteLocationParam] `json:"location"`
// The name of the site.
Name param.Field[string] `json:"name"`
// Magic Connector identifier tag. Used when high availability mode is on.
SecondaryConnectorID param.Field[string] `json:"secondary_connector_id"`
}
func (SiteEditParams) MarshalJSON ¶
func (r SiteEditParams) MarshalJSON() (data []byte, err error)
type SiteEditResponseEnvelope ¶
type SiteEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Site `json:"result,required"`
// Whether the API call was successful
Success SiteEditResponseEnvelopeSuccess `json:"success,required"`
JSON siteEditResponseEnvelopeJSON `json:"-"`
}
func (*SiteEditResponseEnvelope) UnmarshalJSON ¶
func (r *SiteEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteEditResponseEnvelopeSuccess ¶
type SiteEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteEditResponseEnvelopeSuccessTrue SiteEditResponseEnvelopeSuccess = true
)
func (SiteEditResponseEnvelopeSuccess) IsKnown ¶
func (r SiteEditResponseEnvelopeSuccess) IsKnown() bool
type SiteGetParams ¶
type SiteGetResponseEnvelope ¶
type SiteGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Site `json:"result,required"`
// Whether the API call was successful
Success SiteGetResponseEnvelopeSuccess `json:"success,required"`
JSON siteGetResponseEnvelopeJSON `json:"-"`
}
func (*SiteGetResponseEnvelope) UnmarshalJSON ¶
func (r *SiteGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteGetResponseEnvelopeSuccess ¶
type SiteGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteGetResponseEnvelopeSuccessTrue SiteGetResponseEnvelopeSuccess = true
)
func (SiteGetResponseEnvelopeSuccess) IsKnown ¶
func (r SiteGetResponseEnvelopeSuccess) IsKnown() bool
type SiteLANDeleteParams ¶
type SiteLANDeleteResponseEnvelope ¶
type SiteLANDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result LAN `json:"result,required"`
// Whether the API call was successful
Success SiteLANDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON siteLANDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SiteLANDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SiteLANDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteLANDeleteResponseEnvelopeSuccess ¶
type SiteLANDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteLANDeleteResponseEnvelopeSuccessTrue SiteLANDeleteResponseEnvelopeSuccess = true
)
func (SiteLANDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SiteLANDeleteResponseEnvelopeSuccess) IsKnown() bool
type SiteLANEditParams ¶
type SiteLANEditParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Name param.Field[string] `json:"name"`
Nat param.Field[NatParam] `json:"nat"`
Physport param.Field[int64] `json:"physport"`
RoutedSubnets param.Field[[]RoutedSubnetParam] `json:"routed_subnets"`
// If the site is not configured in high availability mode, this configuration is
// optional (if omitted, use DHCP). However, if in high availability mode,
// static_address is required along with secondary and virtual address.
StaticAddressing param.Field[LANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteLANEditParams) MarshalJSON ¶
func (r SiteLANEditParams) MarshalJSON() (data []byte, err error)
type SiteLANEditResponseEnvelope ¶
type SiteLANEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result LAN `json:"result,required"`
// Whether the API call was successful
Success SiteLANEditResponseEnvelopeSuccess `json:"success,required"`
JSON siteLANEditResponseEnvelopeJSON `json:"-"`
}
func (*SiteLANEditResponseEnvelope) UnmarshalJSON ¶
func (r *SiteLANEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteLANEditResponseEnvelopeSuccess ¶
type SiteLANEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteLANEditResponseEnvelopeSuccessTrue SiteLANEditResponseEnvelopeSuccess = true
)
func (SiteLANEditResponseEnvelopeSuccess) IsKnown ¶
func (r SiteLANEditResponseEnvelopeSuccess) IsKnown() bool
type SiteLANGetParams ¶
type SiteLANGetResponseEnvelope ¶
type SiteLANGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result LAN `json:"result,required"`
// Whether the API call was successful
Success SiteLANGetResponseEnvelopeSuccess `json:"success,required"`
JSON siteLANGetResponseEnvelopeJSON `json:"-"`
}
func (*SiteLANGetResponseEnvelope) UnmarshalJSON ¶
func (r *SiteLANGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteLANGetResponseEnvelopeSuccess ¶
type SiteLANGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteLANGetResponseEnvelopeSuccessTrue SiteLANGetResponseEnvelopeSuccess = true
)
func (SiteLANGetResponseEnvelopeSuccess) IsKnown ¶
func (r SiteLANGetResponseEnvelopeSuccess) IsKnown() bool
type SiteLANListParams ¶
type SiteLANNewParams ¶
type SiteLANNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Physport param.Field[int64] `json:"physport,required"`
// mark true to use this LAN for HA probing. only works for site with HA turned on.
// only one LAN can be set as the ha_link.
HaLink param.Field[bool] `json:"ha_link"`
Name param.Field[string] `json:"name"`
Nat param.Field[NatParam] `json:"nat"`
RoutedSubnets param.Field[[]RoutedSubnetParam] `json:"routed_subnets"`
// If the site is not configured in high availability mode, this configuration is
// optional (if omitted, use DHCP). However, if in high availability mode,
// static_address is required along with secondary and virtual address.
StaticAddressing param.Field[LANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteLANNewParams) MarshalJSON ¶
func (r SiteLANNewParams) MarshalJSON() (data []byte, err error)
type SiteLANService ¶
type SiteLANService struct {
Options []option.RequestOption
}
SiteLANService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSiteLANService method instead.
func NewSiteLANService ¶
func NewSiteLANService(opts ...option.RequestOption) (r *SiteLANService)
NewSiteLANService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SiteLANService) Delete ¶
func (r *SiteLANService) Delete(ctx context.Context, siteID string, lanID string, body SiteLANDeleteParams, opts ...option.RequestOption) (res *LAN, err error)
Remove a specific Site LAN.
func (*SiteLANService) Edit ¶
func (r *SiteLANService) Edit(ctx context.Context, siteID string, lanID string, params SiteLANEditParams, opts ...option.RequestOption) (res *LAN, err error)
Patch a specific Site LAN.
func (*SiteLANService) Get ¶
func (r *SiteLANService) Get(ctx context.Context, siteID string, lanID string, query SiteLANGetParams, opts ...option.RequestOption) (res *LAN, err error)
Get a specific Site LAN.
func (*SiteLANService) List ¶
func (r *SiteLANService) List(ctx context.Context, siteID string, query SiteLANListParams, opts ...option.RequestOption) (res *pagination.SinglePage[LAN], err error)
Lists Site LANs associated with an account.
func (*SiteLANService) ListAutoPaging ¶
func (r *SiteLANService) ListAutoPaging(ctx context.Context, siteID string, query SiteLANListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[LAN]
Lists Site LANs associated with an account.
func (*SiteLANService) New ¶
func (r *SiteLANService) New(ctx context.Context, siteID string, params SiteLANNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[LAN], err error)
Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
func (*SiteLANService) NewAutoPaging ¶ added in v4.1.0
func (r *SiteLANService) NewAutoPaging(ctx context.Context, siteID string, params SiteLANNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[LAN]
Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
func (*SiteLANService) Update ¶
func (r *SiteLANService) Update(ctx context.Context, siteID string, lanID string, params SiteLANUpdateParams, opts ...option.RequestOption) (res *LAN, err error)
Update a specific Site LAN.
type SiteLANUpdateParams ¶
type SiteLANUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Name param.Field[string] `json:"name"`
Nat param.Field[NatParam] `json:"nat"`
Physport param.Field[int64] `json:"physport"`
RoutedSubnets param.Field[[]RoutedSubnetParam] `json:"routed_subnets"`
// If the site is not configured in high availability mode, this configuration is
// optional (if omitted, use DHCP). However, if in high availability mode,
// static_address is required along with secondary and virtual address.
StaticAddressing param.Field[LANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteLANUpdateParams) MarshalJSON ¶
func (r SiteLANUpdateParams) MarshalJSON() (data []byte, err error)
type SiteLANUpdateResponseEnvelope ¶
type SiteLANUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result LAN `json:"result,required"`
// Whether the API call was successful
Success SiteLANUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON siteLANUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SiteLANUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SiteLANUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteLANUpdateResponseEnvelopeSuccess ¶
type SiteLANUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteLANUpdateResponseEnvelopeSuccessTrue SiteLANUpdateResponseEnvelopeSuccess = true
)
func (SiteLANUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SiteLANUpdateResponseEnvelopeSuccess) IsKnown() bool
type SiteListParams ¶
type SiteListParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Identifier
Connectorid param.Field[string] `query:"connectorid"`
}
func (SiteListParams) URLQuery ¶
func (r SiteListParams) URLQuery() (v url.Values)
URLQuery serializes SiteListParams's query parameters as `url.Values`.
type SiteLocation ¶
type SiteLocation struct {
// Latitude
Lat string `json:"lat"`
// Longitude
Lon string `json:"lon"`
JSON siteLocationJSON `json:"-"`
}
Location of site in latitude and longitude.
func (*SiteLocation) UnmarshalJSON ¶
func (r *SiteLocation) UnmarshalJSON(data []byte) (err error)
type SiteLocationParam ¶
type SiteLocationParam struct {
// Latitude
Lat param.Field[string] `json:"lat"`
// Longitude
Lon param.Field[string] `json:"lon"`
}
Location of site in latitude and longitude.
func (SiteLocationParam) MarshalJSON ¶
func (r SiteLocationParam) MarshalJSON() (data []byte, err error)
type SiteNewParams ¶
type SiteNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The name of the site.
Name param.Field[string] `json:"name,required"`
// Magic Connector identifier tag.
ConnectorID param.Field[string] `json:"connector_id"`
Description param.Field[string] `json:"description"`
// Site high availability mode. If set to true, the site can have two connectors
// and runs in high availability mode.
HaMode param.Field[bool] `json:"ha_mode"`
// Location of site in latitude and longitude.
Location param.Field[SiteLocationParam] `json:"location"`
// Magic Connector identifier tag. Used when high availability mode is on.
SecondaryConnectorID param.Field[string] `json:"secondary_connector_id"`
}
func (SiteNewParams) MarshalJSON ¶
func (r SiteNewParams) MarshalJSON() (data []byte, err error)
type SiteNewResponseEnvelope ¶
type SiteNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Site `json:"result,required"`
// Whether the API call was successful
Success SiteNewResponseEnvelopeSuccess `json:"success,required"`
JSON siteNewResponseEnvelopeJSON `json:"-"`
}
func (*SiteNewResponseEnvelope) UnmarshalJSON ¶
func (r *SiteNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteNewResponseEnvelopeSuccess ¶
type SiteNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteNewResponseEnvelopeSuccessTrue SiteNewResponseEnvelopeSuccess = true
)
func (SiteNewResponseEnvelopeSuccess) IsKnown ¶
func (r SiteNewResponseEnvelopeSuccess) IsKnown() bool
type SiteService ¶
type SiteService struct {
Options []option.RequestOption
ACLs *SiteACLService
LANs *SiteLANService
WANs *SiteWANService
}
SiteService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSiteService method instead.
func NewSiteService ¶
func NewSiteService(opts ...option.RequestOption) (r *SiteService)
NewSiteService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SiteService) Delete ¶
func (r *SiteService) Delete(ctx context.Context, siteID string, body SiteDeleteParams, opts ...option.RequestOption) (res *Site, err error)
Remove a specific Site.
func (*SiteService) Edit ¶
func (r *SiteService) Edit(ctx context.Context, siteID string, params SiteEditParams, opts ...option.RequestOption) (res *Site, err error)
Patch a specific Site.
func (*SiteService) Get ¶
func (r *SiteService) Get(ctx context.Context, siteID string, params SiteGetParams, opts ...option.RequestOption) (res *Site, err error)
Get a specific Site.
func (*SiteService) List ¶
func (r *SiteService) List(ctx context.Context, params SiteListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Site], err error)
Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.
func (*SiteService) ListAutoPaging ¶
func (r *SiteService) ListAutoPaging(ctx context.Context, params SiteListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Site]
Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.
func (*SiteService) New ¶
func (r *SiteService) New(ctx context.Context, params SiteNewParams, opts ...option.RequestOption) (res *Site, err error)
Creates a new Site
func (*SiteService) Update ¶
func (r *SiteService) Update(ctx context.Context, siteID string, params SiteUpdateParams, opts ...option.RequestOption) (res *Site, err error)
Update a specific Site.
type SiteUpdateParams ¶
type SiteUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Magic Connector identifier tag.
ConnectorID param.Field[string] `json:"connector_id"`
Description param.Field[string] `json:"description"`
// Location of site in latitude and longitude.
Location param.Field[SiteLocationParam] `json:"location"`
// The name of the site.
Name param.Field[string] `json:"name"`
// Magic Connector identifier tag. Used when high availability mode is on.
SecondaryConnectorID param.Field[string] `json:"secondary_connector_id"`
}
func (SiteUpdateParams) MarshalJSON ¶
func (r SiteUpdateParams) MarshalJSON() (data []byte, err error)
type SiteUpdateResponseEnvelope ¶
type SiteUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Site `json:"result,required"`
// Whether the API call was successful
Success SiteUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON siteUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SiteUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SiteUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteUpdateResponseEnvelopeSuccess ¶
type SiteUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteUpdateResponseEnvelopeSuccessTrue SiteUpdateResponseEnvelopeSuccess = true
)
func (SiteUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SiteUpdateResponseEnvelopeSuccess) IsKnown() bool
type SiteWANDeleteParams ¶
type SiteWANDeleteResponseEnvelope ¶
type SiteWANDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result WAN `json:"result,required"`
// Whether the API call was successful
Success SiteWANDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON siteWANDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SiteWANDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SiteWANDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteWANDeleteResponseEnvelopeSuccess ¶
type SiteWANDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteWANDeleteResponseEnvelopeSuccessTrue SiteWANDeleteResponseEnvelopeSuccess = true
)
func (SiteWANDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SiteWANDeleteResponseEnvelopeSuccess) IsKnown() bool
type SiteWANEditParams ¶
type SiteWANEditParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Name param.Field[string] `json:"name"`
Physport param.Field[int64] `json:"physport"`
Priority param.Field[int64] `json:"priority"`
// (optional) if omitted, use DHCP. Submit secondary_address when site is in high
// availability mode.
StaticAddressing param.Field[WANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteWANEditParams) MarshalJSON ¶
func (r SiteWANEditParams) MarshalJSON() (data []byte, err error)
type SiteWANEditResponseEnvelope ¶
type SiteWANEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result WAN `json:"result,required"`
// Whether the API call was successful
Success SiteWANEditResponseEnvelopeSuccess `json:"success,required"`
JSON siteWANEditResponseEnvelopeJSON `json:"-"`
}
func (*SiteWANEditResponseEnvelope) UnmarshalJSON ¶
func (r *SiteWANEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteWANEditResponseEnvelopeSuccess ¶
type SiteWANEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteWANEditResponseEnvelopeSuccessTrue SiteWANEditResponseEnvelopeSuccess = true
)
func (SiteWANEditResponseEnvelopeSuccess) IsKnown ¶
func (r SiteWANEditResponseEnvelopeSuccess) IsKnown() bool
type SiteWANGetParams ¶
type SiteWANGetResponseEnvelope ¶
type SiteWANGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result WAN `json:"result,required"`
// Whether the API call was successful
Success SiteWANGetResponseEnvelopeSuccess `json:"success,required"`
JSON siteWANGetResponseEnvelopeJSON `json:"-"`
}
func (*SiteWANGetResponseEnvelope) UnmarshalJSON ¶
func (r *SiteWANGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteWANGetResponseEnvelopeSuccess ¶
type SiteWANGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteWANGetResponseEnvelopeSuccessTrue SiteWANGetResponseEnvelopeSuccess = true
)
func (SiteWANGetResponseEnvelopeSuccess) IsKnown ¶
func (r SiteWANGetResponseEnvelopeSuccess) IsKnown() bool
type SiteWANListParams ¶
type SiteWANNewParams ¶
type SiteWANNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Physport param.Field[int64] `json:"physport,required"`
Name param.Field[string] `json:"name"`
Priority param.Field[int64] `json:"priority"`
// (optional) if omitted, use DHCP. Submit secondary_address when site is in high
// availability mode.
StaticAddressing param.Field[WANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteWANNewParams) MarshalJSON ¶
func (r SiteWANNewParams) MarshalJSON() (data []byte, err error)
type SiteWANService ¶
type SiteWANService struct {
Options []option.RequestOption
}
SiteWANService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSiteWANService method instead.
func NewSiteWANService ¶
func NewSiteWANService(opts ...option.RequestOption) (r *SiteWANService)
NewSiteWANService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SiteWANService) Delete ¶
func (r *SiteWANService) Delete(ctx context.Context, siteID string, wanID string, body SiteWANDeleteParams, opts ...option.RequestOption) (res *WAN, err error)
Remove a specific Site WAN.
func (*SiteWANService) Edit ¶
func (r *SiteWANService) Edit(ctx context.Context, siteID string, wanID string, params SiteWANEditParams, opts ...option.RequestOption) (res *WAN, err error)
Patch a specific Site WAN.
func (*SiteWANService) Get ¶
func (r *SiteWANService) Get(ctx context.Context, siteID string, wanID string, query SiteWANGetParams, opts ...option.RequestOption) (res *WAN, err error)
Get a specific Site WAN.
func (*SiteWANService) List ¶
func (r *SiteWANService) List(ctx context.Context, siteID string, query SiteWANListParams, opts ...option.RequestOption) (res *pagination.SinglePage[WAN], err error)
Lists Site WANs associated with an account.
func (*SiteWANService) ListAutoPaging ¶
func (r *SiteWANService) ListAutoPaging(ctx context.Context, siteID string, query SiteWANListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[WAN]
Lists Site WANs associated with an account.
func (*SiteWANService) New ¶
func (r *SiteWANService) New(ctx context.Context, siteID string, params SiteWANNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[WAN], err error)
Creates a new Site WAN.
func (*SiteWANService) NewAutoPaging ¶ added in v4.1.0
func (r *SiteWANService) NewAutoPaging(ctx context.Context, siteID string, params SiteWANNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[WAN]
Creates a new Site WAN.
func (*SiteWANService) Update ¶
func (r *SiteWANService) Update(ctx context.Context, siteID string, wanID string, params SiteWANUpdateParams, opts ...option.RequestOption) (res *WAN, err error)
Update a specific Site WAN.
type SiteWANUpdateParams ¶
type SiteWANUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Name param.Field[string] `json:"name"`
Physport param.Field[int64] `json:"physport"`
Priority param.Field[int64] `json:"priority"`
// (optional) if omitted, use DHCP. Submit secondary_address when site is in high
// availability mode.
StaticAddressing param.Field[WANStaticAddressingParam] `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag param.Field[int64] `json:"vlan_tag"`
}
func (SiteWANUpdateParams) MarshalJSON ¶
func (r SiteWANUpdateParams) MarshalJSON() (data []byte, err error)
type SiteWANUpdateResponseEnvelope ¶
type SiteWANUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result WAN `json:"result,required"`
// Whether the API call was successful
Success SiteWANUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON siteWANUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SiteWANUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SiteWANUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SiteWANUpdateResponseEnvelopeSuccess ¶
type SiteWANUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SiteWANUpdateResponseEnvelopeSuccessTrue SiteWANUpdateResponseEnvelopeSuccess = true
)
func (SiteWANUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SiteWANUpdateResponseEnvelopeSuccess) IsKnown() bool
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubnetParam ¶
type SubnetParam = string
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
type WAN ¶
type WAN struct {
// Identifier
ID string `json:"id"`
// Magic WAN health check rate for tunnels created on this link. The default value
// is `mid`.
HealthCheckRate WANHealthCheckRate `json:"health_check_rate"`
Name string `json:"name"`
Physport int64 `json:"physport"`
// Priority of WAN for traffic loadbalancing.
Priority int64 `json:"priority"`
// Identifier
SiteID string `json:"site_id"`
// (optional) if omitted, use DHCP. Submit secondary_address when site is in high
// availability mode.
StaticAddressing WANStaticAddressing `json:"static_addressing"`
// VLAN ID. Use zero for untagged.
VlanTag int64 `json:"vlan_tag"`
JSON wanJSON `json:"-"`
}
func (*WAN) UnmarshalJSON ¶
type WANHealthCheckRate ¶
type WANHealthCheckRate string
Magic WAN health check rate for tunnels created on this link. The default value is `mid`.
const ( WANHealthCheckRateLow WANHealthCheckRate = "low" WANHealthCheckRateMid WANHealthCheckRate = "mid" WANHealthCheckRateHigh WANHealthCheckRate = "high" )
func (WANHealthCheckRate) IsKnown ¶
func (r WANHealthCheckRate) IsKnown() bool
type WANStaticAddressing ¶
type WANStaticAddressing struct {
// A valid CIDR notation representing an IP range.
Address string `json:"address,required"`
// A valid IPv4 address.
GatewayAddress string `json:"gateway_address,required"`
// A valid CIDR notation representing an IP range.
SecondaryAddress string `json:"secondary_address"`
JSON wanStaticAddressingJSON `json:"-"`
}
(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
func (*WANStaticAddressing) UnmarshalJSON ¶
func (r *WANStaticAddressing) UnmarshalJSON(data []byte) (err error)
type WANStaticAddressingParam ¶
type WANStaticAddressingParam struct {
// A valid CIDR notation representing an IP range.
Address param.Field[string] `json:"address,required"`
// A valid IPv4 address.
GatewayAddress param.Field[string] `json:"gateway_address,required"`
// A valid CIDR notation representing an IP range.
SecondaryAddress param.Field[string] `json:"secondary_address"`
}
(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
func (WANStaticAddressingParam) MarshalJSON ¶
func (r WANStaticAddressingParam) MarshalJSON() (data []byte, err error)