directlinkv1

package
v0.51.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2025 License: Apache-2.0 Imports: 10 Imported by: 7

Documentation

Overview

Package directlinkv1 : Operations and models for the DirectLinkV1 service

Index

Constants

View Source
const (
	AsPrepend_Policy_Export = "export"
	AsPrepend_Policy_Import = "import"
)

Constants associated with the AsPrepend.Policy property. Route type this AS Prepend applies to.

View Source
const (
	AsPrependEntry_Policy_Export = "export"
	AsPrependEntry_Policy_Import = "import"
)

Constants associated with the AsPrependEntry.Policy property. Route type this AS Prepend applies to.

View Source
const (
	AsPrependPrefixArrayTemplate_Policy_Export = "export"
	AsPrependPrefixArrayTemplate_Policy_Import = "import"
)

Constants associated with the AsPrependPrefixArrayTemplate.Policy property. Route type this AS Prepend applies to.

View Source
const (
	AsPrependTemplate_Policy_Export = "export"
	AsPrependTemplate_Policy_Import = "import"
)

Constants associated with the AsPrependTemplate.Policy property. Route type this AS Prepend applies to.

View Source
const (
	CreateGatewayActionOptions_Action_CreateGatewayApprove    = "create_gateway_approve"
	CreateGatewayActionOptions_Action_CreateGatewayReject     = "create_gateway_reject"
	CreateGatewayActionOptions_Action_DeleteGatewayApprove    = "delete_gateway_approve"
	CreateGatewayActionOptions_Action_DeleteGatewayReject     = "delete_gateway_reject"
	CreateGatewayActionOptions_Action_UpdateAttributesApprove = "update_attributes_approve"
	CreateGatewayActionOptions_Action_UpdateAttributesReject  = "update_attributes_reject"
)

Constants associated with the CreateGatewayActionOptions.Action property. Action request.

View Source
const (
	CreateGatewayActionOptions_ConnectionMode_Direct  = "direct"
	CreateGatewayActionOptions_ConnectionMode_Transit = "transit"
)

Constants associated with the CreateGatewayActionOptions.ConnectionMode property. Applicable for create_gateway_approve requests to select the type of services this gateway is attached to. Mode transit indicates this gateway will be attached to Transit Gateway Service and direct means this gateway will be attached to vpc or classic connection. If unspecified on create_gateway_approve, default value direct is used. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	CreateGatewayActionOptions_DefaultExportRouteFilter_Deny   = "deny"
	CreateGatewayActionOptions_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the CreateGatewayActionOptions.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	CreateGatewayActionOptions_DefaultImportRouteFilter_Deny   = "deny"
	CreateGatewayActionOptions_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the CreateGatewayActionOptions.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	CreateGatewayExportRouteFilterOptions_Action_Deny   = "deny"
	CreateGatewayExportRouteFilterOptions_Action_Permit = "permit"
)

Constants associated with the CreateGatewayExportRouteFilterOptions.Action property. Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.

View Source
const (
	CreateGatewayImportRouteFilterOptions_Action_Deny   = "deny"
	CreateGatewayImportRouteFilterOptions_Action_Permit = "permit"
)

Constants associated with the CreateGatewayImportRouteFilterOptions.Action property. Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.

View Source
const (
	CreateGatewayMacsecCakOptions_Session_Fallback = "fallback"
	CreateGatewayMacsecCakOptions_Session_Primary  = "primary"
)

Constants associated with the CreateGatewayMacsecCakOptions.Session property. The intended session the key will be used to secure.

If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take over.

There must be a `primary` session CAK. A `fallback` CAK is optional.

View Source
const (
	CreateGatewayVirtualConnectionOptions_Type_Classic = "classic"
	CreateGatewayVirtualConnectionOptions_Type_Vpc     = "vpc"
)

Constants associated with the CreateGatewayVirtualConnectionOptions.Type property. The type of virtual connection.

View Source
const (
	Gateway_BgpStatus_Active      = "active"
	Gateway_BgpStatus_Connect     = "connect"
	Gateway_BgpStatus_Established = "established"
	Gateway_BgpStatus_Idle        = "idle"
)

Constants associated with the Gateway.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	Gateway_ConnectionMode_Direct  = "direct"
	Gateway_ConnectionMode_Transit = "transit"
)

Constants associated with the Gateway.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	Gateway_DefaultExportRouteFilter_Deny   = "deny"
	Gateway_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the Gateway.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	Gateway_DefaultImportRouteFilter_Deny   = "deny"
	Gateway_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the Gateway.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	Gateway_LinkStatus_Down = "down"
	Gateway_LinkStatus_Up   = "up"
)

Constants associated with the Gateway.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	Gateway_MacsecCapability_Macsec         = "macsec"
	Gateway_MacsecCapability_MacsecOptional = "macsec_optional"
	Gateway_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the Gateway.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

Only included on type=dedicated direct links.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

View Source
const (
	Gateway_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	Gateway_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	Gateway_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	Gateway_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	Gateway_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	Gateway_OperationalStatus_Configuring              = "configuring"
	Gateway_OperationalStatus_CreatePending            = "create_pending"
	Gateway_OperationalStatus_CreateRejected           = "create_rejected"
	Gateway_OperationalStatus_DeletePending            = "delete_pending"
	Gateway_OperationalStatus_Failed                   = "failed"
	Gateway_OperationalStatus_LoaAccepted              = "loa_accepted"
	Gateway_OperationalStatus_LoaCreated               = "loa_created"
	Gateway_OperationalStatus_LoaRejected              = "loa_rejected"
	Gateway_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the Gateway.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.

View Source
const (
	Gateway_Type_Connect   = "connect"
	Gateway_Type_Dedicated = "dedicated"
)

Constants associated with the Gateway.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayBfdConfig_BfdStatus_Down = "down"
	GatewayBfdConfig_BfdStatus_Init = "init"
	GatewayBfdConfig_BfdStatus_Up   = "up"
)

Constants associated with the GatewayBfdConfig.BfdStatus property. Gateway BFD status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItem_BgpStatus_Active      = "active"
	GatewayCollectionGatewaysItem_BgpStatus_Connect     = "connect"
	GatewayCollectionGatewaysItem_BgpStatus_Established = "established"
	GatewayCollectionGatewaysItem_BgpStatus_Idle        = "idle"
)

Constants associated with the GatewayCollectionGatewaysItem.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItem_ConnectionMode_Direct  = "direct"
	GatewayCollectionGatewaysItem_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayCollectionGatewaysItem.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItem_DefaultExportRouteFilter_Deny   = "deny"
	GatewayCollectionGatewaysItem_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayCollectionGatewaysItem.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayCollectionGatewaysItem_DefaultImportRouteFilter_Deny   = "deny"
	GatewayCollectionGatewaysItem_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayCollectionGatewaysItem.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayCollectionGatewaysItem_LinkStatus_Down = "down"
	GatewayCollectionGatewaysItem_LinkStatus_Up   = "up"
)

Constants associated with the GatewayCollectionGatewaysItem.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItem_MacsecCapability_Macsec         = "macsec"
	GatewayCollectionGatewaysItem_MacsecCapability_MacsecOptional = "macsec_optional"
	GatewayCollectionGatewaysItem_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GatewayCollectionGatewaysItem.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

Only included on type=dedicated direct links.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

View Source
const (
	GatewayCollectionGatewaysItem_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GatewayCollectionGatewaysItem_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GatewayCollectionGatewaysItem_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GatewayCollectionGatewaysItem_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GatewayCollectionGatewaysItem_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GatewayCollectionGatewaysItem_OperationalStatus_Configuring              = "configuring"
	GatewayCollectionGatewaysItem_OperationalStatus_CreatePending            = "create_pending"
	GatewayCollectionGatewaysItem_OperationalStatus_CreateRejected           = "create_rejected"
	GatewayCollectionGatewaysItem_OperationalStatus_DeletePending            = "delete_pending"
	GatewayCollectionGatewaysItem_OperationalStatus_Failed                   = "failed"
	GatewayCollectionGatewaysItem_OperationalStatus_LoaAccepted              = "loa_accepted"
	GatewayCollectionGatewaysItem_OperationalStatus_LoaCreated               = "loa_created"
	GatewayCollectionGatewaysItem_OperationalStatus_LoaRejected              = "loa_rejected"
	GatewayCollectionGatewaysItem_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GatewayCollectionGatewaysItem.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.

View Source
const (
	GatewayCollectionGatewaysItem_Type_Connect   = "connect"
	GatewayCollectionGatewaysItem_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayCollectionGatewaysItem.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayMacsec_SecurityPolicy_MustSecure   = "must_secure"
	GatewayMacsec_SecurityPolicy_ShouldSecure = "should_secure"
)

Constants associated with the GatewayMacsec.SecurityPolicy property. Determines how packets without MACsec headers are handled.

`must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.

View Source
const (
	GatewayMacsec_Status_Deleting = "deleting"
	GatewayMacsec_Status_Failed   = "failed"
	GatewayMacsec_Status_Init     = "init"
	GatewayMacsec_Status_Offline  = "offline"
	GatewayMacsec_Status_Pending  = "pending"
	GatewayMacsec_Status_Secured  = "secured"
)

Constants associated with the GatewayMacsec.Status property. Current status of MACsec on this direct link.

Status `offline` is returned when MACsec is inactive and during direct link creation.

Status `deleting` is returned when MACsec during removal of MACsec from the direct link and during direct link deletion.

See `status_reasons[]` for possible remediation of the `failed` `status`.

View Source
const (
	GatewayMacsecCak_Session_Fallback = "fallback"
	GatewayMacsecCak_Session_Primary  = "primary"
)

Constants associated with the GatewayMacsecCak.Session property. The intended session the key will be used to secure.

If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take over.

There must be a `primary` session CAK. A `fallback` CAK is optional.

View Source
const (
	GatewayMacsecCak_Status_Active      = "active"
	GatewayMacsecCak_Status_Failed      = "failed"
	GatewayMacsecCak_Status_Operational = "operational"
	GatewayMacsecCak_Status_Rotating    = "rotating"
)

Constants associated with the GatewayMacsecCak.Status property. Current status of the CAK.

Status `operational` is returned when the CAK is configured successfully.

Status `active` is returned when the CAK is configured successfully and is currently used to secure the MACsec session.

Status `rotating` is returned during a key rotation. The CAK defined by `active_delta` is securing the MACsec session. The status will remain `rotating` until the new key is `active`.

Status `failed` is returned when the CAK cannot be configured. To recover, first resolve any issues with your HPCS key, then patch this CAK with the same or new key. Alternatively, you can delete this CAK if used for the `fallback` session.

View Source
const (
	GatewayMacsecCakPrototype_Session_Fallback = "fallback"
	GatewayMacsecCakPrototype_Session_Primary  = "primary"
)

Constants associated with the GatewayMacsecCakPrototype.Session property. The intended session the key will be used to secure.

If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take over.

There must be a `primary` session CAK. A `fallback` CAK is optional.

View Source
const (
	GatewayMacsecPatch_SecurityPolicy_MustSecure   = "must_secure"
	GatewayMacsecPatch_SecurityPolicy_ShouldSecure = "should_secure"
)

Constants associated with the GatewayMacsecPatch.SecurityPolicy property. Determines how packets without MACsec headers are handled.

`must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.

View Source
const (
	GatewayMacsecPrototype_SecurityPolicy_MustSecure   = "must_secure"
	GatewayMacsecPrototype_SecurityPolicy_ShouldSecure = "should_secure"
)

Constants associated with the GatewayMacsecPrototype.SecurityPolicy property. Determines how packets without MACsec headers are handled.

`must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.

View Source
const (
	GatewayMacsecReference_SecurityPolicy_MustSecure   = "must_secure"
	GatewayMacsecReference_SecurityPolicy_ShouldSecure = "should_secure"
)

Constants associated with the GatewayMacsecReference.SecurityPolicy property. Determines how packets without MACsec headers are handled.

`must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.

View Source
const (
	GatewayMacsecReference_Status_Deleting = "deleting"
	GatewayMacsecReference_Status_Failed   = "failed"
	GatewayMacsecReference_Status_Init     = "init"
	GatewayMacsecReference_Status_Offline  = "offline"
	GatewayMacsecReference_Status_Pending  = "pending"
	GatewayMacsecReference_Status_Secured  = "secured"
)

Constants associated with the GatewayMacsecReference.Status property. Current status of MACsec on this direct link.

Status `offline` is returned when MACsec is inactive and during direct link creation.

Status `deleting` is returned when MACsec during removal of MACsec from the direct link and during direct link deletion.

See `status_reasons[]` for possible remediation of the `failed` `status`.

View Source
const (
	GatewayPatchTemplate_ConnectionMode_Direct  = "direct"
	GatewayPatchTemplate_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayPatchTemplate.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayPatchTemplate_DefaultExportRouteFilter_Deny   = "deny"
	GatewayPatchTemplate_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayPatchTemplate.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayPatchTemplate_DefaultImportRouteFilter_Deny   = "deny"
	GatewayPatchTemplate_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayPatchTemplate.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayPatchTemplate_OperationalStatus_LoaAccepted = "loa_accepted"
	GatewayPatchTemplate_OperationalStatus_LoaRejected = "loa_rejected"
)

Constants associated with the GatewayPatchTemplate.OperationalStatus property. Gateway operational status.

For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. When rejecting an LOA, provide reject reasoning in `loa_reject_reason`.

Only allowed for type=dedicated gateways.

View Source
const (
	GatewayStatistic_Type_BfdSession          = "bfd_session"
	GatewayStatistic_Type_MacsecMkaSession    = "macsec_mka_session"
	GatewayStatistic_Type_MacsecMkaStatistics = "macsec_mka_statistics"
	GatewayStatistic_Type_MacsecPolicy        = "macsec_policy"
)

Constants associated with the GatewayStatistic.Type property. statistic type.

View Source
const (
	GatewayStatus_Value_Active      = "active"
	GatewayStatus_Value_Connect     = "connect"
	GatewayStatus_Value_Established = "established"
	GatewayStatus_Value_Idle        = "idle"
)

Constants associated with the GatewayStatus.Value property. Status.

View Source
const (
	GatewayTemplate_ConnectionMode_Direct  = "direct"
	GatewayTemplate_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayTemplate.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayTemplate_DefaultExportRouteFilter_Deny   = "deny"
	GatewayTemplate_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplate.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplate_DefaultImportRouteFilter_Deny   = "deny"
	GatewayTemplate_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplate.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplate_Type_Connect   = "connect"
	GatewayTemplate_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayTemplate.Type property. Offering type.

View Source
const (
	GatewayTemplate_MacsecCapability_Macsec         = "macsec"
	GatewayTemplate_MacsecCapability_MacsecOptional = "macsec_optional"
	GatewayTemplate_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GatewayTemplate.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

If not explicitly provided, the field will be assigned with the following priorities based on `cross_connect_router` capabilities and available ports:

  • `macsec` was not provided in the request
  • `non_macsec`
  • `macsec_optional`
  • `macsec` was provided in the request
  • `macsec_optional`
  • `macsec`.
View Source
const (
	GatewayTemplateRouteFilter_Action_Deny   = "deny"
	GatewayTemplateRouteFilter_Action_Permit = "permit"
)

Constants associated with the GatewayTemplateRouteFilter.Action property. Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.

View Source
const (
	GatewayVirtualConnection_Status_ApprovalPending          = "approval_pending"
	GatewayVirtualConnection_Status_Attached                 = "attached"
	GatewayVirtualConnection_Status_Deleting                 = "deleting"
	GatewayVirtualConnection_Status_DetachedByNetwork        = "detached_by_network"
	GatewayVirtualConnection_Status_DetachedByNetworkPending = "detached_by_network_pending"
	GatewayVirtualConnection_Status_Expired                  = "expired"
	GatewayVirtualConnection_Status_Pending                  = "pending"
	GatewayVirtualConnection_Status_Rejected                 = "rejected"
)

Constants associated with the GatewayVirtualConnection.Status property. Status of the virtual connection.

The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayVirtualConnection_Type_Classic = "classic"
	GatewayVirtualConnection_Type_Transit = "transit"
	GatewayVirtualConnection_Type_Vpc     = "vpc"
)

Constants associated with the GatewayVirtualConnection.Type property. Virtual connection type.

The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayVirtualConnectionPatchTemplate_Status_Attached = "attached"
	GatewayVirtualConnectionPatchTemplate_Status_Rejected = "rejected"
)

Constants associated with the GatewayVirtualConnectionPatchTemplate.Status property. Status of the virtual connection. Virtual connections that span IBM Cloud Accounts are created in approval_pending status. The owner of the target network can accept or reject connection requests by patching status to attached or rejected respectively.

View Source
const (
	GetGatewayResponse_BgpStatus_Active      = "active"
	GetGatewayResponse_BgpStatus_Connect     = "connect"
	GetGatewayResponse_BgpStatus_Established = "established"
	GetGatewayResponse_BgpStatus_Idle        = "idle"
)

Constants associated with the GetGatewayResponse.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponse_ConnectionMode_Direct  = "direct"
	GetGatewayResponse_ConnectionMode_Transit = "transit"
)

Constants associated with the GetGatewayResponse.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponse_DefaultExportRouteFilter_Deny   = "deny"
	GetGatewayResponse_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GetGatewayResponse.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GetGatewayResponse_DefaultImportRouteFilter_Deny   = "deny"
	GetGatewayResponse_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GetGatewayResponse.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GetGatewayResponse_LinkStatus_Down = "down"
	GetGatewayResponse_LinkStatus_Up   = "up"
)

Constants associated with the GetGatewayResponse.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponse_MacsecCapability_Macsec         = "macsec"
	GetGatewayResponse_MacsecCapability_MacsecOptional = "macsec_optional"
	GetGatewayResponse_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GetGatewayResponse.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

Only included on type=dedicated direct links.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

View Source
const (
	GetGatewayResponse_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GetGatewayResponse_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GetGatewayResponse_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GetGatewayResponse_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GetGatewayResponse_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GetGatewayResponse_OperationalStatus_Configuring              = "configuring"
	GetGatewayResponse_OperationalStatus_CreatePending            = "create_pending"
	GetGatewayResponse_OperationalStatus_CreateRejected           = "create_rejected"
	GetGatewayResponse_OperationalStatus_DeletePending            = "delete_pending"
	GetGatewayResponse_OperationalStatus_Failed                   = "failed"
	GetGatewayResponse_OperationalStatus_LoaAccepted              = "loa_accepted"
	GetGatewayResponse_OperationalStatus_LoaCreated               = "loa_created"
	GetGatewayResponse_OperationalStatus_LoaRejected              = "loa_rejected"
	GetGatewayResponse_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GetGatewayResponse.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.

View Source
const (
	GetGatewayResponse_Type_Connect   = "connect"
	GetGatewayResponse_Type_Dedicated = "dedicated"
)

Constants associated with the GetGatewayResponse.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayStatisticsOptions_Type_BfdSession          = "bfd_session"
	GetGatewayStatisticsOptions_Type_MacsecMkaSession    = "macsec_mka_session"
	GetGatewayStatisticsOptions_Type_MacsecMkaStatistics = "macsec_mka_statistics"
	GetGatewayStatisticsOptions_Type_MacsecPolicy        = "macsec_policy"
)

Constants associated with the GetGatewayStatisticsOptions.Type property. Specify statistic to retrieve.

View Source
const (
	GetGatewayStatusOptions_Type_Bfd  = "bfd"
	GetGatewayStatusOptions_Type_Bgp  = "bgp"
	GetGatewayStatusOptions_Type_Link = "link"
)

Constants associated with the GetGatewayStatusOptions.Type property. Specify status to retrieve.

View Source
const (
	ListOfferingTypeLocationCrossConnectRoutersOptions_OfferingType_Connect   = "connect"
	ListOfferingTypeLocationCrossConnectRoutersOptions_OfferingType_Dedicated = "dedicated"
)

Constants associated with the ListOfferingTypeLocationCrossConnectRoutersOptions.OfferingType property. The Direct Link offering type. Current supported values are `"dedicated"` and `"connect"`.

View Source
const (
	ListOfferingTypeLocationsOptions_OfferingType_Connect   = "connect"
	ListOfferingTypeLocationsOptions_OfferingType_Dedicated = "dedicated"
)

Constants associated with the ListOfferingTypeLocationsOptions.OfferingType property. The Direct Link offering type. Current supported values are `"dedicated"` and `"connect"`.

View Source
const (
	ListOfferingTypeSpeedsOptions_OfferingType_Connect   = "connect"
	ListOfferingTypeSpeedsOptions_OfferingType_Dedicated = "dedicated"
)

Constants associated with the ListOfferingTypeSpeedsOptions.OfferingType property. The Direct Link offering type. Current supported values are `"dedicated"` and `"connect"`.

View Source
const (
	RouteFilter_Action_Deny   = "deny"
	RouteFilter_Action_Permit = "permit"
)

Constants associated with the RouteFilter.Action property. Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.

View Source
const (
	RouteReport_Status_Complete = "complete"
	RouteReport_Status_Pending  = "pending"
)

Constants associated with the RouteReport.Status property. Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	SetGatewayMacsecOptions_SecurityPolicy_MustSecure   = "must_secure"
	SetGatewayMacsecOptions_SecurityPolicy_ShouldSecure = "should_secure"
)

Constants associated with the SetGatewayMacsecOptions.SecurityPolicy property. Determines how packets without MACsec headers are handled.

`must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.

View Source
const (
	UpdateRouteFilterTemplate_Action_Deny   = "deny"
	UpdateRouteFilterTemplate_Action_Permit = "permit"
)

Constants associated with the UpdateRouteFilterTemplate.Action property. Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.

View Source
const (
	GatewayCollectionGatewaysItemCrossAccountGateway_BgpStatus_Active      = "active"
	GatewayCollectionGatewaysItemCrossAccountGateway_BgpStatus_Connect     = "connect"
	GatewayCollectionGatewaysItemCrossAccountGateway_BgpStatus_Established = "established"
	GatewayCollectionGatewaysItemCrossAccountGateway_BgpStatus_Idle        = "idle"
)

Constants associated with the GatewayCollectionGatewaysItemCrossAccountGateway.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemCrossAccountGateway_ConnectionMode_Direct  = "direct"
	GatewayCollectionGatewaysItemCrossAccountGateway_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayCollectionGatewaysItemCrossAccountGateway.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemCrossAccountGateway_LinkStatus_Down = "down"
	GatewayCollectionGatewaysItemCrossAccountGateway_LinkStatus_Up   = "up"
)

Constants associated with the GatewayCollectionGatewaysItemCrossAccountGateway.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_Configuring              = "configuring"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_CreatePending            = "create_pending"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_CreateRejected           = "create_rejected"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_DeletePending            = "delete_pending"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_LoaAccepted              = "loa_accepted"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_LoaCreated               = "loa_created"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_LoaRejected              = "loa_rejected"
	GatewayCollectionGatewaysItemCrossAccountGateway_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GatewayCollectionGatewaysItemCrossAccountGateway.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemCrossAccountGateway_Type_Connect   = "connect"
	GatewayCollectionGatewaysItemCrossAccountGateway_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayCollectionGatewaysItemCrossAccountGateway.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemGateway_BgpStatus_Active      = "active"
	GatewayCollectionGatewaysItemGateway_BgpStatus_Connect     = "connect"
	GatewayCollectionGatewaysItemGateway_BgpStatus_Established = "established"
	GatewayCollectionGatewaysItemGateway_BgpStatus_Idle        = "idle"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemGateway_ConnectionMode_Direct  = "direct"
	GatewayCollectionGatewaysItemGateway_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemGateway_DefaultExportRouteFilter_Deny   = "deny"
	GatewayCollectionGatewaysItemGateway_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayCollectionGatewaysItemGateway_DefaultImportRouteFilter_Deny   = "deny"
	GatewayCollectionGatewaysItemGateway_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayCollectionGatewaysItemGateway_LinkStatus_Down = "down"
	GatewayCollectionGatewaysItemGateway_LinkStatus_Up   = "up"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayCollectionGatewaysItemGateway_MacsecCapability_Macsec         = "macsec"
	GatewayCollectionGatewaysItemGateway_MacsecCapability_MacsecOptional = "macsec_optional"
	GatewayCollectionGatewaysItemGateway_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

Only included on type=dedicated direct links.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

View Source
const (
	GatewayCollectionGatewaysItemGateway_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_Configuring              = "configuring"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_CreatePending            = "create_pending"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_CreateRejected           = "create_rejected"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_DeletePending            = "delete_pending"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_Failed                   = "failed"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_LoaAccepted              = "loa_accepted"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_LoaCreated               = "loa_created"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_LoaRejected              = "loa_rejected"
	GatewayCollectionGatewaysItemGateway_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.

View Source
const (
	GatewayCollectionGatewaysItemGateway_Type_Connect   = "connect"
	GatewayCollectionGatewaysItemGateway_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayCollectionGatewaysItemGateway.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayStatusGatewayBFDStatus_Value_Down         = "down"
	GatewayStatusGatewayBFDStatus_Value_Init         = "init"
	GatewayStatusGatewayBFDStatus_Value_NotAvailable = "not_available"
	GatewayStatusGatewayBFDStatus_Value_Up           = "up"
)

Constants associated with the GatewayStatusGatewayBFDStatus.Value property. Status.

View Source
const (
	GatewayStatusGatewayBGPStatus_Value_Active      = "active"
	GatewayStatusGatewayBGPStatus_Value_Connect     = "connect"
	GatewayStatusGatewayBGPStatus_Value_Established = "established"
	GatewayStatusGatewayBGPStatus_Value_Idle        = "idle"
)

Constants associated with the GatewayStatusGatewayBGPStatus.Value property. Status.

View Source
const (
	GatewayStatusGatewayLinkStatus_Value_Down = "down"
	GatewayStatusGatewayLinkStatus_Value_Up   = "up"
)

Constants associated with the GatewayStatusGatewayLinkStatus.Value property. Status.

View Source
const (
	GatewayTemplateGatewayTypeConnectTemplate_ConnectionMode_Direct  = "direct"
	GatewayTemplateGatewayTypeConnectTemplate_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayTemplateGatewayTypeConnectTemplate.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayTemplateGatewayTypeConnectTemplate_DefaultExportRouteFilter_Deny   = "deny"
	GatewayTemplateGatewayTypeConnectTemplate_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplateGatewayTypeConnectTemplate.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplateGatewayTypeConnectTemplate_DefaultImportRouteFilter_Deny   = "deny"
	GatewayTemplateGatewayTypeConnectTemplate_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplateGatewayTypeConnectTemplate.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplateGatewayTypeConnectTemplate_Type_Connect   = "connect"
	GatewayTemplateGatewayTypeConnectTemplate_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayTemplateGatewayTypeConnectTemplate.Type property. Offering type.

View Source
const (
	GatewayTemplateGatewayTypeDedicatedTemplate_ConnectionMode_Direct  = "direct"
	GatewayTemplateGatewayTypeDedicatedTemplate_ConnectionMode_Transit = "transit"
)

Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GatewayTemplateGatewayTypeDedicatedTemplate_DefaultExportRouteFilter_Deny   = "deny"
	GatewayTemplateGatewayTypeDedicatedTemplate_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplateGatewayTypeDedicatedTemplate_DefaultImportRouteFilter_Deny   = "deny"
	GatewayTemplateGatewayTypeDedicatedTemplate_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GatewayTemplateGatewayTypeDedicatedTemplate_Type_Connect   = "connect"
	GatewayTemplateGatewayTypeDedicatedTemplate_Type_Dedicated = "dedicated"
)

Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.Type property. Offering type.

View Source
const (
	GatewayTemplateGatewayTypeDedicatedTemplate_MacsecCapability_Macsec         = "macsec"
	GatewayTemplateGatewayTypeDedicatedTemplate_MacsecCapability_MacsecOptional = "macsec_optional"
	GatewayTemplateGatewayTypeDedicatedTemplate_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

If not explicitly provided, the field will be assigned with the following priorities based on `cross_connect_router` capabilities and available ports:

  • `macsec` was not provided in the request
  • `non_macsec`
  • `macsec_optional`
  • `macsec` was provided in the request
  • `macsec_optional`
  • `macsec`.
View Source
const (
	GetGatewayResponseCrossAccountGateway_BgpStatus_Active      = "active"
	GetGatewayResponseCrossAccountGateway_BgpStatus_Connect     = "connect"
	GetGatewayResponseCrossAccountGateway_BgpStatus_Established = "established"
	GetGatewayResponseCrossAccountGateway_BgpStatus_Idle        = "idle"
)

Constants associated with the GetGatewayResponseCrossAccountGateway.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseCrossAccountGateway_ConnectionMode_Direct  = "direct"
	GetGatewayResponseCrossAccountGateway_ConnectionMode_Transit = "transit"
)

Constants associated with the GetGatewayResponseCrossAccountGateway.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseCrossAccountGateway_LinkStatus_Down = "down"
	GetGatewayResponseCrossAccountGateway_LinkStatus_Up   = "up"
)

Constants associated with the GetGatewayResponseCrossAccountGateway.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseCrossAccountGateway_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_Configuring              = "configuring"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_CreatePending            = "create_pending"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_CreateRejected           = "create_rejected"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_DeletePending            = "delete_pending"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_LoaAccepted              = "loa_accepted"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_LoaCreated               = "loa_created"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_LoaRejected              = "loa_rejected"
	GetGatewayResponseCrossAccountGateway_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GetGatewayResponseCrossAccountGateway.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseCrossAccountGateway_Type_Connect   = "connect"
	GetGatewayResponseCrossAccountGateway_Type_Dedicated = "dedicated"
)

Constants associated with the GetGatewayResponseCrossAccountGateway.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseGateway_BgpStatus_Active      = "active"
	GetGatewayResponseGateway_BgpStatus_Connect     = "connect"
	GetGatewayResponseGateway_BgpStatus_Established = "established"
	GetGatewayResponseGateway_BgpStatus_Idle        = "idle"
)

Constants associated with the GetGatewayResponseGateway.BgpStatus property. Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseGateway_ConnectionMode_Direct  = "direct"
	GetGatewayResponseGateway_ConnectionMode_Transit = "transit"
)

Constants associated with the GetGatewayResponseGateway.ConnectionMode property. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseGateway_DefaultExportRouteFilter_Deny   = "deny"
	GetGatewayResponseGateway_DefaultExportRouteFilter_Permit = "permit"
)

Constants associated with the GetGatewayResponseGateway.DefaultExportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GetGatewayResponseGateway_DefaultImportRouteFilter_Deny   = "deny"
	GetGatewayResponseGateway_DefaultImportRouteFilter_Permit = "permit"
)

Constants associated with the GetGatewayResponseGateway.DefaultImportRouteFilter property. The default directional route filter action that applies to routes that do not match any directional route filters.

View Source
const (
	GetGatewayResponseGateway_LinkStatus_Down = "down"
	GetGatewayResponseGateway_LinkStatus_Up   = "up"
)

Constants associated with the GetGatewayResponseGateway.LinkStatus property. Gateway link status. Only included on type=dedicated gateways. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	GetGatewayResponseGateway_MacsecCapability_Macsec         = "macsec"
	GetGatewayResponseGateway_MacsecCapability_MacsecOptional = "macsec_optional"
	GetGatewayResponseGateway_MacsecCapability_NonMacsec      = "non_macsec"
)

Constants associated with the GetGatewayResponseGateway.MacsecCapability property. Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the `cross_connect_router`.

Only included on type=dedicated direct links.

- non_macsec: The direct link does not support MACsec. - macsec: The direct link supports MACsec. The MACsec feature must be enabled. - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after direct link creation.

View Source
const (
	GetGatewayResponseGateway_OperationalStatus_AwaitingCompletionNotice = "awaiting_completion_notice"
	GetGatewayResponseGateway_OperationalStatus_AwaitingLoa              = "awaiting_loa"
	GetGatewayResponseGateway_OperationalStatus_CompletionNoticeApproved = "completion_notice_approved"
	GetGatewayResponseGateway_OperationalStatus_CompletionNoticeReceived = "completion_notice_received"
	GetGatewayResponseGateway_OperationalStatus_CompletionNoticeRejected = "completion_notice_rejected"
	GetGatewayResponseGateway_OperationalStatus_Configuring              = "configuring"
	GetGatewayResponseGateway_OperationalStatus_CreatePending            = "create_pending"
	GetGatewayResponseGateway_OperationalStatus_CreateRejected           = "create_rejected"
	GetGatewayResponseGateway_OperationalStatus_DeletePending            = "delete_pending"
	GetGatewayResponseGateway_OperationalStatus_Failed                   = "failed"
	GetGatewayResponseGateway_OperationalStatus_LoaAccepted              = "loa_accepted"
	GetGatewayResponseGateway_OperationalStatus_LoaCreated               = "loa_created"
	GetGatewayResponseGateway_OperationalStatus_LoaRejected              = "loa_rejected"
	GetGatewayResponseGateway_OperationalStatus_Provisioned              = "provisioned"
)

Constants associated with the GetGatewayResponseGateway.OperationalStatus property. Gateway operational status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.

View Source
const (
	GetGatewayResponseGateway_Type_Connect   = "connect"
	GetGatewayResponseGateway_Type_Dedicated = "dedicated"
)

Constants associated with the GetGatewayResponseGateway.Type property. Offering type. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source
const (
	RouteReportOverlappingRouteForOthers_Type_Gateway = "gateway"
	RouteReportOverlappingRouteForOthers_Type_OnPrem  = "on_prem"
)

Constants associated with the RouteReportOverlappingRouteForOthers.Type property. type of the route.

View Source
const DefaultServiceName = "direct_link"

DefaultServiceName is the default key used to find external configuration information.

View Source
const DefaultServiceURL = "https://directlink.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

View Source
const (
	GatewayChangeRequestGatewayClientGatewayCreate_Type_CreateGateway = "create_gateway"
)

Constants associated with the GatewayChangeRequestGatewayClientGatewayCreate.Type property. type of gateway change request.

View Source
const (
	GatewayChangeRequestGatewayClientGatewayDelete_Type_DeleteGateway = "delete_gateway"
)

Constants associated with the GatewayChangeRequestGatewayClientGatewayDelete.Type property. type of gateway change request.

View Source
const (
	GatewayChangeRequestGatewayClientGatewayUpdateAttributes_Type_UpdateAttributes = "update_attributes"
)

Constants associated with the GatewayChangeRequestGatewayClientGatewayUpdateAttributes.Type property. type of gateway change request.

View Source
const (
	GatewayChangeRequest_Type_CreateGateway = "create_gateway"
)

Constants associated with the GatewayChangeRequest.Type property. type of gateway change request.

View Source
const (
	GatewayMacsecStatusReason_Code_MacsecCakFailed = "macsec_cak_failed"
)

Constants associated with the GatewayMacsecStatusReason.Code property. A reason code for the status: - `macsec_cak_failed`: At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the `status` of the CAKs associated with the MACsec configuration to find the the source of this reason.

View Source
const (
	GatewayMacsec_CipherSuite_GcmAesXpn256 = "gcm_aes_xpn_256"
)

Constants associated with the GatewayMacsec.CipherSuite property. The cipher suite used in generating the security association key (SAK).

View Source
const (
	GatewayStatusGatewayBFDStatus_Type_Bfd = "bfd"
)

Constants associated with the GatewayStatusGatewayBFDStatus.Type property. Status type.

View Source
const (
	GatewayStatusGatewayBGPStatus_Type_Bgp = "bgp"
)

Constants associated with the GatewayStatusGatewayBGPStatus.Type property. Status type.

View Source
const (
	GatewayStatusGatewayLinkStatus_Type_Link = "link"
)

Constants associated with the GatewayStatusGatewayLinkStatus.Type property. Status type.

View Source
const (
	GatewayStatusReason_Code_AuthenticationKeyFailed = "authentication_key_failed"
)

Constants associated with the GatewayStatusReason.Code property. A reason code for the status: - `authentication_key_failed`: `authentication_key` was unable to be configured on the direct link gateway. To recover, first resolve any issues with your key, then patch the gateway with the same or new key.

View Source
const (
	GatewayStatus_Type_Bgp = "bgp"
)

Constants associated with the GatewayStatus.Type property. Status type.

View Source
const (
	RouteReportOverlappingRouteForConnection_Type_VirtualConnection = "virtual_connection"
)

Constants associated with the RouteReportOverlappingRouteForConnection.Type property. type of the route.

View Source
const (
	RouteReportOverlappingRoute_Type_VirtualConnection = "virtual_connection"
)

Constants associated with the RouteReportOverlappingRoute.Type property. type of the route.

View Source
const (
	SakRekeyPacketNumberRolloverMode_Mode_PacketNumberRollover = "packet_number_rollover"
)

Constants associated with the SakRekeyPacketNumberRolloverMode.Mode property. Determines that the SAK rekey occurs based on the used packet numbers.

View Source
const (
	SakRekeyPatchSakRekeyPacketNumberRolloverModePatch_Mode_PacketNumberRollover = "packet_number_rollover"
)

Constants associated with the SakRekeyPatchSakRekeyPacketNumberRolloverModePatch.Mode property. Determines that the SAK rekey occurs based on the used packet numbers.

View Source
const (
	SakRekeyPatchSakRekeyTimerModePatch_Mode_Timer = "timer"
)

Constants associated with the SakRekeyPatchSakRekeyTimerModePatch.Mode property. Determines that the SAK rekey occurs based on a timer.

View Source
const (
	SakRekeyPatch_Mode_Timer = "timer"
)

Constants associated with the SakRekeyPatch.Mode property. Determines that the SAK rekey occurs based on a timer.

View Source
const (
	SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype_Mode_PacketNumberRollover = "packet_number_rollover"
)

Constants associated with the SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype.Mode property. Determines that the SAK rekey occurs based on the used packet numbers.

View Source
const (
	SakRekeyPrototypeSakRekeyTimerModePrototype_Mode_Timer = "timer"
)

Constants associated with the SakRekeyPrototypeSakRekeyTimerModePrototype.Mode property. Determines that the SAK rekey occurs based on a timer.

View Source
const (
	SakRekeyPrototype_Mode_Timer = "timer"
)

Constants associated with the SakRekeyPrototype.Mode property. Determines that the SAK rekey occurs based on a timer.

View Source
const (
	SakRekeyTimerMode_Mode_Timer = "timer"
)

Constants associated with the SakRekeyTimerMode.Mode property. Determines that the SAK rekey occurs based on a timer.

View Source
const (
	SakRekey_Mode_Timer = "timer"
)

Constants associated with the SakRekey.Mode property. Determines that the SAK rekey occurs based on a timer.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.15.0

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAsPrepend added in v0.34.0

func UnmarshalAsPrepend(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsPrepend unmarshals an instance of AsPrepend from the specified map of raw messages.

func UnmarshalAsPrependCollection added in v0.35.0

func UnmarshalAsPrependCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsPrependCollection unmarshals an instance of AsPrependCollection from the specified map of raw messages.

func UnmarshalAsPrependEntry added in v0.35.0

func UnmarshalAsPrependEntry(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsPrependEntry unmarshals an instance of AsPrependEntry from the specified map of raw messages.

func UnmarshalAsPrependPrefixArrayTemplate added in v0.35.0

func UnmarshalAsPrependPrefixArrayTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsPrependPrefixArrayTemplate unmarshals an instance of AsPrependPrefixArrayTemplate from the specified map of raw messages.

func UnmarshalAsPrependTemplate added in v0.34.0

func UnmarshalAsPrependTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAsPrependTemplate unmarshals an instance of AsPrependTemplate from the specified map of raw messages.

func UnmarshalAuthenticationKeyIdentity added in v0.51.7

func UnmarshalAuthenticationKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyIdentity unmarshals an instance of AuthenticationKeyIdentity from the specified map of raw messages.

func UnmarshalAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity added in v0.51.7

func UnmarshalAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity unmarshals an instance of AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity from the specified map of raw messages.

func UnmarshalAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity added in v0.51.7

func UnmarshalAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity unmarshals an instance of AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity from the specified map of raw messages.

func UnmarshalAuthenticationKeyReference added in v0.51.7

func UnmarshalAuthenticationKeyReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyReference unmarshals an instance of AuthenticationKeyReference from the specified map of raw messages.

func UnmarshalAuthenticationKeyReferenceHpcsAuthenticationKeyReference added in v0.51.7

func UnmarshalAuthenticationKeyReferenceHpcsAuthenticationKeyReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyReferenceHpcsAuthenticationKeyReference unmarshals an instance of AuthenticationKeyReferenceHpcsAuthenticationKeyReference from the specified map of raw messages.

func UnmarshalAuthenticationKeyReferenceKeyProtectAuthenticationKeyReference added in v0.51.7

func UnmarshalAuthenticationKeyReferenceKeyProtectAuthenticationKeyReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAuthenticationKeyReferenceKeyProtectAuthenticationKeyReference unmarshals an instance of AuthenticationKeyReferenceKeyProtectAuthenticationKeyReference from the specified map of raw messages.

func UnmarshalCrossConnectRouter

func UnmarshalCrossConnectRouter(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCrossConnectRouter unmarshals an instance of CrossConnectRouter from the specified map of raw messages.

func UnmarshalExportRouteFilterCollection added in v0.39.0

func UnmarshalExportRouteFilterCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExportRouteFilterCollection unmarshals an instance of ExportRouteFilterCollection from the specified map of raw messages.

func UnmarshalGateway

func UnmarshalGateway(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGateway unmarshals an instance of Gateway from the specified map of raw messages.

func UnmarshalGatewayActionTemplateUpdatesItem

func UnmarshalGatewayActionTemplateUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayActionTemplateUpdatesItem unmarshals an instance of GatewayActionTemplateUpdatesItem from the specified map of raw messages.

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate unmarshals an instance of GatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate from the specified map of raw messages.

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate unmarshals an instance of GatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate from the specified map of raw messages.

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate unmarshals an instance of GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate from the specified map of raw messages.

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientVLANUpdate added in v0.26.0

func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientVLANUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayActionTemplateUpdatesItemGatewayClientVLANUpdate unmarshals an instance of GatewayActionTemplateUpdatesItemGatewayClientVLANUpdate from the specified map of raw messages.

func UnmarshalGatewayBfdConfig added in v0.23.0

func UnmarshalGatewayBfdConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayBfdConfig unmarshals an instance of GatewayBfdConfig from the specified map of raw messages.

func UnmarshalGatewayBfdConfigActionTemplate added in v0.23.0

func UnmarshalGatewayBfdConfigActionTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayBfdConfigActionTemplate unmarshals an instance of GatewayBfdConfigActionTemplate from the specified map of raw messages.

func UnmarshalGatewayBfdConfigTemplate added in v0.23.0

func UnmarshalGatewayBfdConfigTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayBfdConfigTemplate unmarshals an instance of GatewayBfdConfigTemplate from the specified map of raw messages.

func UnmarshalGatewayBfdPatchTemplate added in v0.23.0

func UnmarshalGatewayBfdPatchTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayBfdPatchTemplate unmarshals an instance of GatewayBfdPatchTemplate from the specified map of raw messages.

func UnmarshalGatewayChangeRequest

func UnmarshalGatewayChangeRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequest unmarshals an instance of GatewayChangeRequest from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayCreate

func UnmarshalGatewayChangeRequestGatewayClientGatewayCreate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayCreate unmarshals an instance of GatewayChangeRequestGatewayClientGatewayCreate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayDelete

func UnmarshalGatewayChangeRequestGatewayClientGatewayDelete(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayDelete unmarshals an instance of GatewayChangeRequestGatewayClientGatewayDelete from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributes

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributes unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributes from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate added in v0.26.0

func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate unmarshals an instance of GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestUpdatesItem

func UnmarshalGatewayChangeRequestUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestUpdatesItem unmarshals an instance of GatewayChangeRequestUpdatesItem from the specified map of raw messages.

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate unmarshals an instance of GatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate unmarshals an instance of GatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate unmarshals an instance of GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate from the specified map of raw messages.

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientVLANUpdate added in v0.26.0

func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientVLANUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayChangeRequestUpdatesItemGatewayClientVLANUpdate unmarshals an instance of GatewayChangeRequestUpdatesItemGatewayClientVLANUpdate from the specified map of raw messages.

func UnmarshalGatewayCollection

func UnmarshalGatewayCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayCollection unmarshals an instance of GatewayCollection from the specified map of raw messages.

func UnmarshalGatewayCollectionGatewaysItem added in v0.45.0

func UnmarshalGatewayCollectionGatewaysItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayCollectionGatewaysItem unmarshals an instance of GatewayCollectionGatewaysItem from the specified map of raw messages.

func UnmarshalGatewayCollectionGatewaysItemCrossAccountGateway added in v0.45.0

func UnmarshalGatewayCollectionGatewaysItemCrossAccountGateway(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayCollectionGatewaysItemCrossAccountGateway unmarshals an instance of GatewayCollectionGatewaysItemCrossAccountGateway from the specified map of raw messages.

func UnmarshalGatewayCollectionGatewaysItemGateway added in v0.45.0

func UnmarshalGatewayCollectionGatewaysItemGateway(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayCollectionGatewaysItemGateway unmarshals an instance of GatewayCollectionGatewaysItemGateway from the specified map of raw messages.

func UnmarshalGatewayMacsec added in v0.51.7

func UnmarshalGatewayMacsec(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsec unmarshals an instance of GatewayMacsec from the specified map of raw messages.

func UnmarshalGatewayMacsecCak added in v0.11.0

func UnmarshalGatewayMacsecCak(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecCak unmarshals an instance of GatewayMacsecCak from the specified map of raw messages.

func UnmarshalGatewayMacsecCakActiveDelta added in v0.51.7

func UnmarshalGatewayMacsecCakActiveDelta(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecCakActiveDelta unmarshals an instance of GatewayMacsecCakActiveDelta from the specified map of raw messages.

func UnmarshalGatewayMacsecCakCollection added in v0.51.7

func UnmarshalGatewayMacsecCakCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecCakCollection unmarshals an instance of GatewayMacsecCakCollection from the specified map of raw messages.

func UnmarshalGatewayMacsecCakPatch added in v0.51.7

func UnmarshalGatewayMacsecCakPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecCakPatch unmarshals an instance of GatewayMacsecCakPatch from the specified map of raw messages.

func UnmarshalGatewayMacsecCakPrototype added in v0.51.7

func UnmarshalGatewayMacsecCakPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecCakPrototype unmarshals an instance of GatewayMacsecCakPrototype from the specified map of raw messages.

func UnmarshalGatewayMacsecPatch added in v0.51.7

func UnmarshalGatewayMacsecPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecPatch unmarshals an instance of GatewayMacsecPatch from the specified map of raw messages.

func UnmarshalGatewayMacsecPrototype added in v0.51.7

func UnmarshalGatewayMacsecPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecPrototype unmarshals an instance of GatewayMacsecPrototype from the specified map of raw messages.

func UnmarshalGatewayMacsecReference added in v0.51.7

func UnmarshalGatewayMacsecReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecReference unmarshals an instance of GatewayMacsecReference from the specified map of raw messages.

func UnmarshalGatewayMacsecStatusReason added in v0.51.7

func UnmarshalGatewayMacsecStatusReason(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayMacsecStatusReason unmarshals an instance of GatewayMacsecStatusReason from the specified map of raw messages.

func UnmarshalGatewayPatchTemplate added in v0.45.0

func UnmarshalGatewayPatchTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayPatchTemplate unmarshals an instance of GatewayPatchTemplate from the specified map of raw messages.

func UnmarshalGatewayPortIdentity

func UnmarshalGatewayPortIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayPortIdentity unmarshals an instance of GatewayPortIdentity from the specified map of raw messages.

func UnmarshalGatewayPortReference added in v0.51.7

func UnmarshalGatewayPortReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayPortReference unmarshals an instance of GatewayPortReference from the specified map of raw messages.

func UnmarshalGatewayStatistic added in v0.11.0

func UnmarshalGatewayStatistic(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatistic unmarshals an instance of GatewayStatistic from the specified map of raw messages.

func UnmarshalGatewayStatisticCollection added in v0.11.0

func UnmarshalGatewayStatisticCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatisticCollection unmarshals an instance of GatewayStatisticCollection from the specified map of raw messages.

func UnmarshalGatewayStatus added in v0.23.0

func UnmarshalGatewayStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatus unmarshals an instance of GatewayStatus from the specified map of raw messages.

func UnmarshalGatewayStatusCollection added in v0.23.0

func UnmarshalGatewayStatusCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatusCollection unmarshals an instance of GatewayStatusCollection from the specified map of raw messages.

func UnmarshalGatewayStatusGatewayBFDStatus added in v0.23.0

func UnmarshalGatewayStatusGatewayBFDStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatusGatewayBFDStatus unmarshals an instance of GatewayStatusGatewayBFDStatus from the specified map of raw messages.

func UnmarshalGatewayStatusGatewayBGPStatus added in v0.23.0

func UnmarshalGatewayStatusGatewayBGPStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatusGatewayBGPStatus unmarshals an instance of GatewayStatusGatewayBGPStatus from the specified map of raw messages.

func UnmarshalGatewayStatusGatewayLinkStatus added in v0.23.0

func UnmarshalGatewayStatusGatewayLinkStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatusGatewayLinkStatus unmarshals an instance of GatewayStatusGatewayLinkStatus from the specified map of raw messages.

func UnmarshalGatewayStatusReason added in v0.51.7

func UnmarshalGatewayStatusReason(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayStatusReason unmarshals an instance of GatewayStatusReason from the specified map of raw messages.

func UnmarshalGatewayTemplate

func UnmarshalGatewayTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayTemplate unmarshals an instance of GatewayTemplate from the specified map of raw messages.

func UnmarshalGatewayTemplateGatewayTypeConnectTemplate

func UnmarshalGatewayTemplateGatewayTypeConnectTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayTemplateGatewayTypeConnectTemplate unmarshals an instance of GatewayTemplateGatewayTypeConnectTemplate from the specified map of raw messages.

func UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate

func UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate unmarshals an instance of GatewayTemplateGatewayTypeDedicatedTemplate from the specified map of raw messages.

func UnmarshalGatewayTemplateRouteFilter added in v0.39.0

func UnmarshalGatewayTemplateRouteFilter(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayTemplateRouteFilter unmarshals an instance of GatewayTemplateRouteFilter from the specified map of raw messages.

func UnmarshalGatewayVirtualConnection

func UnmarshalGatewayVirtualConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayVirtualConnection unmarshals an instance of GatewayVirtualConnection from the specified map of raw messages.

func UnmarshalGatewayVirtualConnectionCollection

func UnmarshalGatewayVirtualConnectionCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayVirtualConnectionCollection unmarshals an instance of GatewayVirtualConnectionCollection from the specified map of raw messages.

func UnmarshalGatewayVirtualConnectionPatchTemplate added in v0.51.7

func UnmarshalGatewayVirtualConnectionPatchTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGatewayVirtualConnectionPatchTemplate unmarshals an instance of GatewayVirtualConnectionPatchTemplate from the specified map of raw messages.

func UnmarshalGetGatewayResponse added in v0.45.0

func UnmarshalGetGatewayResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetGatewayResponse unmarshals an instance of GetGatewayResponse from the specified map of raw messages.

func UnmarshalGetGatewayResponseCrossAccountGateway added in v0.45.0

func UnmarshalGetGatewayResponseCrossAccountGateway(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetGatewayResponseCrossAccountGateway unmarshals an instance of GetGatewayResponseCrossAccountGateway from the specified map of raw messages.

func UnmarshalGetGatewayResponseGateway added in v0.45.0

func UnmarshalGetGatewayResponseGateway(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetGatewayResponseGateway unmarshals an instance of GetGatewayResponseGateway from the specified map of raw messages.

func UnmarshalHpcsKeyIdentity added in v0.51.7

func UnmarshalHpcsKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHpcsKeyIdentity unmarshals an instance of HpcsKeyIdentity from the specified map of raw messages.

func UnmarshalHpcsKeyReference added in v0.51.7

func UnmarshalHpcsKeyReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHpcsKeyReference unmarshals an instance of HpcsKeyReference from the specified map of raw messages.

func UnmarshalImportRouteFilterCollection added in v0.39.0

func UnmarshalImportRouteFilterCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalImportRouteFilterCollection unmarshals an instance of ImportRouteFilterCollection from the specified map of raw messages.

func UnmarshalLocationCollection

func UnmarshalLocationCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocationCollection unmarshals an instance of LocationCollection from the specified map of raw messages.

func UnmarshalLocationCrossConnectRouterCollection

func UnmarshalLocationCrossConnectRouterCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocationCrossConnectRouterCollection unmarshals an instance of LocationCrossConnectRouterCollection from the specified map of raw messages.

func UnmarshalLocationOutput

func UnmarshalLocationOutput(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLocationOutput unmarshals an instance of LocationOutput from the specified map of raw messages.

func UnmarshalOfferingSpeed

func UnmarshalOfferingSpeed(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOfferingSpeed unmarshals an instance of OfferingSpeed from the specified map of raw messages.

func UnmarshalOfferingSpeedCollection

func UnmarshalOfferingSpeedCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOfferingSpeedCollection unmarshals an instance of OfferingSpeedCollection from the specified map of raw messages.

func UnmarshalPort

func UnmarshalPort(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPort unmarshals an instance of Port from the specified map of raw messages.

func UnmarshalPortCollection

func UnmarshalPortCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPortCollection unmarshals an instance of PortCollection from the specified map of raw messages.

func UnmarshalPortsPaginatedCollectionFirst

func UnmarshalPortsPaginatedCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPortsPaginatedCollectionFirst unmarshals an instance of PortsPaginatedCollectionFirst from the specified map of raw messages.

func UnmarshalPortsPaginatedCollectionNext

func UnmarshalPortsPaginatedCollectionNext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPortsPaginatedCollectionNext unmarshals an instance of PortsPaginatedCollectionNext from the specified map of raw messages.

func UnmarshalResourceGroupIdentity

func UnmarshalResourceGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceGroupIdentity unmarshals an instance of ResourceGroupIdentity from the specified map of raw messages.

func UnmarshalResourceGroupReference

func UnmarshalResourceGroupReference(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceGroupReference unmarshals an instance of ResourceGroupReference from the specified map of raw messages.

func UnmarshalRouteFilter added in v0.39.0

func UnmarshalRouteFilter(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteFilter unmarshals an instance of RouteFilter from the specified map of raw messages.

func UnmarshalRouteReport added in v0.34.0

func UnmarshalRouteReport(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReport unmarshals an instance of RouteReport from the specified map of raw messages.

func UnmarshalRouteReportAdvertisedRoute added in v0.42.2

func UnmarshalRouteReportAdvertisedRoute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportAdvertisedRoute unmarshals an instance of RouteReportAdvertisedRoute from the specified map of raw messages.

func UnmarshalRouteReportCollection added in v0.34.0

func UnmarshalRouteReportCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportCollection unmarshals an instance of RouteReportCollection from the specified map of raw messages.

func UnmarshalRouteReportConnection added in v0.34.0

func UnmarshalRouteReportConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportConnection unmarshals an instance of RouteReportConnection from the specified map of raw messages.

func UnmarshalRouteReportOnPremRoute added in v0.34.0

func UnmarshalRouteReportOnPremRoute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportOnPremRoute unmarshals an instance of RouteReportOnPremRoute from the specified map of raw messages.

func UnmarshalRouteReportOverlappingRoute added in v0.34.0

func UnmarshalRouteReportOverlappingRoute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportOverlappingRoute unmarshals an instance of RouteReportOverlappingRoute from the specified map of raw messages.

func UnmarshalRouteReportOverlappingRouteForConnection added in v0.34.0

func UnmarshalRouteReportOverlappingRouteForConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportOverlappingRouteForConnection unmarshals an instance of RouteReportOverlappingRouteForConnection from the specified map of raw messages.

func UnmarshalRouteReportOverlappingRouteForOthers added in v0.34.0

func UnmarshalRouteReportOverlappingRouteForOthers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportOverlappingRouteForOthers unmarshals an instance of RouteReportOverlappingRouteForOthers from the specified map of raw messages.

func UnmarshalRouteReportOverlappingRouteGroup added in v0.34.0

func UnmarshalRouteReportOverlappingRouteGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportOverlappingRouteGroup unmarshals an instance of RouteReportOverlappingRouteGroup from the specified map of raw messages.

func UnmarshalRouteReportRoute added in v0.34.0

func UnmarshalRouteReportRoute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportRoute unmarshals an instance of RouteReportRoute from the specified map of raw messages.

func UnmarshalRouteReportVirtualConnectionRoute added in v0.42.2

func UnmarshalRouteReportVirtualConnectionRoute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRouteReportVirtualConnectionRoute unmarshals an instance of RouteReportVirtualConnectionRoute from the specified map of raw messages.

func UnmarshalSakRekey added in v0.51.7

func UnmarshalSakRekey(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekey unmarshals an instance of SakRekey from the specified map of raw messages.

func UnmarshalSakRekeyPacketNumberRolloverMode added in v0.51.7

func UnmarshalSakRekeyPacketNumberRolloverMode(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPacketNumberRolloverMode unmarshals an instance of SakRekeyPacketNumberRolloverMode from the specified map of raw messages.

func UnmarshalSakRekeyPatch added in v0.51.7

func UnmarshalSakRekeyPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPatch unmarshals an instance of SakRekeyPatch from the specified map of raw messages.

func UnmarshalSakRekeyPatchSakRekeyPacketNumberRolloverModePatch added in v0.51.7

func UnmarshalSakRekeyPatchSakRekeyPacketNumberRolloverModePatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPatchSakRekeyPacketNumberRolloverModePatch unmarshals an instance of SakRekeyPatchSakRekeyPacketNumberRolloverModePatch from the specified map of raw messages.

func UnmarshalSakRekeyPatchSakRekeyTimerModePatch added in v0.51.7

func UnmarshalSakRekeyPatchSakRekeyTimerModePatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPatchSakRekeyTimerModePatch unmarshals an instance of SakRekeyPatchSakRekeyTimerModePatch from the specified map of raw messages.

func UnmarshalSakRekeyPrototype added in v0.51.7

func UnmarshalSakRekeyPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPrototype unmarshals an instance of SakRekeyPrototype from the specified map of raw messages.

func UnmarshalSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype added in v0.51.7

func UnmarshalSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype unmarshals an instance of SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype from the specified map of raw messages.

func UnmarshalSakRekeyPrototypeSakRekeyTimerModePrototype added in v0.51.7

func UnmarshalSakRekeyPrototypeSakRekeyTimerModePrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyPrototypeSakRekeyTimerModePrototype unmarshals an instance of SakRekeyPrototypeSakRekeyTimerModePrototype from the specified map of raw messages.

func UnmarshalSakRekeyTimerMode added in v0.51.7

func UnmarshalSakRekeyTimerMode(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSakRekeyTimerMode unmarshals an instance of SakRekeyTimerMode from the specified map of raw messages.

func UnmarshalUpdateRouteFilterTemplate added in v0.39.0

func UnmarshalUpdateRouteFilterTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpdateRouteFilterTemplate unmarshals an instance of UpdateRouteFilterTemplate from the specified map of raw messages.

Types

type AsPrepend added in v0.34.0

type AsPrepend struct {
	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The unique identifier for this AS Prepend.
	ID *string `json:"id,omitempty"`

	// Number of times the ASN to appended to the AS Path.
	Length *int64 `json:"length,omitempty"`

	// Route type this AS Prepend applies to.
	Policy *string `json:"policy,omitempty"`

	// Comma separated list of prefixes this AS Prepend applies to.  If empty, this applies to all prefixes.
	// Deprecated: this field is deprecated and may be removed in a future release.
	Prefix *string `json:"prefix,omitempty"`

	// Array of prefixes this AS Prepend applies to. This parameter is not returned when AS Prepend applies to all
	// prefixes.  Note that ordering is not significant and may differ from request order.
	SpecificPrefixes []string `json:"specific_prefixes,omitempty"`

	// The date and time resource was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

AsPrepend : Gateway AS Prepend object.

type AsPrependCollection added in v0.35.0

type AsPrependCollection struct {
	// array of AS Prepend information.
	AsPrepends []AsPrependEntry `json:"as_prepends,omitempty"`
}

AsPrependCollection : array of AS Prepends.

type AsPrependEntry added in v0.35.0

type AsPrependEntry struct {
	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The unique identifier for this AS Prepend.
	ID *string `json:"id,omitempty"`

	// Number of times the ASN to appended to the AS Path.
	Length *int64 `json:"length,omitempty"`

	// Route type this AS Prepend applies to.
	Policy *string `json:"policy,omitempty"`

	// Array of prefixes this AS Prepend applies to. This parameter is not returned when AS Prepend applies to all
	// prefixes.  Note that ordering is not significant and may differ from request order.
	SpecificPrefixes []string `json:"specific_prefixes,omitempty"`

	// The date and time resource was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

AsPrependEntry : AS Prepends API object.

type AsPrependPrefixArrayTemplate added in v0.35.0

type AsPrependPrefixArrayTemplate struct {
	// Number of times the ASN to be prepended to the AS Path.
	Length *int64 `json:"length" validate:"required"`

	// Route type this AS Prepend applies to.
	Policy *string `json:"policy" validate:"required"`

	// Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
	// Note that ordering is not significant and may differ from request order.
	SpecificPrefixes []string `json:"specific_prefixes,omitempty"`
}

AsPrependPrefixArrayTemplate : Create AS Prepend Configuration template.

type AsPrependTemplate added in v0.34.0

type AsPrependTemplate struct {
	// Number of times the ASN to be prepended to the AS Path.
	Length *int64 `json:"length" validate:"required"`

	// Route type this AS Prepend applies to.
	Policy *string `json:"policy" validate:"required"`

	// Comma separated list of prefixes this AS Prepend applies to.  Maximum of 10 prefixes.  If not specified, this AS
	// Prepend applies to all prefixes.
	// Deprecated: this field is deprecated and may be removed in a future release.
	Prefix *string `json:"prefix,omitempty"`

	// Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
	SpecificPrefixes []string `json:"specific_prefixes,omitempty"`
}

AsPrependTemplate : Create AS Prepend Configuration template.

type AuthenticationKeyIdentity added in v0.51.7

type AuthenticationKeyIdentity struct {
	// The CRN of the key.
	Crn *string `json:"crn,omitempty"`
}

AuthenticationKeyIdentity : AuthenticationKeyIdentity struct Models which "extend" this model: - AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity - AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity

type AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity added in v0.51.7

type AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity struct {
	// The CRN of the key.
	Crn *string `json:"crn" validate:"required"`
}

AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity : A [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started). This model "extends" AuthenticationKeyIdentity

type AuthenticationKeyIdentityIntf added in v0.51.7

type AuthenticationKeyIdentityIntf interface {
	// contains filtered or unexported methods
}

type AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity added in v0.51.7

type AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity struct {
	// The CRN of the key.
	Crn *string `json:"crn" validate:"required"`
}

AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity : A [Key Protect Standard Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial). This model "extends" AuthenticationKeyIdentity

type AuthenticationKeyReference added in v0.51.7

type AuthenticationKeyReference struct {
	// The CRN of the referenced key.
	Crn *string `json:"crn,omitempty"`
}

AuthenticationKeyReference : AuthenticationKeyReference struct Models which "extend" this model: - AuthenticationKeyReferenceKeyProtectAuthenticationKeyReference - AuthenticationKeyReferenceHpcsAuthenticationKeyReference

type AuthenticationKeyReferenceHpcsAuthenticationKeyReference added in v0.51.7

type AuthenticationKeyReferenceHpcsAuthenticationKeyReference struct {
	// The CRN of the referenced key.
	Crn *string `json:"crn" validate:"required"`
}

AuthenticationKeyReferenceHpcsAuthenticationKeyReference : A reference to a [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started). This model "extends" AuthenticationKeyReference

type AuthenticationKeyReferenceIntf added in v0.51.7

type AuthenticationKeyReferenceIntf interface {
	// contains filtered or unexported methods
}

type AuthenticationKeyReferenceKeyProtectAuthenticationKeyReference added in v0.51.7

type AuthenticationKeyReferenceKeyProtectAuthenticationKeyReference struct {
	// The CRN of the referenced key.
	Crn *string `json:"crn" validate:"required"`
}

AuthenticationKeyReferenceKeyProtectAuthenticationKeyReference : A reference to a [Key Protect Standard Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial). This model "extends" AuthenticationKeyReference

type CreateGatewayActionOptions

type CreateGatewayActionOptions struct {
	// Direct Link Connect gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Action request.
	Action *string `json:"action,omitempty"`

	// Applicable for create_gateway_approve requests to create AS Prepends. Contains an array of AS Prepend configuration
	// information.
	AsPrepends []AsPrependTemplate `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyIdentityIntf `json:"authentication_key,omitempty"`

	// Applicable for create_gateway_approve requests to select the gateway's BFD configuration information.
	BfdConfig *GatewayBfdConfigActionTemplate `json:"bfd_config,omitempty"`

	// Applicable for create_gateway_approve requests to select the type of services this gateway is attached to. Mode
	// transit indicates this gateway will be attached to Transit Gateway Service and direct means this gateway will be
	// attached to vpc or classic connection. If unspecified on create_gateway_approve, default value direct is used. The
	// list of enumerated values for this property may expand in the future. Code and processes using this field must
	// tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ExportRouteFilters []GatewayTemplateRouteFilter `json:"export_route_filters,omitempty"`

	// Applicable for create_gateway_approve requests to select the gateway's routing option. Gateways with global routing
	// (`true`) can connect to networks outside of their associated region.
	Global *bool `json:"global,omitempty"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ImportRouteFilters []GatewayTemplateRouteFilter `json:"import_route_filters,omitempty"`

	// Applicable for create_gateway_approve requests to select the gateway's metered billing option.  When `true` gateway
	// usage is billed per gigabyte.  When `false` there is no per gigabyte usage charge, instead a flat rate is charged
	// for the gateway.
	Metered *bool `json:"metered,omitempty"`

	// Set for create_gateway_approve requests to select the gateway's resource group.  If unspecified on
	// create_gateway_approve, the account's [default resource
	// group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.
	ResourceGroup *ResourceGroupIdentity `json:"resource_group,omitempty"`

	// Specify attribute updates being approved or rejected, update_attributes_approve and update_attributes_reject actions
	// must provide an updates field that matches the gateway's current pending changes.
	Updates []GatewayActionTemplateUpdatesItemIntf `json:"updates,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayActionOptions : The CreateGatewayAction options.

func (*CreateGatewayActionOptions) SetAction

func (_options *CreateGatewayActionOptions) SetAction(action string) *CreateGatewayActionOptions

SetAction : Allow user to set Action

func (*CreateGatewayActionOptions) SetAsPrepends added in v0.34.0

func (_options *CreateGatewayActionOptions) SetAsPrepends(asPrepends []AsPrependTemplate) *CreateGatewayActionOptions

SetAsPrepends : Allow user to set AsPrepends

func (*CreateGatewayActionOptions) SetAuthenticationKey added in v0.15.0

func (_options *CreateGatewayActionOptions) SetAuthenticationKey(authenticationKey AuthenticationKeyIdentityIntf) *CreateGatewayActionOptions

SetAuthenticationKey : Allow user to set AuthenticationKey

func (*CreateGatewayActionOptions) SetBfdConfig added in v0.23.0

SetBfdConfig : Allow user to set BfdConfig

func (*CreateGatewayActionOptions) SetConnectionMode added in v0.20.0

func (_options *CreateGatewayActionOptions) SetConnectionMode(connectionMode string) *CreateGatewayActionOptions

SetConnectionMode : Allow user to set ConnectionMode

func (*CreateGatewayActionOptions) SetDefaultExportRouteFilter added in v0.39.0

func (_options *CreateGatewayActionOptions) SetDefaultExportRouteFilter(defaultExportRouteFilter string) *CreateGatewayActionOptions

SetDefaultExportRouteFilter : Allow user to set DefaultExportRouteFilter

func (*CreateGatewayActionOptions) SetDefaultImportRouteFilter added in v0.39.0

func (_options *CreateGatewayActionOptions) SetDefaultImportRouteFilter(defaultImportRouteFilter string) *CreateGatewayActionOptions

SetDefaultImportRouteFilter : Allow user to set DefaultImportRouteFilter

func (*CreateGatewayActionOptions) SetExportRouteFilters added in v0.39.0

func (_options *CreateGatewayActionOptions) SetExportRouteFilters(exportRouteFilters []GatewayTemplateRouteFilter) *CreateGatewayActionOptions

SetExportRouteFilters : Allow user to set ExportRouteFilters

func (*CreateGatewayActionOptions) SetGlobal

func (_options *CreateGatewayActionOptions) SetGlobal(global bool) *CreateGatewayActionOptions

SetGlobal : Allow user to set Global

func (*CreateGatewayActionOptions) SetHeaders

func (options *CreateGatewayActionOptions) SetHeaders(param map[string]string) *CreateGatewayActionOptions

SetHeaders : Allow user to set Headers

func (*CreateGatewayActionOptions) SetID

SetID : Allow user to set ID

func (*CreateGatewayActionOptions) SetImportRouteFilters added in v0.39.0

func (_options *CreateGatewayActionOptions) SetImportRouteFilters(importRouteFilters []GatewayTemplateRouteFilter) *CreateGatewayActionOptions

SetImportRouteFilters : Allow user to set ImportRouteFilters

func (*CreateGatewayActionOptions) SetMetered

func (_options *CreateGatewayActionOptions) SetMetered(metered bool) *CreateGatewayActionOptions

SetMetered : Allow user to set Metered

func (*CreateGatewayActionOptions) SetResourceGroup

func (_options *CreateGatewayActionOptions) SetResourceGroup(resourceGroup *ResourceGroupIdentity) *CreateGatewayActionOptions

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateGatewayActionOptions) SetUpdates

SetUpdates : Allow user to set Updates

type CreateGatewayCompletionNoticeOptions

type CreateGatewayCompletionNoticeOptions struct {
	// Direct Link Dedicated gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Completion notice PDF file.
	Upload io.ReadCloser `json:"upload,omitempty"`

	// The content type of upload.
	UploadContentType *string `json:"upload_content_type,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayCompletionNoticeOptions : The CreateGatewayCompletionNotice options.

func (*CreateGatewayCompletionNoticeOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateGatewayCompletionNoticeOptions) SetID

SetID : Allow user to set ID

func (*CreateGatewayCompletionNoticeOptions) SetUpload

SetUpload : Allow user to set Upload

func (*CreateGatewayCompletionNoticeOptions) SetUploadContentType

func (_options *CreateGatewayCompletionNoticeOptions) SetUploadContentType(uploadContentType string) *CreateGatewayCompletionNoticeOptions

SetUploadContentType : Allow user to set UploadContentType

type CreateGatewayExportRouteFilterOptions added in v0.39.0

type CreateGatewayExportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.
	Action *string `json:"action" validate:"required"`

	// IP prefix representing an address and mask length of the prefix-set.
	Prefix *string `json:"prefix" validate:"required"`

	// Identifier of the next route filter considered if a route does not match the current filter. This property builds
	// the ordering among route filters and follows semantics:
	// - When before is an identifier of a route filter that exists and is in the same collection, a route will first
	// attempt to match on the current filter before preceding to the filter referenced in this property.
	// - When a filter is created with before that matches another filter in the same collection, the existing filter will
	// take precedence. The before of the existing filter will be updated to refer to the newly created filter. The newly
	// created filter will refer to the route filter identified by the provided before.
	// - When a filter is created without a before, it takes the lowest precedence. The existing filter of lowest
	// precedence will be updated to refer to the newly created filter.
	Before *string `json:"before,omitempty"`

	// The minimum matching length of the prefix-set (mnemonic for greater than or equal to).
	Ge *int64 `json:"ge,omitempty"`

	// The maximum matching length of the prefix-set (mnemonic for less than or equal to).
	Le *int64 `json:"le,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayExportRouteFilterOptions : The CreateGatewayExportRouteFilter options.

func (*CreateGatewayExportRouteFilterOptions) SetAction added in v0.39.0

SetAction : Allow user to set Action

func (*CreateGatewayExportRouteFilterOptions) SetBefore added in v0.39.0

SetBefore : Allow user to set Before

func (*CreateGatewayExportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*CreateGatewayExportRouteFilterOptions) SetGe added in v0.39.0

SetGe : Allow user to set Ge

func (*CreateGatewayExportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*CreateGatewayExportRouteFilterOptions) SetLe added in v0.39.0

SetLe : Allow user to set Le

func (*CreateGatewayExportRouteFilterOptions) SetPrefix added in v0.39.0

SetPrefix : Allow user to set Prefix

type CreateGatewayImportRouteFilterOptions added in v0.39.0

type CreateGatewayImportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.
	Action *string `json:"action" validate:"required"`

	// IP prefix representing an address and mask length of the prefix-set.
	Prefix *string `json:"prefix" validate:"required"`

	// Identifier of the next route filter considered if a route does not match the current filter. This property builds
	// the ordering among route filters and follows semantics:
	// - When before is an identifier of a route filter that exists and is in the same collection, a route will first
	// attempt to match on the current filter before preceding to the filter referenced in this property.
	// - When a filter is created with before that matches another filter in the same collection, the existing filter will
	// take precedence. The before of the existing filter will be updated to refer to the newly created filter. The newly
	// created filter will refer to the route filter identified by the provided before.
	// - When a filter is created without a before, it takes the lowest precedence. The existing filter of lowest
	// precedence will be updated to refer to the newly created filter.
	Before *string `json:"before,omitempty"`

	// The minimum matching length of the prefix-set (mnemonic for greater than or equal to).
	Ge *int64 `json:"ge,omitempty"`

	// The maximum matching length of the prefix-set (mnemonic for less than or equal to).
	Le *int64 `json:"le,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayImportRouteFilterOptions : The CreateGatewayImportRouteFilter options.

func (*CreateGatewayImportRouteFilterOptions) SetAction added in v0.39.0

SetAction : Allow user to set Action

func (*CreateGatewayImportRouteFilterOptions) SetBefore added in v0.39.0

SetBefore : Allow user to set Before

func (*CreateGatewayImportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*CreateGatewayImportRouteFilterOptions) SetGe added in v0.39.0

SetGe : Allow user to set Ge

func (*CreateGatewayImportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*CreateGatewayImportRouteFilterOptions) SetLe added in v0.39.0

SetLe : Allow user to set Le

func (*CreateGatewayImportRouteFilterOptions) SetPrefix added in v0.39.0

SetPrefix : Allow user to set Prefix

type CreateGatewayMacsecCakOptions added in v0.51.7

type CreateGatewayMacsecCakOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// A [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).
	Key *HpcsKeyIdentity `json:"key" validate:"required"`

	// The name identifies the connectivity association key (CAK) within the MACsec key chain.
	//
	// The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive.
	//
	// This value, along with the material of the `key`, must match on the MACsec peers.
	Name *string `json:"name" validate:"required"`

	// The intended session the key will be used to secure.
	//
	// If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take
	// over.
	//
	// There must be a `primary` session CAK. A `fallback` CAK is optional.
	Session *string `json:"session" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayMacsecCakOptions : The CreateGatewayMacsecCak options.

func (*CreateGatewayMacsecCakOptions) SetHeaders added in v0.51.7

SetHeaders : Allow user to set Headers

func (*CreateGatewayMacsecCakOptions) SetID added in v0.51.7

SetID : Allow user to set ID

func (*CreateGatewayMacsecCakOptions) SetKey added in v0.51.7

SetKey : Allow user to set Key

func (*CreateGatewayMacsecCakOptions) SetName added in v0.51.7

SetName : Allow user to set Name

func (*CreateGatewayMacsecCakOptions) SetSession added in v0.51.7

SetSession : Allow user to set Session

type CreateGatewayOptions

type CreateGatewayOptions struct {
	// The Direct Link Gateway template.
	GatewayTemplate GatewayTemplateIntf `json:"GatewayTemplate" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayOptions : The CreateGateway options.

func (*CreateGatewayOptions) SetGatewayTemplate

func (_options *CreateGatewayOptions) SetGatewayTemplate(gatewayTemplate GatewayTemplateIntf) *CreateGatewayOptions

SetGatewayTemplate : Allow user to set GatewayTemplate

func (*CreateGatewayOptions) SetHeaders

func (options *CreateGatewayOptions) SetHeaders(param map[string]string) *CreateGatewayOptions

SetHeaders : Allow user to set Headers

type CreateGatewayRouteReportOptions added in v0.34.0

type CreateGatewayRouteReportOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayRouteReportOptions : The CreateGatewayRouteReport options.

func (*CreateGatewayRouteReportOptions) SetGatewayID added in v0.34.0

func (_options *CreateGatewayRouteReportOptions) SetGatewayID(gatewayID string) *CreateGatewayRouteReportOptions

SetGatewayID : Allow user to set GatewayID

func (*CreateGatewayRouteReportOptions) SetHeaders added in v0.34.0

SetHeaders : Allow user to set Headers

type CreateGatewayVirtualConnectionOptions

type CreateGatewayVirtualConnectionOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// The user-defined name for this virtual connection.  Virtual connection names are unique within a gateway.  This is
	// the name of the virtual connection itself, the network being connected may have its own name attribute.
	Name *string `json:"name" validate:"required"`

	// The type of virtual connection.
	Type *string `json:"type" validate:"required"`

	// Unique identifier of the target network.  For type=vpc virtual connections this is the CRN of the target VPC.  This
	// field does not apply to type=classic connections.
	NetworkID *string `json:"network_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateGatewayVirtualConnectionOptions : The CreateGatewayVirtualConnection options.

func (*CreateGatewayVirtualConnectionOptions) SetGatewayID

SetGatewayID : Allow user to set GatewayID

func (*CreateGatewayVirtualConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateGatewayVirtualConnectionOptions) SetName

SetName : Allow user to set Name

func (*CreateGatewayVirtualConnectionOptions) SetNetworkID

SetNetworkID : Allow user to set NetworkID

func (*CreateGatewayVirtualConnectionOptions) SetType

SetType : Allow user to set Type

type CrossConnectRouter

type CrossConnectRouter struct {
	// List of capabilities for this router.
	//
	// Listed `MacsecCapability` values indicate the router is associated with switch ports with that capability, and is
	// able to provision direct links with that capability. Multiple `MacsecCapability` values may be listed.
	Capabilities []string `json:"capabilities,omitempty"`

	// The name of the Router.
	RouterName *string `json:"router_name,omitempty"`

	// Count of existing Direct Link Dedicated gateways on this router for this account.
	TotalConnections *int64 `json:"total_connections,omitempty"`
}

CrossConnectRouter : Cross Connect Router details.

type DeleteGatewayExportRouteFilterOptions added in v0.39.0

type DeleteGatewayExportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayExportRouteFilterOptions : The DeleteGatewayExportRouteFilter options.

func (*DeleteGatewayExportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayExportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*DeleteGatewayExportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

type DeleteGatewayImportRouteFilterOptions added in v0.39.0

type DeleteGatewayImportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayImportRouteFilterOptions : The DeleteGatewayImportRouteFilter options.

func (*DeleteGatewayImportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayImportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*DeleteGatewayImportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

type DeleteGatewayMacsecCakOptions added in v0.51.7

type DeleteGatewayMacsecCakOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// MACsec CAK identifier.
	CakID *string `json:"cak_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayMacsecCakOptions : The DeleteGatewayMacsecCak options.

func (*DeleteGatewayMacsecCakOptions) SetCakID added in v0.51.7

SetCakID : Allow user to set CakID

func (*DeleteGatewayMacsecCakOptions) SetHeaders added in v0.51.7

SetHeaders : Allow user to set Headers

func (*DeleteGatewayMacsecCakOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type DeleteGatewayOptions

type DeleteGatewayOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayOptions : The DeleteGateway options.

func (*DeleteGatewayOptions) SetHeaders

func (options *DeleteGatewayOptions) SetHeaders(param map[string]string) *DeleteGatewayOptions

SetHeaders : Allow user to set Headers

func (*DeleteGatewayOptions) SetID

func (_options *DeleteGatewayOptions) SetID(id string) *DeleteGatewayOptions

SetID : Allow user to set ID

type DeleteGatewayRouteReportOptions added in v0.34.0

type DeleteGatewayRouteReportOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Route report identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayRouteReportOptions : The DeleteGatewayRouteReport options.

func (*DeleteGatewayRouteReportOptions) SetGatewayID added in v0.34.0

func (_options *DeleteGatewayRouteReportOptions) SetGatewayID(gatewayID string) *DeleteGatewayRouteReportOptions

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayRouteReportOptions) SetHeaders added in v0.34.0

SetHeaders : Allow user to set Headers

func (*DeleteGatewayRouteReportOptions) SetID added in v0.34.0

SetID : Allow user to set ID

type DeleteGatewayVirtualConnectionOptions

type DeleteGatewayVirtualConnectionOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// The virtual connection identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteGatewayVirtualConnectionOptions : The DeleteGatewayVirtualConnection options.

func (*DeleteGatewayVirtualConnectionOptions) SetGatewayID

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayVirtualConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*DeleteGatewayVirtualConnectionOptions) SetID

SetID : Allow user to set ID

type DirectLinkV1

type DirectLinkV1 struct {
	Service *core.BaseService

	// Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2019-12-13 up to the current
	// date may be provided. Specify the current date to request the latest version.
	Version *string
}

DirectLinkV1 : No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

API Version: __VERSION__

func NewDirectLinkV1

func NewDirectLinkV1(options *DirectLinkV1Options) (service *DirectLinkV1, err error)

NewDirectLinkV1 : constructs an instance of DirectLinkV1 with passed in options.

func NewDirectLinkV1UsingExternalConfig

func NewDirectLinkV1UsingExternalConfig(options *DirectLinkV1Options) (directLink *DirectLinkV1, err error)

NewDirectLinkV1UsingExternalConfig : constructs an instance of DirectLinkV1 with passed in options and external configuration.

func (*DirectLinkV1) Clone added in v0.15.0

func (directLink *DirectLinkV1) Clone() *DirectLinkV1

Clone makes a copy of "directLink" suitable for processing requests.

func (*DirectLinkV1) CreateGateway

func (directLink *DirectLinkV1) CreateGateway(createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)

CreateGateway : Create gateway Creates a Direct Link gateway based on the supplied template.

func (*DirectLinkV1) CreateGatewayAction

func (directLink *DirectLinkV1) CreateGatewayAction(createGatewayActionOptions *CreateGatewayActionOptions) (result *Gateway, response *core.DetailedResponse, err error)

CreateGatewayAction : Approve or reject change requests Approve or reject a gateway's current oustanding change request.

This API is only used for provider created Direct Link Connect gateways to approve or reject specific changes initiated from a provider portal.

func (*DirectLinkV1) CreateGatewayActionWithContext added in v0.15.0

func (directLink *DirectLinkV1) CreateGatewayActionWithContext(ctx context.Context, createGatewayActionOptions *CreateGatewayActionOptions) (result *Gateway, response *core.DetailedResponse, err error)

CreateGatewayActionWithContext is an alternate form of the CreateGatewayAction method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayCompletionNotice

func (directLink *DirectLinkV1) CreateGatewayCompletionNotice(createGatewayCompletionNoticeOptions *CreateGatewayCompletionNoticeOptions) (response *core.DetailedResponse, err error)

CreateGatewayCompletionNotice : Create completion notice Upload a Direct Link Dedicated gateway completion notice.

func (*DirectLinkV1) CreateGatewayCompletionNoticeWithContext added in v0.15.0

func (directLink *DirectLinkV1) CreateGatewayCompletionNoticeWithContext(ctx context.Context, createGatewayCompletionNoticeOptions *CreateGatewayCompletionNoticeOptions) (response *core.DetailedResponse, err error)

CreateGatewayCompletionNoticeWithContext is an alternate form of the CreateGatewayCompletionNotice method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayExportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) CreateGatewayExportRouteFilter(createGatewayExportRouteFilterOptions *CreateGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

CreateGatewayExportRouteFilter : Create an export route filter Create a new export route filter to be configured on the Direct Link gateway.

This call can result in an implicit update to another route filter's `before` field.

If the request's route filter template does not contain a `before` field, the created filter will be added to the end of of the list. The filter previously at the end of the list will have it's `before` field set to the created route filter.

If the request's route filter template contains a `before` field, the created filter will be added directly before that specified route filter. If the specified route filter has a preceding route filter, that filter's `before` field is updated to the created route filter.

func (*DirectLinkV1) CreateGatewayExportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) CreateGatewayExportRouteFilterWithContext(ctx context.Context, createGatewayExportRouteFilterOptions *CreateGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

CreateGatewayExportRouteFilterWithContext is an alternate form of the CreateGatewayExportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayImportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) CreateGatewayImportRouteFilter(createGatewayImportRouteFilterOptions *CreateGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

CreateGatewayImportRouteFilter : Create an import route filter Create a new import route filter to be configured on the Direct Link gateway.

This call can result in an implicit update to another route filter's `before` field.

If the request's route filter template does not contain a `before` field, the created filter will be added to the end of of the list. The filter previously at the end of the list will have it's `before` field set to the created route filter.

If the request's route filter template contains a `before` field, the created filter will be added directly before that specified route filter. If the specified route filter has a preceding route filter, that filter's `before` field is updated to the created route filter.

func (*DirectLinkV1) CreateGatewayImportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) CreateGatewayImportRouteFilterWithContext(ctx context.Context, createGatewayImportRouteFilterOptions *CreateGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

CreateGatewayImportRouteFilterWithContext is an alternate form of the CreateGatewayImportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayMacsecCak added in v0.51.7

func (directLink *DirectLinkV1) CreateGatewayMacsecCak(createGatewayMacsecCakOptions *CreateGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

CreateGatewayMacsecCak : Create MACsec CAK Creates a CAK associated with the MACsec configuration of a direct link.

func (*DirectLinkV1) CreateGatewayMacsecCakWithContext added in v0.51.7

func (directLink *DirectLinkV1) CreateGatewayMacsecCakWithContext(ctx context.Context, createGatewayMacsecCakOptions *CreateGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

CreateGatewayMacsecCakWithContext is an alternate form of the CreateGatewayMacsecCak method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayRouteReport added in v0.34.0

func (directLink *DirectLinkV1) CreateGatewayRouteReport(createGatewayRouteReportOptions *CreateGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

CreateGatewayRouteReport : Request a route report Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report. While `status` is `pending`, `gateway_routes`, `on_prem_routes`, `virtual_connection_routes`, and `overlapping_routes` will be empty arrays. These fields will be filled when the `status` enters the `complete` status. Call `get_gateway_route_report` with the pending route report's `id` to check on the current status of the report.

func (*DirectLinkV1) CreateGatewayRouteReportWithContext added in v0.34.0

func (directLink *DirectLinkV1) CreateGatewayRouteReportWithContext(ctx context.Context, createGatewayRouteReportOptions *CreateGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

CreateGatewayRouteReportWithContext is an alternate form of the CreateGatewayRouteReport method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayVirtualConnection

func (directLink *DirectLinkV1) CreateGatewayVirtualConnection(createGatewayVirtualConnectionOptions *CreateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

CreateGatewayVirtualConnection : Create virtual connection Create a virtual connection to the specified network.

func (*DirectLinkV1) CreateGatewayVirtualConnectionWithContext added in v0.15.0

func (directLink *DirectLinkV1) CreateGatewayVirtualConnectionWithContext(ctx context.Context, createGatewayVirtualConnectionOptions *CreateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

CreateGatewayVirtualConnectionWithContext is an alternate form of the CreateGatewayVirtualConnection method which supports a Context parameter

func (*DirectLinkV1) CreateGatewayWithContext added in v0.15.0

func (directLink *DirectLinkV1) CreateGatewayWithContext(ctx context.Context, createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)

CreateGatewayWithContext is an alternate form of the CreateGateway method which supports a Context parameter

func (*DirectLinkV1) DeleteGateway

func (directLink *DirectLinkV1) DeleteGateway(deleteGatewayOptions *DeleteGatewayOptions) (response *core.DetailedResponse, err error)

DeleteGateway : Delete gateway Delete a Direct Link gateway.

func (*DirectLinkV1) DeleteGatewayExportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) DeleteGatewayExportRouteFilter(deleteGatewayExportRouteFilterOptions *DeleteGatewayExportRouteFilterOptions) (response *core.DetailedResponse, err error)

DeleteGatewayExportRouteFilter : Remove export route filter from Direct Link gateway Delete an export route filter.

Deleting an export route filter will implicitly update the preceding filter's `before` field to the filter that follows the deleted filter. The preceding filter will result with an empty `before` field if there is no filter following the deleted route filter.

func (*DirectLinkV1) DeleteGatewayExportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) DeleteGatewayExportRouteFilterWithContext(ctx context.Context, deleteGatewayExportRouteFilterOptions *DeleteGatewayExportRouteFilterOptions) (response *core.DetailedResponse, err error)

DeleteGatewayExportRouteFilterWithContext is an alternate form of the DeleteGatewayExportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) DeleteGatewayImportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) DeleteGatewayImportRouteFilter(deleteGatewayImportRouteFilterOptions *DeleteGatewayImportRouteFilterOptions) (response *core.DetailedResponse, err error)

DeleteGatewayImportRouteFilter : Remove import route filter from Direct Link gateway Delete an import route filter.

Deleting an import route filter will implicitly update the preceding filter's `before` field to the filter that follows the deleted filter. The preceding filter will result with an empty `before` field if there is no filter following the deleted route filter.

func (*DirectLinkV1) DeleteGatewayImportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) DeleteGatewayImportRouteFilterWithContext(ctx context.Context, deleteGatewayImportRouteFilterOptions *DeleteGatewayImportRouteFilterOptions) (response *core.DetailedResponse, err error)

DeleteGatewayImportRouteFilterWithContext is an alternate form of the DeleteGatewayImportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) DeleteGatewayMacsecCak added in v0.51.7

func (directLink *DirectLinkV1) DeleteGatewayMacsecCak(deleteGatewayMacsecCakOptions *DeleteGatewayMacsecCakOptions) (response *core.DetailedResponse, err error)

DeleteGatewayMacsecCak : Delete MACsec CAK Deletes the CAK from the MACsec configuration of a direct link.

func (*DirectLinkV1) DeleteGatewayMacsecCakWithContext added in v0.51.7

func (directLink *DirectLinkV1) DeleteGatewayMacsecCakWithContext(ctx context.Context, deleteGatewayMacsecCakOptions *DeleteGatewayMacsecCakOptions) (response *core.DetailedResponse, err error)

DeleteGatewayMacsecCakWithContext is an alternate form of the DeleteGatewayMacsecCak method which supports a Context parameter

func (*DirectLinkV1) DeleteGatewayRouteReport added in v0.34.0

func (directLink *DirectLinkV1) DeleteGatewayRouteReport(deleteGatewayRouteReportOptions *DeleteGatewayRouteReportOptions) (response *core.DetailedResponse, err error)

DeleteGatewayRouteReport : Delete route report Delete a route report.

func (*DirectLinkV1) DeleteGatewayRouteReportWithContext added in v0.34.0

func (directLink *DirectLinkV1) DeleteGatewayRouteReportWithContext(ctx context.Context, deleteGatewayRouteReportOptions *DeleteGatewayRouteReportOptions) (response *core.DetailedResponse, err error)

DeleteGatewayRouteReportWithContext is an alternate form of the DeleteGatewayRouteReport method which supports a Context parameter

func (*DirectLinkV1) DeleteGatewayVirtualConnection

func (directLink *DirectLinkV1) DeleteGatewayVirtualConnection(deleteGatewayVirtualConnectionOptions *DeleteGatewayVirtualConnectionOptions) (response *core.DetailedResponse, err error)

DeleteGatewayVirtualConnection : Delete virtual connection Delete the virtual connection.

func (*DirectLinkV1) DeleteGatewayVirtualConnectionWithContext added in v0.15.0

func (directLink *DirectLinkV1) DeleteGatewayVirtualConnectionWithContext(ctx context.Context, deleteGatewayVirtualConnectionOptions *DeleteGatewayVirtualConnectionOptions) (response *core.DetailedResponse, err error)

DeleteGatewayVirtualConnectionWithContext is an alternate form of the DeleteGatewayVirtualConnection method which supports a Context parameter

func (*DirectLinkV1) DeleteGatewayWithContext added in v0.15.0

func (directLink *DirectLinkV1) DeleteGatewayWithContext(ctx context.Context, deleteGatewayOptions *DeleteGatewayOptions) (response *core.DetailedResponse, err error)

DeleteGatewayWithContext is an alternate form of the DeleteGateway method which supports a Context parameter

func (*DirectLinkV1) DisableRetries added in v0.15.0

func (directLink *DirectLinkV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*DirectLinkV1) EnableRetries added in v0.15.0

func (directLink *DirectLinkV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*DirectLinkV1) GetEnableGzipCompression added in v0.15.0

func (directLink *DirectLinkV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*DirectLinkV1) GetGateway

func (directLink *DirectLinkV1) GetGateway(getGatewayOptions *GetGatewayOptions) (result GetGatewayResponseIntf, response *core.DetailedResponse, err error)

GetGateway : Get gateway Retrieve a Direct Link gateway.

func (*DirectLinkV1) GetGatewayExportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) GetGatewayExportRouteFilter(getGatewayExportRouteFilterOptions *GetGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

GetGatewayExportRouteFilter : Retrieves the specified Direct Link gateway export route filter Retrieve an export route filter from the Direct Link gateway.

func (*DirectLinkV1) GetGatewayExportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) GetGatewayExportRouteFilterWithContext(ctx context.Context, getGatewayExportRouteFilterOptions *GetGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

GetGatewayExportRouteFilterWithContext is an alternate form of the GetGatewayExportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) GetGatewayImportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) GetGatewayImportRouteFilter(getGatewayImportRouteFilterOptions *GetGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

GetGatewayImportRouteFilter : Retrieves the specified Direct Link gateway import route filter Retrieve an import route filter from the Direct Link gateway.

func (*DirectLinkV1) GetGatewayImportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) GetGatewayImportRouteFilterWithContext(ctx context.Context, getGatewayImportRouteFilterOptions *GetGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

GetGatewayImportRouteFilterWithContext is an alternate form of the GetGatewayImportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) GetGatewayMacsec added in v0.51.7

func (directLink *DirectLinkV1) GetGatewayMacsec(getGatewayMacsecOptions *GetGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

GetGatewayMacsec : Get MACsec configuration Retrieve the MACsec configuration of a direct link.

func (*DirectLinkV1) GetGatewayMacsecCak added in v0.51.7

func (directLink *DirectLinkV1) GetGatewayMacsecCak(getGatewayMacsecCakOptions *GetGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

GetGatewayMacsecCak : Get MACsec CAK Get a MACsec CAK by its identifier.

func (*DirectLinkV1) GetGatewayMacsecCakWithContext added in v0.51.7

func (directLink *DirectLinkV1) GetGatewayMacsecCakWithContext(ctx context.Context, getGatewayMacsecCakOptions *GetGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

GetGatewayMacsecCakWithContext is an alternate form of the GetGatewayMacsecCak method which supports a Context parameter

func (*DirectLinkV1) GetGatewayMacsecWithContext added in v0.51.7

func (directLink *DirectLinkV1) GetGatewayMacsecWithContext(ctx context.Context, getGatewayMacsecOptions *GetGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

GetGatewayMacsecWithContext is an alternate form of the GetGatewayMacsec method which supports a Context parameter

func (*DirectLinkV1) GetGatewayRouteReport added in v0.34.0

func (directLink *DirectLinkV1) GetGatewayRouteReport(getGatewayRouteReportOptions *GetGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

GetGatewayRouteReport : Retrieve route report Retrieve a route report.

func (*DirectLinkV1) GetGatewayRouteReportWithContext added in v0.34.0

func (directLink *DirectLinkV1) GetGatewayRouteReportWithContext(ctx context.Context, getGatewayRouteReportOptions *GetGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

GetGatewayRouteReportWithContext is an alternate form of the GetGatewayRouteReport method which supports a Context parameter

func (*DirectLinkV1) GetGatewayStatistics added in v0.11.0

func (directLink *DirectLinkV1) GetGatewayStatistics(getGatewayStatisticsOptions *GetGatewayStatisticsOptions) (result *GatewayStatisticCollection, response *core.DetailedResponse, err error)

GetGatewayStatistics : Gateway statistics/debug information Retrieve gateway statistics or debug information. Specify statistic to retrieve using required `type` query parameter.

func (*DirectLinkV1) GetGatewayStatisticsWithContext added in v0.15.0

func (directLink *DirectLinkV1) GetGatewayStatisticsWithContext(ctx context.Context, getGatewayStatisticsOptions *GetGatewayStatisticsOptions) (result *GatewayStatisticCollection, response *core.DetailedResponse, err error)

GetGatewayStatisticsWithContext is an alternate form of the GetGatewayStatistics method which supports a Context parameter

func (*DirectLinkV1) GetGatewayStatus added in v0.23.0

func (directLink *DirectLinkV1) GetGatewayStatus(getGatewayStatusOptions *GetGatewayStatusOptions) (result *GatewayStatusCollection, response *core.DetailedResponse, err error)

GetGatewayStatus : Gateway status information Retrieve gateway status. Specify status to retrieve using required `type` query parameter.

func (*DirectLinkV1) GetGatewayStatusWithContext added in v0.23.0

func (directLink *DirectLinkV1) GetGatewayStatusWithContext(ctx context.Context, getGatewayStatusOptions *GetGatewayStatusOptions) (result *GatewayStatusCollection, response *core.DetailedResponse, err error)

GetGatewayStatusWithContext is an alternate form of the GetGatewayStatus method which supports a Context parameter

func (*DirectLinkV1) GetGatewayVirtualConnection

func (directLink *DirectLinkV1) GetGatewayVirtualConnection(getGatewayVirtualConnectionOptions *GetGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

GetGatewayVirtualConnection : Get virtual connection Retrieve a virtual connection.

func (*DirectLinkV1) GetGatewayVirtualConnectionWithContext added in v0.15.0

func (directLink *DirectLinkV1) GetGatewayVirtualConnectionWithContext(ctx context.Context, getGatewayVirtualConnectionOptions *GetGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

GetGatewayVirtualConnectionWithContext is an alternate form of the GetGatewayVirtualConnection method which supports a Context parameter

func (*DirectLinkV1) GetGatewayWithContext added in v0.15.0

func (directLink *DirectLinkV1) GetGatewayWithContext(ctx context.Context, getGatewayOptions *GetGatewayOptions) (result GetGatewayResponseIntf, response *core.DetailedResponse, err error)

GetGatewayWithContext is an alternate form of the GetGateway method which supports a Context parameter

func (*DirectLinkV1) GetPort

func (directLink *DirectLinkV1) GetPort(getPortOptions *GetPortOptions) (result *Port, response *core.DetailedResponse, err error)

GetPort : Get port Retrieve Direct Link Connect provider port.

func (*DirectLinkV1) GetPortWithContext added in v0.15.0

func (directLink *DirectLinkV1) GetPortWithContext(ctx context.Context, getPortOptions *GetPortOptions) (result *Port, response *core.DetailedResponse, err error)

GetPortWithContext is an alternate form of the GetPort method which supports a Context parameter

func (*DirectLinkV1) GetServiceURL added in v0.15.0

func (directLink *DirectLinkV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*DirectLinkV1) ListGatewayAsPrepends added in v0.35.0

func (directLink *DirectLinkV1) ListGatewayAsPrepends(listGatewayAsPrependsOptions *ListGatewayAsPrependsOptions) (result *AsPrependCollection, response *core.DetailedResponse, err error)

ListGatewayAsPrepends : List AS Prepends Retrieve all AS Prepends for the specified Direct Link gateway.

func (*DirectLinkV1) ListGatewayAsPrependsWithContext added in v0.35.0

func (directLink *DirectLinkV1) ListGatewayAsPrependsWithContext(ctx context.Context, listGatewayAsPrependsOptions *ListGatewayAsPrependsOptions) (result *AsPrependCollection, response *core.DetailedResponse, err error)

ListGatewayAsPrependsWithContext is an alternate form of the ListGatewayAsPrepends method which supports a Context parameter

func (*DirectLinkV1) ListGatewayCompletionNotice

func (directLink *DirectLinkV1) ListGatewayCompletionNotice(listGatewayCompletionNoticeOptions *ListGatewayCompletionNoticeOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

ListGatewayCompletionNotice : Get completion notice Retrieve a Direct Link Dedicated gateway's completion notice.

func (*DirectLinkV1) ListGatewayCompletionNoticeWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListGatewayCompletionNoticeWithContext(ctx context.Context, listGatewayCompletionNoticeOptions *ListGatewayCompletionNoticeOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

ListGatewayCompletionNoticeWithContext is an alternate form of the ListGatewayCompletionNotice method which supports a Context parameter

func (*DirectLinkV1) ListGatewayExportRouteFilters added in v0.39.0

func (directLink *DirectLinkV1) ListGatewayExportRouteFilters(listGatewayExportRouteFiltersOptions *ListGatewayExportRouteFiltersOptions) (result *ExportRouteFilterCollection, response *core.DetailedResponse, err error)

ListGatewayExportRouteFilters : List export route filters List all export route filters that influence the export routes advertised to the on premises network and learned from attached virtual connections of the Direct Link gateway.

The first export route filter an export route matches will determine whether the route is permitted or denied to be advertised by the Direct Link gateway. Route filter order is determined by the filter's `before` field.

If an export route does not match any of the export route filters, the route is subject to the `default_export_route_filter` of the direct link.

func (*DirectLinkV1) ListGatewayExportRouteFiltersWithContext added in v0.39.0

func (directLink *DirectLinkV1) ListGatewayExportRouteFiltersWithContext(ctx context.Context, listGatewayExportRouteFiltersOptions *ListGatewayExportRouteFiltersOptions) (result *ExportRouteFilterCollection, response *core.DetailedResponse, err error)

ListGatewayExportRouteFiltersWithContext is an alternate form of the ListGatewayExportRouteFilters method which supports a Context parameter

func (*DirectLinkV1) ListGatewayImportRouteFilters added in v0.39.0

func (directLink *DirectLinkV1) ListGatewayImportRouteFilters(listGatewayImportRouteFiltersOptions *ListGatewayImportRouteFiltersOptions) (result *ImportRouteFilterCollection, response *core.DetailedResponse, err error)

ListGatewayImportRouteFilters : List import route filters List all import route filters that influence the import routes learned from the on premises network.

The first import route filter an import route matches will determine whether the route is permitted or denied to be learned by the Direct Link gateway. Route filter order is determined by the filter's `before` field.

If an import route does not match any of the import route filters, the route is subject to the `default_import_route_filter` of the direct link.

func (*DirectLinkV1) ListGatewayImportRouteFiltersWithContext added in v0.39.0

func (directLink *DirectLinkV1) ListGatewayImportRouteFiltersWithContext(ctx context.Context, listGatewayImportRouteFiltersOptions *ListGatewayImportRouteFiltersOptions) (result *ImportRouteFilterCollection, response *core.DetailedResponse, err error)

ListGatewayImportRouteFiltersWithContext is an alternate form of the ListGatewayImportRouteFilters method which supports a Context parameter

func (*DirectLinkV1) ListGatewayLetterOfAuthorization

func (directLink *DirectLinkV1) ListGatewayLetterOfAuthorization(listGatewayLetterOfAuthorizationOptions *ListGatewayLetterOfAuthorizationOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

ListGatewayLetterOfAuthorization : Get letter of authorization Retrieve a Direct Link Dedicated gateway's Letter of Authorization.

func (*DirectLinkV1) ListGatewayLetterOfAuthorizationWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListGatewayLetterOfAuthorizationWithContext(ctx context.Context, listGatewayLetterOfAuthorizationOptions *ListGatewayLetterOfAuthorizationOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

ListGatewayLetterOfAuthorizationWithContext is an alternate form of the ListGatewayLetterOfAuthorization method which supports a Context parameter

func (*DirectLinkV1) ListGatewayMacsecCaks added in v0.51.7

func (directLink *DirectLinkV1) ListGatewayMacsecCaks(listGatewayMacsecCaksOptions *ListGatewayMacsecCaksOptions) (result *GatewayMacsecCakCollection, response *core.DetailedResponse, err error)

ListGatewayMacsecCaks : List MACsec CAKs List the CAKs associated with the MACsec configuration of a direct link.

func (*DirectLinkV1) ListGatewayMacsecCaksWithContext added in v0.51.7

func (directLink *DirectLinkV1) ListGatewayMacsecCaksWithContext(ctx context.Context, listGatewayMacsecCaksOptions *ListGatewayMacsecCaksOptions) (result *GatewayMacsecCakCollection, response *core.DetailedResponse, err error)

ListGatewayMacsecCaksWithContext is an alternate form of the ListGatewayMacsecCaks method which supports a Context parameter

func (*DirectLinkV1) ListGatewayRouteReports added in v0.34.0

func (directLink *DirectLinkV1) ListGatewayRouteReports(listGatewayRouteReportsOptions *ListGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)

ListGatewayRouteReports : List route reports Retrieve all route reports for the specified Direct Link gateway.

func (*DirectLinkV1) ListGatewayRouteReportsWithContext added in v0.34.0

func (directLink *DirectLinkV1) ListGatewayRouteReportsWithContext(ctx context.Context, listGatewayRouteReportsOptions *ListGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)

ListGatewayRouteReportsWithContext is an alternate form of the ListGatewayRouteReports method which supports a Context parameter

func (*DirectLinkV1) ListGatewayVirtualConnections

func (directLink *DirectLinkV1) ListGatewayVirtualConnections(listGatewayVirtualConnectionsOptions *ListGatewayVirtualConnectionsOptions) (result *GatewayVirtualConnectionCollection, response *core.DetailedResponse, err error)

ListGatewayVirtualConnections : List virtual connections List a gateway's virtual connections. For gateway in other account with virtual connections that connect to network in this account. Only virtual connections that connect to this account are returned.

func (*DirectLinkV1) ListGatewayVirtualConnectionsWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListGatewayVirtualConnectionsWithContext(ctx context.Context, listGatewayVirtualConnectionsOptions *ListGatewayVirtualConnectionsOptions) (result *GatewayVirtualConnectionCollection, response *core.DetailedResponse, err error)

ListGatewayVirtualConnectionsWithContext is an alternate form of the ListGatewayVirtualConnections method which supports a Context parameter

func (*DirectLinkV1) ListGateways

func (directLink *DirectLinkV1) ListGateways(listGatewaysOptions *ListGatewaysOptions) (result *GatewayCollection, response *core.DetailedResponse, err error)

ListGateways : List gateways List all Direct Link gateways in this account. Gateways in other accounts with connections to networks in this account are also returned.

func (*DirectLinkV1) ListGatewaysWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListGatewaysWithContext(ctx context.Context, listGatewaysOptions *ListGatewaysOptions) (result *GatewayCollection, response *core.DetailedResponse, err error)

ListGatewaysWithContext is an alternate form of the ListGateways method which supports a Context parameter

func (*DirectLinkV1) ListOfferingTypeLocationCrossConnectRouters

func (directLink *DirectLinkV1) ListOfferingTypeLocationCrossConnectRouters(listOfferingTypeLocationCrossConnectRoutersOptions *ListOfferingTypeLocationCrossConnectRoutersOptions) (result *LocationCrossConnectRouterCollection, response *core.DetailedResponse, err error)

ListOfferingTypeLocationCrossConnectRouters : List routers Retrieve location specific cross connect router information. Only valid for offering_type=dedicated locations.

func (*DirectLinkV1) ListOfferingTypeLocationCrossConnectRoutersWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListOfferingTypeLocationCrossConnectRoutersWithContext(ctx context.Context, listOfferingTypeLocationCrossConnectRoutersOptions *ListOfferingTypeLocationCrossConnectRoutersOptions) (result *LocationCrossConnectRouterCollection, response *core.DetailedResponse, err error)

ListOfferingTypeLocationCrossConnectRoutersWithContext is an alternate form of the ListOfferingTypeLocationCrossConnectRouters method which supports a Context parameter

func (*DirectLinkV1) ListOfferingTypeLocations

func (directLink *DirectLinkV1) ListOfferingTypeLocations(listOfferingTypeLocationsOptions *ListOfferingTypeLocationsOptions) (result *LocationCollection, response *core.DetailedResponse, err error)

ListOfferingTypeLocations : List available locations Retrieve the list of valid locations for the specified Direct Link offering.

func (*DirectLinkV1) ListOfferingTypeLocationsWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListOfferingTypeLocationsWithContext(ctx context.Context, listOfferingTypeLocationsOptions *ListOfferingTypeLocationsOptions) (result *LocationCollection, response *core.DetailedResponse, err error)

ListOfferingTypeLocationsWithContext is an alternate form of the ListOfferingTypeLocations method which supports a Context parameter

func (*DirectLinkV1) ListOfferingTypeSpeeds

func (directLink *DirectLinkV1) ListOfferingTypeSpeeds(listOfferingTypeSpeedsOptions *ListOfferingTypeSpeedsOptions) (result *OfferingSpeedCollection, response *core.DetailedResponse, err error)

ListOfferingTypeSpeeds : List speed options List the available Direct Link speeds.

func (*DirectLinkV1) ListOfferingTypeSpeedsWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListOfferingTypeSpeedsWithContext(ctx context.Context, listOfferingTypeSpeedsOptions *ListOfferingTypeSpeedsOptions) (result *OfferingSpeedCollection, response *core.DetailedResponse, err error)

ListOfferingTypeSpeedsWithContext is an alternate form of the ListOfferingTypeSpeeds method which supports a Context parameter

func (*DirectLinkV1) ListPorts

func (directLink *DirectLinkV1) ListPorts(listPortsOptions *ListPortsOptions) (result *PortCollection, response *core.DetailedResponse, err error)

ListPorts : List ports Retrieve list of available Direct Link connect ports. These ports can be used to create Direct Link connect gateways.

func (*DirectLinkV1) ListPortsWithContext added in v0.15.0

func (directLink *DirectLinkV1) ListPortsWithContext(ctx context.Context, listPortsOptions *ListPortsOptions) (result *PortCollection, response *core.DetailedResponse, err error)

ListPortsWithContext is an alternate form of the ListPorts method which supports a Context parameter

func (*DirectLinkV1) NewAsPrependPrefixArrayTemplate added in v0.35.0

func (*DirectLinkV1) NewAsPrependPrefixArrayTemplate(length int64, policy string) (_model *AsPrependPrefixArrayTemplate, err error)

NewAsPrependPrefixArrayTemplate : Instantiate AsPrependPrefixArrayTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewAsPrependTemplate added in v0.34.0

func (*DirectLinkV1) NewAsPrependTemplate(length int64, policy string) (_model *AsPrependTemplate, err error)

NewAsPrependTemplate : Instantiate AsPrependTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity added in v0.51.7

func (*DirectLinkV1) NewAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity(crn string) (_model *AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity, err error)

NewAuthenticationKeyIdentityHpcsAuthenticationKeyIdentity : Instantiate AuthenticationKeyIdentityHpcsAuthenticationKeyIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity added in v0.51.7

func (*DirectLinkV1) NewAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity(crn string) (_model *AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity, err error)

NewAuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity : Instantiate AuthenticationKeyIdentityKeyProtectAuthenticationKeyIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewCreateGatewayActionOptions

func (*DirectLinkV1) NewCreateGatewayActionOptions(id string) *CreateGatewayActionOptions

NewCreateGatewayActionOptions : Instantiate CreateGatewayActionOptions

func (*DirectLinkV1) NewCreateGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewCreateGatewayCompletionNoticeOptions(id string) *CreateGatewayCompletionNoticeOptions

NewCreateGatewayCompletionNoticeOptions : Instantiate CreateGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewCreateGatewayExportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewCreateGatewayExportRouteFilterOptions(gatewayID string, action string, prefix string) *CreateGatewayExportRouteFilterOptions

NewCreateGatewayExportRouteFilterOptions : Instantiate CreateGatewayExportRouteFilterOptions

func (*DirectLinkV1) NewCreateGatewayImportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewCreateGatewayImportRouteFilterOptions(gatewayID string, action string, prefix string) *CreateGatewayImportRouteFilterOptions

NewCreateGatewayImportRouteFilterOptions : Instantiate CreateGatewayImportRouteFilterOptions

func (*DirectLinkV1) NewCreateGatewayMacsecCakOptions added in v0.51.7

func (*DirectLinkV1) NewCreateGatewayMacsecCakOptions(id string, key *HpcsKeyIdentity, name string, session string) *CreateGatewayMacsecCakOptions

NewCreateGatewayMacsecCakOptions : Instantiate CreateGatewayMacsecCakOptions

func (*DirectLinkV1) NewCreateGatewayOptions

func (*DirectLinkV1) NewCreateGatewayOptions(gatewayTemplate GatewayTemplateIntf) *CreateGatewayOptions

NewCreateGatewayOptions : Instantiate CreateGatewayOptions

func (*DirectLinkV1) NewCreateGatewayRouteReportOptions added in v0.34.0

func (*DirectLinkV1) NewCreateGatewayRouteReportOptions(gatewayID string) *CreateGatewayRouteReportOptions

NewCreateGatewayRouteReportOptions : Instantiate CreateGatewayRouteReportOptions

func (*DirectLinkV1) NewCreateGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewCreateGatewayVirtualConnectionOptions(gatewayID string, name string, typeVar string) *CreateGatewayVirtualConnectionOptions

NewCreateGatewayVirtualConnectionOptions : Instantiate CreateGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewDeleteGatewayExportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewDeleteGatewayExportRouteFilterOptions(gatewayID string, id string) *DeleteGatewayExportRouteFilterOptions

NewDeleteGatewayExportRouteFilterOptions : Instantiate DeleteGatewayExportRouteFilterOptions

func (*DirectLinkV1) NewDeleteGatewayImportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewDeleteGatewayImportRouteFilterOptions(gatewayID string, id string) *DeleteGatewayImportRouteFilterOptions

NewDeleteGatewayImportRouteFilterOptions : Instantiate DeleteGatewayImportRouteFilterOptions

func (*DirectLinkV1) NewDeleteGatewayMacsecCakOptions added in v0.51.7

func (*DirectLinkV1) NewDeleteGatewayMacsecCakOptions(id string, cakID string) *DeleteGatewayMacsecCakOptions

NewDeleteGatewayMacsecCakOptions : Instantiate DeleteGatewayMacsecCakOptions

func (*DirectLinkV1) NewDeleteGatewayOptions

func (*DirectLinkV1) NewDeleteGatewayOptions(id string) *DeleteGatewayOptions

NewDeleteGatewayOptions : Instantiate DeleteGatewayOptions

func (*DirectLinkV1) NewDeleteGatewayRouteReportOptions added in v0.34.0

func (*DirectLinkV1) NewDeleteGatewayRouteReportOptions(gatewayID string, id string) *DeleteGatewayRouteReportOptions

NewDeleteGatewayRouteReportOptions : Instantiate DeleteGatewayRouteReportOptions

func (*DirectLinkV1) NewDeleteGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewDeleteGatewayVirtualConnectionOptions(gatewayID string, id string) *DeleteGatewayVirtualConnectionOptions

NewDeleteGatewayVirtualConnectionOptions : Instantiate DeleteGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewGatewayBfdConfigActionTemplate added in v0.23.0

func (*DirectLinkV1) NewGatewayBfdConfigActionTemplate(interval int64) (_model *GatewayBfdConfigActionTemplate, err error)

NewGatewayBfdConfigActionTemplate : Instantiate GatewayBfdConfigActionTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayBfdConfigTemplate added in v0.23.0

func (*DirectLinkV1) NewGatewayBfdConfigTemplate(interval int64) (_model *GatewayBfdConfigTemplate, err error)

NewGatewayBfdConfigTemplate : Instantiate GatewayBfdConfigTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecCakPrototype added in v0.51.7

func (*DirectLinkV1) NewGatewayMacsecCakPrototype(key *HpcsKeyIdentity, name string, session string) (_model *GatewayMacsecCakPrototype, err error)

NewGatewayMacsecCakPrototype : Instantiate GatewayMacsecCakPrototype (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecPrototype added in v0.51.7

func (*DirectLinkV1) NewGatewayMacsecPrototype(active bool, caks []GatewayMacsecCakPrototype, sakRekey SakRekeyPrototypeIntf, securityPolicy string) (_model *GatewayMacsecPrototype, err error)

NewGatewayMacsecPrototype : Instantiate GatewayMacsecPrototype (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayPortIdentity

func (*DirectLinkV1) NewGatewayPortIdentity(id string) (_model *GatewayPortIdentity, err error)

NewGatewayPortIdentity : Instantiate GatewayPortIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayTemplateGatewayTypeConnectTemplate

func (*DirectLinkV1) NewGatewayTemplateGatewayTypeConnectTemplate(bgpAsn int64, global bool, metered bool, name string, speedMbps int64, typeVar string, port *GatewayPortIdentity) (_model *GatewayTemplateGatewayTypeConnectTemplate, err error)

NewGatewayTemplateGatewayTypeConnectTemplate : Instantiate GatewayTemplateGatewayTypeConnectTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayTemplateGatewayTypeDedicatedTemplate

func (*DirectLinkV1) NewGatewayTemplateGatewayTypeDedicatedTemplate(bgpAsn int64, global bool, metered bool, name string, speedMbps int64, typeVar string, carrierName string, crossConnectRouter string, customerName string, locationName string) (_model *GatewayTemplateGatewayTypeDedicatedTemplate, err error)

NewGatewayTemplateGatewayTypeDedicatedTemplate : Instantiate GatewayTemplateGatewayTypeDedicatedTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayTemplateRouteFilter added in v0.39.0

func (*DirectLinkV1) NewGatewayTemplateRouteFilter(action string, prefix string) (_model *GatewayTemplateRouteFilter, err error)

NewGatewayTemplateRouteFilter : Instantiate GatewayTemplateRouteFilter (Generic Model Constructor)

func (*DirectLinkV1) NewGetGatewayExportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewGetGatewayExportRouteFilterOptions(gatewayID string, id string) *GetGatewayExportRouteFilterOptions

NewGetGatewayExportRouteFilterOptions : Instantiate GetGatewayExportRouteFilterOptions

func (*DirectLinkV1) NewGetGatewayImportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewGetGatewayImportRouteFilterOptions(gatewayID string, id string) *GetGatewayImportRouteFilterOptions

NewGetGatewayImportRouteFilterOptions : Instantiate GetGatewayImportRouteFilterOptions

func (*DirectLinkV1) NewGetGatewayMacsecCakOptions added in v0.51.7

func (*DirectLinkV1) NewGetGatewayMacsecCakOptions(id string, cakID string) *GetGatewayMacsecCakOptions

NewGetGatewayMacsecCakOptions : Instantiate GetGatewayMacsecCakOptions

func (*DirectLinkV1) NewGetGatewayMacsecOptions added in v0.51.7

func (*DirectLinkV1) NewGetGatewayMacsecOptions(id string) *GetGatewayMacsecOptions

NewGetGatewayMacsecOptions : Instantiate GetGatewayMacsecOptions

func (*DirectLinkV1) NewGetGatewayOptions

func (*DirectLinkV1) NewGetGatewayOptions(id string) *GetGatewayOptions

NewGetGatewayOptions : Instantiate GetGatewayOptions

func (*DirectLinkV1) NewGetGatewayRouteReportOptions added in v0.34.0

func (*DirectLinkV1) NewGetGatewayRouteReportOptions(gatewayID string, id string) *GetGatewayRouteReportOptions

NewGetGatewayRouteReportOptions : Instantiate GetGatewayRouteReportOptions

func (*DirectLinkV1) NewGetGatewayStatisticsOptions added in v0.11.0

func (*DirectLinkV1) NewGetGatewayStatisticsOptions(id string, typeVar string) *GetGatewayStatisticsOptions

NewGetGatewayStatisticsOptions : Instantiate GetGatewayStatisticsOptions

func (*DirectLinkV1) NewGetGatewayStatusOptions added in v0.23.0

func (*DirectLinkV1) NewGetGatewayStatusOptions(id string) *GetGatewayStatusOptions

NewGetGatewayStatusOptions : Instantiate GetGatewayStatusOptions

func (*DirectLinkV1) NewGetGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewGetGatewayVirtualConnectionOptions(gatewayID string, id string) *GetGatewayVirtualConnectionOptions

NewGetGatewayVirtualConnectionOptions : Instantiate GetGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewGetPortOptions

func (*DirectLinkV1) NewGetPortOptions(id string) *GetPortOptions

NewGetPortOptions : Instantiate GetPortOptions

func (*DirectLinkV1) NewHpcsKeyIdentity added in v0.51.7

func (*DirectLinkV1) NewHpcsKeyIdentity(crn string) (_model *HpcsKeyIdentity, err error)

NewHpcsKeyIdentity : Instantiate HpcsKeyIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewListGatewayAsPrependsOptions added in v0.35.0

func (*DirectLinkV1) NewListGatewayAsPrependsOptions(gatewayID string) *ListGatewayAsPrependsOptions

NewListGatewayAsPrependsOptions : Instantiate ListGatewayAsPrependsOptions

func (*DirectLinkV1) NewListGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewListGatewayCompletionNoticeOptions(id string) *ListGatewayCompletionNoticeOptions

NewListGatewayCompletionNoticeOptions : Instantiate ListGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewListGatewayExportRouteFiltersOptions added in v0.39.0

func (*DirectLinkV1) NewListGatewayExportRouteFiltersOptions(gatewayID string) *ListGatewayExportRouteFiltersOptions

NewListGatewayExportRouteFiltersOptions : Instantiate ListGatewayExportRouteFiltersOptions

func (*DirectLinkV1) NewListGatewayImportRouteFiltersOptions added in v0.39.0

func (*DirectLinkV1) NewListGatewayImportRouteFiltersOptions(gatewayID string) *ListGatewayImportRouteFiltersOptions

NewListGatewayImportRouteFiltersOptions : Instantiate ListGatewayImportRouteFiltersOptions

func (*DirectLinkV1) NewListGatewayLetterOfAuthorizationOptions

func (*DirectLinkV1) NewListGatewayLetterOfAuthorizationOptions(id string) *ListGatewayLetterOfAuthorizationOptions

NewListGatewayLetterOfAuthorizationOptions : Instantiate ListGatewayLetterOfAuthorizationOptions

func (*DirectLinkV1) NewListGatewayMacsecCaksOptions added in v0.51.7

func (*DirectLinkV1) NewListGatewayMacsecCaksOptions(id string) *ListGatewayMacsecCaksOptions

NewListGatewayMacsecCaksOptions : Instantiate ListGatewayMacsecCaksOptions

func (*DirectLinkV1) NewListGatewayRouteReportsOptions added in v0.34.0

func (*DirectLinkV1) NewListGatewayRouteReportsOptions(gatewayID string) *ListGatewayRouteReportsOptions

NewListGatewayRouteReportsOptions : Instantiate ListGatewayRouteReportsOptions

func (*DirectLinkV1) NewListGatewayVirtualConnectionsOptions

func (*DirectLinkV1) NewListGatewayVirtualConnectionsOptions(gatewayID string) *ListGatewayVirtualConnectionsOptions

NewListGatewayVirtualConnectionsOptions : Instantiate ListGatewayVirtualConnectionsOptions

func (*DirectLinkV1) NewListGatewaysOptions

func (*DirectLinkV1) NewListGatewaysOptions() *ListGatewaysOptions

NewListGatewaysOptions : Instantiate ListGatewaysOptions

func (*DirectLinkV1) NewListOfferingTypeLocationCrossConnectRoutersOptions

func (*DirectLinkV1) NewListOfferingTypeLocationCrossConnectRoutersOptions(offeringType string, locationName string) *ListOfferingTypeLocationCrossConnectRoutersOptions

NewListOfferingTypeLocationCrossConnectRoutersOptions : Instantiate ListOfferingTypeLocationCrossConnectRoutersOptions

func (*DirectLinkV1) NewListOfferingTypeLocationsOptions

func (*DirectLinkV1) NewListOfferingTypeLocationsOptions(offeringType string) *ListOfferingTypeLocationsOptions

NewListOfferingTypeLocationsOptions : Instantiate ListOfferingTypeLocationsOptions

func (*DirectLinkV1) NewListOfferingTypeSpeedsOptions

func (*DirectLinkV1) NewListOfferingTypeSpeedsOptions(offeringType string) *ListOfferingTypeSpeedsOptions

NewListOfferingTypeSpeedsOptions : Instantiate ListOfferingTypeSpeedsOptions

func (*DirectLinkV1) NewListPortsOptions

func (*DirectLinkV1) NewListPortsOptions() *ListPortsOptions

NewListPortsOptions : Instantiate ListPortsOptions

func (*DirectLinkV1) NewPortsPager added in v0.39.0

func (directLink *DirectLinkV1) NewPortsPager(options *ListPortsOptions) (pager *PortsPager, err error)

NewPortsPager returns a new PortsPager instance.

func (*DirectLinkV1) NewReplaceGatewayAsPrependsOptions added in v0.35.0

func (*DirectLinkV1) NewReplaceGatewayAsPrependsOptions(gatewayID string, ifMatch string) *ReplaceGatewayAsPrependsOptions

NewReplaceGatewayAsPrependsOptions : Instantiate ReplaceGatewayAsPrependsOptions

func (*DirectLinkV1) NewReplaceGatewayExportRouteFiltersOptions added in v0.39.0

func (*DirectLinkV1) NewReplaceGatewayExportRouteFiltersOptions(gatewayID string, ifMatch string) *ReplaceGatewayExportRouteFiltersOptions

NewReplaceGatewayExportRouteFiltersOptions : Instantiate ReplaceGatewayExportRouteFiltersOptions

func (*DirectLinkV1) NewReplaceGatewayImportRouteFiltersOptions added in v0.39.0

func (*DirectLinkV1) NewReplaceGatewayImportRouteFiltersOptions(gatewayID string, ifMatch string) *ReplaceGatewayImportRouteFiltersOptions

NewReplaceGatewayImportRouteFiltersOptions : Instantiate ReplaceGatewayImportRouteFiltersOptions

func (*DirectLinkV1) NewResourceGroupIdentity

func (*DirectLinkV1) NewResourceGroupIdentity(id string) (_model *ResourceGroupIdentity, err error)

NewResourceGroupIdentity : Instantiate ResourceGroupIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewSakRekeyPatchSakRekeyPacketNumberRolloverModePatch added in v0.51.7

func (*DirectLinkV1) NewSakRekeyPatchSakRekeyPacketNumberRolloverModePatch(mode string) (_model *SakRekeyPatchSakRekeyPacketNumberRolloverModePatch, err error)

NewSakRekeyPatchSakRekeyPacketNumberRolloverModePatch : Instantiate SakRekeyPatchSakRekeyPacketNumberRolloverModePatch (Generic Model Constructor)

func (*DirectLinkV1) NewSakRekeyPatchSakRekeyTimerModePatch added in v0.51.7

func (*DirectLinkV1) NewSakRekeyPatchSakRekeyTimerModePatch(interval int64, mode string) (_model *SakRekeyPatchSakRekeyTimerModePatch, err error)

NewSakRekeyPatchSakRekeyTimerModePatch : Instantiate SakRekeyPatchSakRekeyTimerModePatch (Generic Model Constructor)

func (*DirectLinkV1) NewSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype added in v0.51.7

func (*DirectLinkV1) NewSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype(mode string) (_model *SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype, err error)

NewSakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype : Instantiate SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype (Generic Model Constructor)

func (*DirectLinkV1) NewSakRekeyPrototypeSakRekeyTimerModePrototype added in v0.51.7

func (*DirectLinkV1) NewSakRekeyPrototypeSakRekeyTimerModePrototype(interval int64, mode string) (_model *SakRekeyPrototypeSakRekeyTimerModePrototype, err error)

NewSakRekeyPrototypeSakRekeyTimerModePrototype : Instantiate SakRekeyPrototypeSakRekeyTimerModePrototype (Generic Model Constructor)

func (*DirectLinkV1) NewSetGatewayMacsecOptions added in v0.51.7

func (*DirectLinkV1) NewSetGatewayMacsecOptions(id string, active bool, caks []GatewayMacsecCakPrototype, sakRekey SakRekeyPrototypeIntf, securityPolicy string) *SetGatewayMacsecOptions

NewSetGatewayMacsecOptions : Instantiate SetGatewayMacsecOptions

func (*DirectLinkV1) NewUnsetGatewayMacsecOptions added in v0.51.7

func (*DirectLinkV1) NewUnsetGatewayMacsecOptions(id string) *UnsetGatewayMacsecOptions

NewUnsetGatewayMacsecOptions : Instantiate UnsetGatewayMacsecOptions

func (*DirectLinkV1) NewUpdateGatewayExportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewUpdateGatewayExportRouteFilterOptions(gatewayID string, id string, updateRouteFilterTemplatePatch map[string]interface{}) *UpdateGatewayExportRouteFilterOptions

NewUpdateGatewayExportRouteFilterOptions : Instantiate UpdateGatewayExportRouteFilterOptions

func (*DirectLinkV1) NewUpdateGatewayImportRouteFilterOptions added in v0.39.0

func (*DirectLinkV1) NewUpdateGatewayImportRouteFilterOptions(gatewayID string, id string, updateRouteFilterTemplatePatch map[string]interface{}) *UpdateGatewayImportRouteFilterOptions

NewUpdateGatewayImportRouteFilterOptions : Instantiate UpdateGatewayImportRouteFilterOptions

func (*DirectLinkV1) NewUpdateGatewayMacsecCakOptions added in v0.51.7

func (*DirectLinkV1) NewUpdateGatewayMacsecCakOptions(id string, cakID string, gatewayMacsecCakPatch map[string]interface{}) *UpdateGatewayMacsecCakOptions

NewUpdateGatewayMacsecCakOptions : Instantiate UpdateGatewayMacsecCakOptions

func (*DirectLinkV1) NewUpdateGatewayMacsecOptions added in v0.51.7

func (*DirectLinkV1) NewUpdateGatewayMacsecOptions(id string, gatewayMacsecPatch map[string]interface{}) *UpdateGatewayMacsecOptions

NewUpdateGatewayMacsecOptions : Instantiate UpdateGatewayMacsecOptions

func (*DirectLinkV1) NewUpdateGatewayOptions

func (*DirectLinkV1) NewUpdateGatewayOptions(id string, gatewayPatchTemplatePatch map[string]interface{}) *UpdateGatewayOptions

NewUpdateGatewayOptions : Instantiate UpdateGatewayOptions

func (*DirectLinkV1) NewUpdateGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewUpdateGatewayVirtualConnectionOptions(gatewayID string, id string, gatewayVirtualConnectionPatchTemplatePatch map[string]interface{}) *UpdateGatewayVirtualConnectionOptions

NewUpdateGatewayVirtualConnectionOptions : Instantiate UpdateGatewayVirtualConnectionOptions

func (*DirectLinkV1) ReplaceGatewayAsPrepends added in v0.35.0

func (directLink *DirectLinkV1) ReplaceGatewayAsPrepends(replaceGatewayAsPrependsOptions *ReplaceGatewayAsPrependsOptions) (result *AsPrependCollection, response *core.DetailedResponse, err error)

ReplaceGatewayAsPrepends : Replace existing AS Prepends Replace the given set of AS prepends on the specified gateway. Existing resources may be reused when the individual AS Prepend item is unchanged.

func (*DirectLinkV1) ReplaceGatewayAsPrependsWithContext added in v0.35.0

func (directLink *DirectLinkV1) ReplaceGatewayAsPrependsWithContext(ctx context.Context, replaceGatewayAsPrependsOptions *ReplaceGatewayAsPrependsOptions) (result *AsPrependCollection, response *core.DetailedResponse, err error)

ReplaceGatewayAsPrependsWithContext is an alternate form of the ReplaceGatewayAsPrepends method which supports a Context parameter

func (*DirectLinkV1) ReplaceGatewayExportRouteFilters added in v0.39.0

func (directLink *DirectLinkV1) ReplaceGatewayExportRouteFilters(replaceGatewayExportRouteFiltersOptions *ReplaceGatewayExportRouteFiltersOptions) (result *ExportRouteFilterCollection, response *core.DetailedResponse, err error)

ReplaceGatewayExportRouteFilters : Replace existing export route filters Replace all existing export route filters configured on the Direct Link gateway.

func (*DirectLinkV1) ReplaceGatewayExportRouteFiltersWithContext added in v0.39.0

func (directLink *DirectLinkV1) ReplaceGatewayExportRouteFiltersWithContext(ctx context.Context, replaceGatewayExportRouteFiltersOptions *ReplaceGatewayExportRouteFiltersOptions) (result *ExportRouteFilterCollection, response *core.DetailedResponse, err error)

ReplaceGatewayExportRouteFiltersWithContext is an alternate form of the ReplaceGatewayExportRouteFilters method which supports a Context parameter

func (*DirectLinkV1) ReplaceGatewayImportRouteFilters added in v0.39.0

func (directLink *DirectLinkV1) ReplaceGatewayImportRouteFilters(replaceGatewayImportRouteFiltersOptions *ReplaceGatewayImportRouteFiltersOptions) (result *ImportRouteFilterCollection, response *core.DetailedResponse, err error)

ReplaceGatewayImportRouteFilters : Replace existing import route filters Replace all existing import route filters configured on the Direct Link gateway.

func (*DirectLinkV1) ReplaceGatewayImportRouteFiltersWithContext added in v0.39.0

func (directLink *DirectLinkV1) ReplaceGatewayImportRouteFiltersWithContext(ctx context.Context, replaceGatewayImportRouteFiltersOptions *ReplaceGatewayImportRouteFiltersOptions) (result *ImportRouteFilterCollection, response *core.DetailedResponse, err error)

ReplaceGatewayImportRouteFiltersWithContext is an alternate form of the ReplaceGatewayImportRouteFilters method which supports a Context parameter

func (*DirectLinkV1) SetDefaultHeaders added in v0.15.0

func (directLink *DirectLinkV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*DirectLinkV1) SetEnableGzipCompression added in v0.15.0

func (directLink *DirectLinkV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*DirectLinkV1) SetGatewayMacsec added in v0.51.7

func (directLink *DirectLinkV1) SetGatewayMacsec(setGatewayMacsecOptions *SetGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

SetGatewayMacsec : Set MACsec configuration Sets the MACsec configuration on a direct link, enabling the feature.

func (*DirectLinkV1) SetGatewayMacsecWithContext added in v0.51.7

func (directLink *DirectLinkV1) SetGatewayMacsecWithContext(ctx context.Context, setGatewayMacsecOptions *SetGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

SetGatewayMacsecWithContext is an alternate form of the SetGatewayMacsec method which supports a Context parameter

func (*DirectLinkV1) SetServiceURL

func (directLink *DirectLinkV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DirectLinkV1) UnsetGatewayMacsec added in v0.51.7

func (directLink *DirectLinkV1) UnsetGatewayMacsec(unsetGatewayMacsecOptions *UnsetGatewayMacsecOptions) (response *core.DetailedResponse, err error)

UnsetGatewayMacsec : Unset MACsec configuration Removes the MACsec configuration from a direct link, disabling the features.

func (*DirectLinkV1) UnsetGatewayMacsecWithContext added in v0.51.7

func (directLink *DirectLinkV1) UnsetGatewayMacsecWithContext(ctx context.Context, unsetGatewayMacsecOptions *UnsetGatewayMacsecOptions) (response *core.DetailedResponse, err error)

UnsetGatewayMacsecWithContext is an alternate form of the UnsetGatewayMacsec method which supports a Context parameter

func (*DirectLinkV1) UpdateGateway

func (directLink *DirectLinkV1) UpdateGateway(updateGatewayOptions *UpdateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)

UpdateGateway : Update gateway Update a Direct Link gateway.

func (*DirectLinkV1) UpdateGatewayExportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) UpdateGatewayExportRouteFilter(updateGatewayExportRouteFilterOptions *UpdateGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

UpdateGatewayExportRouteFilter : Updates the specified Direct Link gateway export route filter Update an export route filter from the Direct Link gateway.

Updating a route filter's `before` field will result in implicit updates to other route filters' `before` fields.

Considering the updated filter prior to the update, the preceding route filter's `before` field will be set to the filter following the updating route filter, if present. Otherwise it is set to empty.

Considering the updated filter after the update, if the new filter following the updated filter has an existing filter preceding it, that preceding filter's `before` field will be set to the updated filter.

func (*DirectLinkV1) UpdateGatewayExportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) UpdateGatewayExportRouteFilterWithContext(ctx context.Context, updateGatewayExportRouteFilterOptions *UpdateGatewayExportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

UpdateGatewayExportRouteFilterWithContext is an alternate form of the UpdateGatewayExportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) UpdateGatewayImportRouteFilter added in v0.39.0

func (directLink *DirectLinkV1) UpdateGatewayImportRouteFilter(updateGatewayImportRouteFilterOptions *UpdateGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

UpdateGatewayImportRouteFilter : Updates the specified Direct Link gateway import route filter Update an import route filter from the Direct Link gateway.

Updating a route filter's `before` field will result in implicit updates to other route filters' `before` fields.

Considering the updated filter prior to the update, the preceding route filter's `before` field will be set to the filter following the updating route filter, if present. Otherwise it is set to empty.

Considering the updated filter after the update, if the new filter following the updated filter has an existing filter preceding it, that preceding filter's `before` field will be set to the updated filter.

func (*DirectLinkV1) UpdateGatewayImportRouteFilterWithContext added in v0.39.0

func (directLink *DirectLinkV1) UpdateGatewayImportRouteFilterWithContext(ctx context.Context, updateGatewayImportRouteFilterOptions *UpdateGatewayImportRouteFilterOptions) (result *RouteFilter, response *core.DetailedResponse, err error)

UpdateGatewayImportRouteFilterWithContext is an alternate form of the UpdateGatewayImportRouteFilter method which supports a Context parameter

func (*DirectLinkV1) UpdateGatewayMacsec added in v0.51.7

func (directLink *DirectLinkV1) UpdateGatewayMacsec(updateGatewayMacsecOptions *UpdateGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

UpdateGatewayMacsec : Update MACsec configuration Updates the MACsec configuration on a direct link.

func (*DirectLinkV1) UpdateGatewayMacsecCak added in v0.51.7

func (directLink *DirectLinkV1) UpdateGatewayMacsecCak(updateGatewayMacsecCakOptions *UpdateGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

UpdateGatewayMacsecCak : Update MACsec CAK Updates the CAK on the MACsec configuration of a direct link.

func (*DirectLinkV1) UpdateGatewayMacsecCakWithContext added in v0.51.7

func (directLink *DirectLinkV1) UpdateGatewayMacsecCakWithContext(ctx context.Context, updateGatewayMacsecCakOptions *UpdateGatewayMacsecCakOptions) (result *GatewayMacsecCak, response *core.DetailedResponse, err error)

UpdateGatewayMacsecCakWithContext is an alternate form of the UpdateGatewayMacsecCak method which supports a Context parameter

func (*DirectLinkV1) UpdateGatewayMacsecWithContext added in v0.51.7

func (directLink *DirectLinkV1) UpdateGatewayMacsecWithContext(ctx context.Context, updateGatewayMacsecOptions *UpdateGatewayMacsecOptions) (result *GatewayMacsec, response *core.DetailedResponse, err error)

UpdateGatewayMacsecWithContext is an alternate form of the UpdateGatewayMacsec method which supports a Context parameter

func (*DirectLinkV1) UpdateGatewayVirtualConnection

func (directLink *DirectLinkV1) UpdateGatewayVirtualConnection(updateGatewayVirtualConnectionOptions *UpdateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

UpdateGatewayVirtualConnection : Update virtual connection Update a virtual connection.

func (*DirectLinkV1) UpdateGatewayVirtualConnectionWithContext added in v0.15.0

func (directLink *DirectLinkV1) UpdateGatewayVirtualConnectionWithContext(ctx context.Context, updateGatewayVirtualConnectionOptions *UpdateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)

UpdateGatewayVirtualConnectionWithContext is an alternate form of the UpdateGatewayVirtualConnection method which supports a Context parameter

func (*DirectLinkV1) UpdateGatewayWithContext added in v0.15.0

func (directLink *DirectLinkV1) UpdateGatewayWithContext(ctx context.Context, updateGatewayOptions *UpdateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)

UpdateGatewayWithContext is an alternate form of the UpdateGateway method which supports a Context parameter

type DirectLinkV1Options

type DirectLinkV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2019-12-13 up to the current
	// date may be provided. Specify the current date to request the latest version.
	Version *string `validate:"required"`
}

DirectLinkV1Options : Service options

type ExportRouteFilterCollection added in v0.39.0

type ExportRouteFilterCollection struct {
	// Array of export route filters.
	ExportRouteFilters []RouteFilter `json:"export_route_filters" validate:"required"`
}

ExportRouteFilterCollection : Collection of export route filters.

type Gateway

type Gateway struct {
	// array of AS Prepend information.
	AsPrepends []AsPrepend `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyReferenceIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfig `json:"bfd_config,omitempty"`

	// Customer BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
	//
	// See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn,omitempty"`

	// BGP IBM CIDR.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Carrier name.  Only set for type=dedicated gateways.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Changes pending approval for provider managed Direct Link Connect gateways.
	ChangeRequest GatewayChangeRequestIntf `json:"change_request,omitempty"`

	// Reason for completion notice rejection.  Only included on type=dedicated gateways with a rejected completion notice.
	CompletionNoticeRejectReason *string `json:"completion_notice_reject_reason,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn" validate:"required"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account" validate:"required"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.  Only set for type=dedicated gateways.
	CustomerName *string `json:"customer_name,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter" validate:"required"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter" validate:"required"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecReference `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// Only included on type=dedicated direct links.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	//
	// See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Context for certain values of `operational_status`.
	OperationalStatusReasons []GatewayStatusReason `json:"operational_status_reasons" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Indicates whether gateway changes must be made via a provider portal.
	ProviderApiManaged *bool `json:"provider_api_managed,omitempty"`

	// Resource group reference.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type" validate:"required"`

	// VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This
	// property will also be absent if this gateway's `crn` is in another account.
	Vlan *int64 `json:"vlan,omitempty"`
}

Gateway : gateway.

type GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItem struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayActionTemplateUpdatesItem : GatewayActionTemplateUpdatesItem struct Models which "extend" this model: - GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate - GatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate - GatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate - GatewayActionTemplateUpdatesItemGatewayClientVLANUpdate

type GatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

type GatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate struct {
	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`
}

GatewayActionTemplateUpdatesItemGatewayClientBGPASNUpdate : The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0 gateway. This model "extends" GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

type GatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate struct {
	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`
}

GatewayActionTemplateUpdatesItemGatewayClientBGPIPUpdate : Update BGP customer and IBM CIDR. This model "extends" GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate

type GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`
}

GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate : gateway speed change. This model "extends" GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItemGatewayClientVLANUpdate added in v0.26.0

type GatewayActionTemplateUpdatesItemGatewayClientVLANUpdate struct {
	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayActionTemplateUpdatesItemGatewayClientVLANUpdate : Update VLAN for this gateway

VLAN provided should be in the range 2 to 3967. This model "extends" GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItemIntf

type GatewayActionTemplateUpdatesItemIntf interface {
	// contains filtered or unexported methods
}

type GatewayBfdConfig added in v0.23.0

type GatewayBfdConfig struct {
	// Gateway BFD status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field must tolerate unexpected values.
	BfdStatus *string `json:"bfd_status,omitempty"`

	// Date and time bfd status was updated.
	BfdStatusUpdatedAt *strfmt.DateTime `json:"bfd_status_updated_at,omitempty"`

	// Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to
	// receive a reply from a neighbor with which it has established a BFD session.
	Interval *int64 `json:"interval" validate:"required"`

	// The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
	Multiplier *int64 `json:"multiplier" validate:"required"`
}

GatewayBfdConfig : BFD configuration information.

type GatewayBfdConfigActionTemplate added in v0.23.0

type GatewayBfdConfigActionTemplate struct {
	// Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to
	// receive a reply from a neighbor with which it has established a BFD session.
	Interval *int64 `json:"interval" validate:"required"`

	// The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
	Multiplier *int64 `json:"multiplier,omitempty"`
}

GatewayBfdConfigActionTemplate : Applicable for create_gateway_approve requests to select the gateway's BFD configuration information.

type GatewayBfdConfigTemplate added in v0.23.0

type GatewayBfdConfigTemplate struct {
	// Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to
	// receive a reply from a neighbor with which it has established a BFD session.
	Interval *int64 `json:"interval" validate:"required"`

	// The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
	Multiplier *int64 `json:"multiplier,omitempty"`
}

GatewayBfdConfigTemplate : BFD configuration information.

type GatewayBfdPatchTemplate added in v0.23.0

type GatewayBfdPatchTemplate struct {
	// Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to
	// receive a reply from a neighbor with which it has established a BFD session.
	//
	// To clear the BFD configuration patch its interval to 0.
	Interval *int64 `json:"interval,omitempty"`

	// The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
	Multiplier *int64 `json:"multiplier,omitempty"`
}

GatewayBfdPatchTemplate : BFD configuration information.

type GatewayChangeRequest

type GatewayChangeRequest struct {
	// type of gateway change request.
	Type *string `json:"type,omitempty"`

	// array of pending updates.
	Updates []GatewayChangeRequestUpdatesItemIntf `json:"updates,omitempty"`
}

GatewayChangeRequest : GatewayChangeRequest struct Models which "extend" this model: - GatewayChangeRequestGatewayClientGatewayCreate - GatewayChangeRequestGatewayClientGatewayDelete - GatewayChangeRequestGatewayClientGatewayUpdateAttributes

type GatewayChangeRequestGatewayClientGatewayCreate

type GatewayChangeRequestGatewayClientGatewayCreate struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`
}

GatewayChangeRequestGatewayClientGatewayCreate : gateway create. This model "extends" GatewayChangeRequest

type GatewayChangeRequestGatewayClientGatewayDelete

type GatewayChangeRequestGatewayClientGatewayDelete struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`
}

GatewayChangeRequestGatewayClientGatewayDelete : gateway delete. This model "extends" GatewayChangeRequest

type GatewayChangeRequestGatewayClientGatewayUpdateAttributes

type GatewayChangeRequestGatewayClientGatewayUpdateAttributes struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`

	// array of pending updates.
	Updates []GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemIntf `json:"updates" validate:"required"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributes : gateway attributes update. This model "extends" GatewayChangeRequest

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem : GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem struct Models which "extend" this model: - GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate - GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate - GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate - GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate struct {
	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPASNUpdate : The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0 gateway. This model "extends" GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate struct {
	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientBGPIPUpdate : Update BGP customer and IBM CIDR. This model "extends" GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate : gateway speed change. This model "extends" GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate added in v0.26.0

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate struct {
	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientVLANUpdate : Update VLAN for this gateway

VLAN provided should be in the range 2 to 3967. This model "extends" GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemIntf

type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemIntf interface {
	// contains filtered or unexported methods
}

type GatewayChangeRequestIntf

type GatewayChangeRequestIntf interface {
	// contains filtered or unexported methods
}

type GatewayChangeRequestUpdatesItem

type GatewayChangeRequestUpdatesItem struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayChangeRequestUpdatesItem : GatewayChangeRequestUpdatesItem struct Models which "extend" this model: - GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate - GatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate - GatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate - GatewayChangeRequestUpdatesItemGatewayClientVLANUpdate

type GatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate added in v0.23.0

type GatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate struct {
	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`
}

GatewayChangeRequestUpdatesItemGatewayClientBGPASNUpdate : The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0 gateway. This model "extends" GatewayChangeRequestUpdatesItem

type GatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate added in v0.23.0

type GatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate struct {
	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16",
	// "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask
	// values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`
}

GatewayChangeRequestUpdatesItemGatewayClientBGPIPUpdate : Update BGP customer and IBM CIDR. This model "extends" GatewayChangeRequestUpdatesItem

type GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate

type GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`
}

GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate : gateway speed change. This model "extends" GatewayChangeRequestUpdatesItem

type GatewayChangeRequestUpdatesItemGatewayClientVLANUpdate added in v0.26.0

type GatewayChangeRequestUpdatesItemGatewayClientVLANUpdate struct {
	// VLAN to be updated for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayChangeRequestUpdatesItemGatewayClientVLANUpdate : Update VLAN for this gateway

VLAN provided should be in the range 2 to 3967. This model "extends" GatewayChangeRequestUpdatesItem

type GatewayChangeRequestUpdatesItemIntf

type GatewayChangeRequestUpdatesItemIntf interface {
	// contains filtered or unexported methods
}

type GatewayCollection

type GatewayCollection struct {
	// Collection of Direct Link gateways.
	Gateways []GatewayCollectionGatewaysItemIntf `json:"gateways" validate:"required"`
}

GatewayCollection : List of gateways.

type GatewayCollectionGatewaysItem added in v0.45.0

type GatewayCollectionGatewaysItem struct {
	// array of AS Prepend information.
	AsPrepends []AsPrepend `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyReferenceIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfig `json:"bfd_config,omitempty"`

	// Customer BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
	//
	// See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn,omitempty"`

	// BGP IBM CIDR.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Carrier name.  Only set for type=dedicated gateways.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Changes pending approval for provider managed Direct Link Connect gateways.
	ChangeRequest GatewayChangeRequestIntf `json:"change_request,omitempty"`

	// Reason for completion notice rejection.  Only included on type=dedicated gateways with a rejected completion notice.
	CompletionNoticeRejectReason *string `json:"completion_notice_reject_reason,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn,omitempty"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account,omitempty"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.  Only set for type=dedicated gateways.
	CustomerName *string `json:"customer_name,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global,omitempty"`

	// The unique identifier of this gateway.
	ID *string `json:"id,omitempty"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name,omitempty"`

	// Gateway location.
	LocationName *string `json:"location_name,omitempty"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecReference `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// Only included on type=dedicated direct links.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered,omitempty"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name,omitempty"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	//
	// See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.
	OperationalStatus *string `json:"operational_status,omitempty"`

	// Context for certain values of `operational_status`.
	OperationalStatusReasons []GatewayStatusReason `json:"operational_status_reasons,omitempty"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Indicates whether gateway changes must be made via a provider portal.
	ProviderApiManaged *bool `json:"provider_api_managed,omitempty"`

	// Resource group reference.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type,omitempty"`

	// VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This
	// property will also be absent if this gateway's `crn` is in another account.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayCollectionGatewaysItem : GatewayCollectionGatewaysItem struct Models which "extend" this model: - GatewayCollectionGatewaysItemGateway - GatewayCollectionGatewaysItemCrossAccountGateway

type GatewayCollectionGatewaysItemCrossAccountGateway added in v0.45.0

type GatewayCollectionGatewaysItemCrossAccountGateway struct {
	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn" validate:"required"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account" validate:"required"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type" validate:"required"`
}

GatewayCollectionGatewaysItemCrossAccountGateway : cross-account gateway read-only view. This model "extends" GatewayCollectionGatewaysItem

type GatewayCollectionGatewaysItemGateway added in v0.45.0

type GatewayCollectionGatewaysItemGateway struct {
	// array of AS Prepend information.
	AsPrepends []AsPrepend `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyReferenceIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfig `json:"bfd_config,omitempty"`

	// Customer BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
	//
	// See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn,omitempty"`

	// BGP IBM CIDR.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Carrier name.  Only set for type=dedicated gateways.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Changes pending approval for provider managed Direct Link Connect gateways.
	ChangeRequest GatewayChangeRequestIntf `json:"change_request,omitempty"`

	// Reason for completion notice rejection.  Only included on type=dedicated gateways with a rejected completion notice.
	CompletionNoticeRejectReason *string `json:"completion_notice_reject_reason,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn" validate:"required"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account" validate:"required"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.  Only set for type=dedicated gateways.
	CustomerName *string `json:"customer_name,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter" validate:"required"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter" validate:"required"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecReference `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// Only included on type=dedicated direct links.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	//
	// See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Context for certain values of `operational_status`.
	OperationalStatusReasons []GatewayStatusReason `json:"operational_status_reasons" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Indicates whether gateway changes must be made via a provider portal.
	ProviderApiManaged *bool `json:"provider_api_managed,omitempty"`

	// Resource group reference.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type" validate:"required"`

	// VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This
	// property will also be absent if this gateway's `crn` is in another account.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayCollectionGatewaysItemGateway : gateway. This model "extends" GatewayCollectionGatewaysItem

type GatewayCollectionGatewaysItemIntf added in v0.45.0

type GatewayCollectionGatewaysItemIntf interface {
	// contains filtered or unexported methods
}

type GatewayMacsec added in v0.51.7

type GatewayMacsec struct {
	// Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
	Active *bool `json:"active" validate:"required"`

	// The cipher suite used in generating the security association key (SAK).
	CipherSuite *string `json:"cipher_suite" validate:"required"`

	// The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
	ConfidentialityOffset *int64 `json:"confidentiality_offset" validate:"required"`

	// The date and time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server.
	//
	// Lower values indicate a higher preference to be the key server.
	//
	// The MACsec configuration on the direct link will always set this value to 255.
	KeyServerPriority *int64 `json:"key_server_priority" validate:"required"`

	// Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers.
	SakRekey SakRekeyIntf `json:"sak_rekey" validate:"required"`

	// Determines how packets without MACsec headers are handled.
	//
	// `must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over
	// network availability.
	// `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network
	// availability over security.
	SecurityPolicy *string `json:"security_policy" validate:"required"`

	// Current status of MACsec on this direct link.
	//
	// Status `offline` is returned when MACsec is inactive and during direct link creation.
	//
	// Status `deleting` is returned when MACsec during removal of MACsec from the direct link and during direct link
	// deletion.
	//
	// See `status_reasons[]` for possible remediation of the `failed` `status`.
	Status *string `json:"status" validate:"required"`

	// Context for certain values of `status`.
	StatusReasons []GatewayMacsecStatusReason `json:"status_reasons" validate:"required"`

	// The date and time the resource was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The window size determines the number of frames in a window for replay protection.
	//
	// Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not
	// replay protected.
	WindowSize *int64 `json:"window_size" validate:"required"`
}

GatewayMacsec : MACsec configuration information of a Direct Link gateway.

type GatewayMacsecCak added in v0.11.0

type GatewayMacsecCak struct {
	// This field will be present when the `status` of the MACsec CAK is `rotating` and may be present when the `status` is
	// `failed`.
	//
	// This object denotes the MACsec CAK's values prior to beginning the rotation and represent the previous key still
	// configured in the direct link's MACsec key chain.
	//
	// This object will be removed when the MACsec CAK rotation completes, indicating that the previous key has been
	// removed from the key chain, and the current CAK's values are in use.
	ActiveDelta *GatewayMacsecCakActiveDelta `json:"active_delta,omitempty"`

	// The date and time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The unique identifier for this connectivity association key (CAK).
	ID *string `json:"id" validate:"required"`

	// A reference to a [Hyper Protect Crypto Service Standard
	// Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).
	Key *HpcsKeyReference `json:"key" validate:"required"`

	// The name identifies the connectivity association key (CAK) within the MACsec key chain.
	//
	// The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive.
	//
	// This value, along with the material of the `key`, must match on the MACsec peers.
	Name *string `json:"name" validate:"required"`

	// The intended session the key will be used to secure.
	//
	// If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take
	// over.
	//
	// There must be a `primary` session CAK. A `fallback` CAK is optional.
	Session *string `json:"session" validate:"required"`

	// Current status of the CAK.
	//
	// Status `operational` is returned when the CAK is configured successfully.
	//
	// Status `active` is returned when the CAK is configured successfully and is currently used to secure the MACsec
	// session.
	//
	// Status `rotating` is returned during a key rotation. The CAK defined by `active_delta` is securing the MACsec
	// session. The status will remain `rotating` until the new key is `active`.
	//
	// Status `failed` is returned when the CAK cannot be configured. To recover, first resolve any issues with your HPCS
	// key, then patch this CAK with the same or new key. Alternatively, you can delete this CAK if used for the `fallback`
	// session.
	Status *string `json:"status" validate:"required"`

	// The date and time the resource was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

GatewayMacsecCak : A connectivity association key (CAK) used in the MACsec Key Agreement (MKA) protocol.

MACsec CAKs consist of both a name and key. The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive. The CAK's `key` must be a [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) type=standard with key material a hexadecimal string exactly 64 characters in length.

type GatewayMacsecCakActiveDelta added in v0.51.7

type GatewayMacsecCakActiveDelta struct {
	// A reference to a [Hyper Protect Crypto Service Standard
	// Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).
	Key *HpcsKeyReference `json:"key,omitempty"`

	// The name identifies the connectivity association key (CAK) within the MACsec key chain.
	//
	// The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive.
	//
	// This value, along with the material of the `key`, must match on the MACsec peers.
	Name *string `json:"name,omitempty"`
}

GatewayMacsecCakActiveDelta : This field will be present when the `status` of the MACsec CAK is `rotating` and may be present when the `status` is `failed`.

This object denotes the MACsec CAK's values prior to beginning the rotation and represent the previous key still configured in the direct link's MACsec key chain.

This object will be removed when the MACsec CAK rotation completes, indicating that the previous key has been removed from the key chain, and the current CAK's values are in use.

type GatewayMacsecCakCollection added in v0.51.7

type GatewayMacsecCakCollection struct {
	// List of all connectivity association keys (CAKs) associated with the MACsec feature on a direct link.
	Caks []GatewayMacsecCak `json:"caks,omitempty"`
}

GatewayMacsecCakCollection : List of all connectivity association keys (CAKs) associated with the MACsec feature on a direct link.

type GatewayMacsecCakPatch added in v0.51.7

type GatewayMacsecCakPatch struct {
	// A [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).
	Key *HpcsKeyIdentity `json:"key,omitempty"`

	// The name identifies the connectivity association key (CAK) within the MACsec key chain.
	//
	// The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive.
	//
	// This value, along with the material of the `key`, must match on the MACsec peers.
	Name *string `json:"name,omitempty"`
}

GatewayMacsecCakPatch : Patch fields for CAK of MACsec configuration on a direct link.

When rotating a CAK, patch both the `name` and `key` fields simultaneously. Both must have new values and cannot match with another CAK. Neither `name` nor `key` is allowed to be patched on its own.

func (*GatewayMacsecCakPatch) AsPatch added in v0.51.7

func (gatewayMacsecCakPatch *GatewayMacsecCakPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the GatewayMacsecCakPatch

type GatewayMacsecCakPrototype added in v0.51.7

type GatewayMacsecCakPrototype struct {
	// A [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).
	Key *HpcsKeyIdentity `json:"key" validate:"required"`

	// The name identifies the connectivity association key (CAK) within the MACsec key chain.
	//
	// The CAK's `name` must be a hexadecimal string of even lengths between 2 to 64 inclusive.
	//
	// This value, along with the material of the `key`, must match on the MACsec peers.
	Name *string `json:"name" validate:"required"`

	// The intended session the key will be used to secure.
	//
	// If the `primary` MACsec session fails due to a key/key name mismatch on the peers, the `fallback` session can take
	// over.
	//
	// There must be a `primary` session CAK. A `fallback` CAK is optional.
	Session *string `json:"session" validate:"required"`
}

GatewayMacsecCakPrototype : The prototype for a connectivity association key (CAK) used in the MACsec Key Agreement (MKA) protocol.

type GatewayMacsecPatch added in v0.51.7

type GatewayMacsecPatch struct {
	// Sets the MACsec feature to be active (true) or inactive (false) for a gateway.
	Active *bool `json:"active,omitempty"`

	// Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers.
	SakRekey SakRekeyPatchIntf `json:"sak_rekey,omitempty"`

	// Determines how packets without MACsec headers are handled.
	//
	// `must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over
	// network availability.
	// `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network
	// availability over security.
	SecurityPolicy *string `json:"security_policy,omitempty"`

	// The window size determines the number of frames in a window for replay protection.
	//
	// Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not
	// replay protected.
	WindowSize *int64 `json:"window_size,omitempty"`
}

GatewayMacsecPatch : Patch fields for MACsec configuration of a Direct Link gateway.

func (*GatewayMacsecPatch) AsPatch added in v0.51.7

func (gatewayMacsecPatch *GatewayMacsecPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the GatewayMacsecPatch

type GatewayMacsecPrototype added in v0.51.7

type GatewayMacsecPrototype struct {
	// Determines if the MACsec feature should initially be active (true) or inactive (false) for a gateway.
	Active *bool `json:"active" validate:"required"`

	// List of all connectivity association keys (CAKs) to be associated associated with the MACsec feature on a direct
	// link.
	//
	// There must be at least one CAK with `session`: `primary`. There can be at most one CAK with `session`: `fallback`
	//
	// All CAKs must reference a unique key.
	Caks []GatewayMacsecCakPrototype `json:"caks" validate:"required"`

	// Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers.
	SakRekey SakRekeyPrototypeIntf `json:"sak_rekey" validate:"required"`

	// Determines how packets without MACsec headers are handled.
	//
	// `must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over
	// network availability.
	// `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network
	// availability over security.
	SecurityPolicy *string `json:"security_policy" validate:"required"`

	// The window size determines the number of frames in a window for replay protection.
	//
	// Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not
	// replay protected.
	WindowSize *int64 `json:"window_size,omitempty"`
}

GatewayMacsecPrototype : MACsec configuration information of a Direct Link gateway.

type GatewayMacsecReference added in v0.51.7

type GatewayMacsecReference struct {
	// Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
	Active *bool `json:"active" validate:"required"`

	// Determines how packets without MACsec headers are handled.
	//
	// `must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over
	// network availability.
	// `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network
	// availability over security.
	SecurityPolicy *string `json:"security_policy" validate:"required"`

	// Current status of MACsec on this direct link.
	//
	// Status `offline` is returned when MACsec is inactive and during direct link creation.
	//
	// Status `deleting` is returned when MACsec during removal of MACsec from the direct link and during direct link
	// deletion.
	//
	// See `status_reasons[]` for possible remediation of the `failed` `status`.
	Status *string `json:"status" validate:"required"`

	// Context for certain values of `status`.
	StatusReasons []GatewayMacsecStatusReason `json:"status_reasons" validate:"required"`
}

GatewayMacsecReference : MACsec configuration information of a Direct Link gateway.

type GatewayMacsecStatusReason added in v0.51.7

type GatewayMacsecStatusReason struct {
	// A reason code for the status:
	// - `macsec_cak_failed`: At least one of the connectivity association keys (CAKs) associated with the MACsec
	// configuration was unable to be configured on the direct link gateway. Refer to the `status` of the CAKs associated
	// with the MACsec configuration to find the the source of this reason.
	Code *string `json:"code" validate:"required"`

	// An explanation of the status reason.
	Message *string `json:"message" validate:"required"`

	// Link to documentation about this status reason.
	MoreInfo *string `json:"more_info,omitempty"`
}

GatewayMacsecStatusReason : A reason for the current `status`.

type GatewayPatchTemplate added in v0.45.0

type GatewayPatchTemplate struct {
	// A reference to a key to use as the BGP MD5 authentication key.
	//
	// Patch to `null` to disable BGP MD5 authentication.
	AuthenticationKey AuthenticationKeyIdentityIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdPatchTemplate `json:"bfd_config,omitempty"`

	// The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0
	// gateway.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge
	// router for the DL 2.0 gateway.
	//
	// Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied
	// with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the
	// value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public
	// CIDR.  bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0
	// gateway.
	//
	// IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer
	// edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must
	// reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.
	// bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside of their associated region.
	Global *bool `json:"global,omitempty"`

	// Use this field during LOA rejection to provide the reason for the rejection.
	//
	// Only allowed for type=dedicated gateways.
	LoaRejectReason *string `json:"loa_reject_reason,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered,omitempty"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name,omitempty"`

	// Gateway operational status.
	//
	// For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA.
	// When rejecting an LOA, provide reject reasoning in `loa_reject_reason`.
	//
	// Only allowed for type=dedicated gateways.
	OperationalStatus *string `json:"operational_status,omitempty"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// The VLAN to configure for this gateway.
	//
	// Specify `null` to remove an existing VLAN configuration.
	//
	// The gateway must have a `type` of `dedicated`.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayPatchTemplate : patch gateway template.

func (*GatewayPatchTemplate) AsPatch added in v0.45.0

func (gatewayPatchTemplate *GatewayPatchTemplate) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the GatewayPatchTemplate

type GatewayPortIdentity

type GatewayPortIdentity struct {
	// port id.
	ID *string `json:"id" validate:"required"`
}

GatewayPortIdentity : Select Port Label for new type=connect gateway.

type GatewayPortReference added in v0.51.7

type GatewayPortReference struct {
	// Port Identifier.
	ID *string `json:"id" validate:"required"`
}

GatewayPortReference : Port information for type=connect gateways.

type GatewayStatistic added in v0.11.0

type GatewayStatistic struct {
	// Date and time data was collected.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// statistics output.
	Data *string `json:"data" validate:"required"`

	// statistic type.
	Type *string `json:"type" validate:"required"`
}

GatewayStatistic : Gateway statistics and debug commands.

type GatewayStatisticCollection added in v0.11.0

type GatewayStatisticCollection struct {
	// Collection of gateway statistics.
	Statistics []GatewayStatistic `json:"statistics" validate:"required"`
}

GatewayStatisticCollection : gateway statistics.

type GatewayStatus added in v0.23.0

type GatewayStatus struct {
	// Status type.
	Type *string `json:"type,omitempty"`

	// Date and time status was collected.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Status.
	Value *string `json:"value,omitempty"`
}

GatewayStatus : GatewayStatus struct Models which "extend" this model: - GatewayStatusGatewayBGPStatus - GatewayStatusGatewayBFDStatus - GatewayStatusGatewayLinkStatus

type GatewayStatusCollection added in v0.23.0

type GatewayStatusCollection struct {
	// array of status.
	Status []GatewayStatusIntf `json:"status,omitempty"`
}

GatewayStatusCollection : gateway status.

type GatewayStatusGatewayBFDStatus added in v0.23.0

type GatewayStatusGatewayBFDStatus struct {
	// Status type.
	Type *string `json:"type" validate:"required"`

	// Date and time status was collected.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Status.
	Value *string `json:"value" validate:"required"`
}

GatewayStatusGatewayBFDStatus : Gateway bfd status. This model "extends" GatewayStatus

type GatewayStatusGatewayBGPStatus added in v0.23.0

type GatewayStatusGatewayBGPStatus struct {
	// Status type.
	Type *string `json:"type" validate:"required"`

	// Date and time status was collected.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Status.
	Value *string `json:"value" validate:"required"`
}

GatewayStatusGatewayBGPStatus : Gateway bgp status. This model "extends" GatewayStatus

type GatewayStatusGatewayLinkStatus added in v0.23.0

type GatewayStatusGatewayLinkStatus struct {
	// Status type.
	Type *string `json:"type" validate:"required"`

	// Date and time status was collected.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Status.
	Value *string `json:"value" validate:"required"`
}

GatewayStatusGatewayLinkStatus : Gateway link status. Only available for dedicated gateways. This model "extends" GatewayStatus

type GatewayStatusIntf added in v0.23.0

type GatewayStatusIntf interface {
	// contains filtered or unexported methods
}

type GatewayStatusReason added in v0.51.7

type GatewayStatusReason struct {
	// A reason code for the status:
	// - `authentication_key_failed`: `authentication_key` was unable to be configured on the direct link gateway. To
	// recover, first resolve any issues with your key, then patch the gateway with the same or new key.
	Code *string `json:"code" validate:"required"`

	// An explanation of the status reason.
	Message *string `json:"message" validate:"required"`

	// Link to documentation about this status reason.
	MoreInfo *string `json:"more_info,omitempty"`
}

GatewayStatusReason : A reason for the current `operational_status`.

type GatewayTemplate

type GatewayTemplate struct {
	// array of AS Prepend configuration information.
	AsPrepends []AsPrependTemplate `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyIdentityIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfigTemplate `json:"bfd_config,omitempty"`

	// BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR.
	//
	// Field is deprecated.  See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway using either
	// automatic or explicit IP assignment.  Any bgp_base_cidr value set will be ignored.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ExportRouteFilters []GatewayTemplateRouteFilter `json:"export_route_filters,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ImportRouteFilters []GatewayTemplateRouteFilter `json:"import_route_filters,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Resource group for this resource. If unspecified, the account's [default resource
	// group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.
	ResourceGroup *ResourceGroupIdentity `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type.
	Type *string `json:"type" validate:"required"`

	// Carrier name.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Cross connect router.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.
	CustomerName *string `json:"customer_name,omitempty"`

	// Gateway location.
	LocationName *string `json:"location_name,omitempty"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecPrototype `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	//
	// If not explicitly provided, the field will be assigned with the following priorities based on `cross_connect_router`
	// capabilities and available ports:
	//   - `macsec` was not provided in the request
	//     - `non_macsec`
	//     - `macsec_optional`
	//   - `macsec` was provided in the request
	//     - `macsec_optional`
	//     - `macsec`.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// The VLAN to configure for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`

	// Select Port Label for new type=connect gateway.
	Port *GatewayPortIdentity `json:"port,omitempty"`
}

GatewayTemplate : Create gateway template. Models which "extend" this model: - GatewayTemplateGatewayTypeDedicatedTemplate - GatewayTemplateGatewayTypeConnectTemplate

type GatewayTemplateGatewayTypeConnectTemplate

type GatewayTemplateGatewayTypeConnectTemplate struct {
	// array of AS Prepend configuration information.
	AsPrepends []AsPrependTemplate `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyIdentityIntf `json:"authentication_key,omitempty"`

	BfdConfig *GatewayBfdConfigTemplate `json:"bfd_config,omitempty"`

	// BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR.
	//
	// Field is deprecated.  See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway using either
	// automatic or explicit IP assignment.  Any bgp_base_cidr value set will be ignored.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ExportRouteFilters []GatewayTemplateRouteFilter `json:"export_route_filters,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ImportRouteFilters []GatewayTemplateRouteFilter `json:"import_route_filters,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	ResourceGroup *ResourceGroupIdentity `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type.
	Type *string `json:"type" validate:"required"`

	// Select Port Label for new type=connect gateway.
	Port *GatewayPortIdentity `json:"port" validate:"required"`
}

GatewayTemplateGatewayTypeConnectTemplate : Gateway fields specific to type=connect gateway create. This model "extends" GatewayTemplate

type GatewayTemplateGatewayTypeDedicatedTemplate

type GatewayTemplateGatewayTypeDedicatedTemplate struct {
	// array of AS Prepend configuration information.
	AsPrepends []AsPrependTemplate `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyIdentityIntf `json:"authentication_key,omitempty"`

	BfdConfig *GatewayBfdConfigTemplate `json:"bfd_config,omitempty"`

	// BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR.
	//
	// Field is deprecated.  See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway using either
	// automatic or explicit IP assignment.  Any bgp_base_cidr value set will be ignored.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// BGP IBM CIDR.
	//
	// For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr.  IBM will automatically select values for bgp_cer_cidr
	// and bgp_ibm_cidr.
	//
	// For explicit IP assignment set a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of
	// "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR.  bgp_cer_cidr and
	// bgp_ibm_cidr must have matching network and subnet mask values.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ExportRouteFilters []GatewayTemplateRouteFilter `json:"export_route_filters,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ImportRouteFilters []GatewayTemplateRouteFilter `json:"import_route_filters,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	ResourceGroup *ResourceGroupIdentity `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type.
	Type *string `json:"type" validate:"required"`

	// Carrier name.
	CarrierName *string `json:"carrier_name" validate:"required"`

	// Cross connect router.
	CrossConnectRouter *string `json:"cross_connect_router" validate:"required"`

	// Customer name.
	CustomerName *string `json:"customer_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecPrototype `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	//
	// If not explicitly provided, the field will be assigned with the following priorities based on `cross_connect_router`
	// capabilities and available ports:
	//   - `macsec` was not provided in the request
	//     - `non_macsec`
	//     - `macsec_optional`
	//   - `macsec` was provided in the request
	//     - `macsec_optional`
	//     - `macsec`.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// The VLAN to configure for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

GatewayTemplateGatewayTypeDedicatedTemplate : Gateway fields specific to type=dedicated gateway create. This model "extends" GatewayTemplate

type GatewayTemplateIntf

type GatewayTemplateIntf interface {
	// contains filtered or unexported methods
}

type GatewayTemplateRouteFilter added in v0.39.0

type GatewayTemplateRouteFilter struct {
	// Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.
	Action *string `json:"action" validate:"required"`

	// The minimum matching length of the prefix-set (mnemonic for greater than or equal to).
	Ge *int64 `json:"ge,omitempty"`

	// The maximum matching length of the prefix-set (mnemonic for less than or equal to).
	Le *int64 `json:"le,omitempty"`

	// IP prefix representing an address and mask length of the prefix-set.
	Prefix *string `json:"prefix" validate:"required"`
}

GatewayTemplateRouteFilter : The route filter create template within the Direct Link gateway create template.

type GatewayVirtualConnection

type GatewayVirtualConnection struct {
	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The unique identifier for this virtual connection.
	ID *string `json:"id" validate:"required"`

	// The user-defined name for this virtual connection.  Virtual connection names are unique within a gateway.  This is
	// the name of the virtual connection itself, the network being connected may have its own name attribute.
	Name *string `json:"name" validate:"required"`

	// For virtual connections across two different IBM Cloud Accounts network_account indicates the account that owns the
	// target network.
	NetworkAccount *string `json:"network_account,omitempty"`

	// Unique identifier of the target network.  For type=vpc virtual connections this is the CRN of the target VPC.  This
	// field does not apply to type=classic connections.
	NetworkID *string `json:"network_id,omitempty"`

	// Status of the virtual connection.
	//
	// The list of enumerated values for this property may expand in the future. Code and processes using this field  must
	// tolerate unexpected values.
	Status *string `json:"status" validate:"required"`

	// Virtual connection type.
	//
	// The list of enumerated values for this property may expand in the future. Code and processes using this field  must
	// tolerate unexpected values.
	Type *string `json:"type" validate:"required"`
}

GatewayVirtualConnection : Virtual connection.

type GatewayVirtualConnectionCollection

type GatewayVirtualConnectionCollection struct {
	// virtual connection array.
	VirtualConnections []GatewayVirtualConnection `json:"virtual_connections" validate:"required"`
}

GatewayVirtualConnectionCollection : Virtual connection collection.

type GatewayVirtualConnectionPatchTemplate added in v0.51.7

type GatewayVirtualConnectionPatchTemplate struct {
	// The user-defined name for this virtual connection.  Virtual connection names are unique within a gateway.  This is
	// the name of the virtual connection itself, the network being connected may have its own name attribute.
	Name *string `json:"name,omitempty"`

	// Status of the virtual connection.  Virtual connections that span IBM Cloud Accounts are created in approval_pending
	// status.  The owner of the target network can accept or reject connection requests by patching status to attached or
	// rejected respectively.
	Status *string `json:"status,omitempty"`
}

GatewayVirtualConnectionPatchTemplate : Patch virtual connection template.

func (*GatewayVirtualConnectionPatchTemplate) AsPatch added in v0.51.7

func (gatewayVirtualConnectionPatchTemplate *GatewayVirtualConnectionPatchTemplate) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the GatewayVirtualConnectionPatchTemplate

type GetGatewayExportRouteFilterOptions added in v0.39.0

type GetGatewayExportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayExportRouteFilterOptions : The GetGatewayExportRouteFilter options.

func (*GetGatewayExportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayExportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*GetGatewayExportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

type GetGatewayImportRouteFilterOptions added in v0.39.0

type GetGatewayImportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayImportRouteFilterOptions : The GetGatewayImportRouteFilter options.

func (*GetGatewayImportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayImportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*GetGatewayImportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

type GetGatewayMacsecCakOptions added in v0.51.7

type GetGatewayMacsecCakOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// MACsec CAK identifier.
	CakID *string `json:"cak_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayMacsecCakOptions : The GetGatewayMacsecCak options.

func (*GetGatewayMacsecCakOptions) SetCakID added in v0.51.7

SetCakID : Allow user to set CakID

func (*GetGatewayMacsecCakOptions) SetHeaders added in v0.51.7

func (options *GetGatewayMacsecCakOptions) SetHeaders(param map[string]string) *GetGatewayMacsecCakOptions

SetHeaders : Allow user to set Headers

func (*GetGatewayMacsecCakOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type GetGatewayMacsecOptions added in v0.51.7

type GetGatewayMacsecOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayMacsecOptions : The GetGatewayMacsec options.

func (*GetGatewayMacsecOptions) SetHeaders added in v0.51.7

func (options *GetGatewayMacsecOptions) SetHeaders(param map[string]string) *GetGatewayMacsecOptions

SetHeaders : Allow user to set Headers

func (*GetGatewayMacsecOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type GetGatewayOptions

type GetGatewayOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayOptions : The GetGateway options.

func (*GetGatewayOptions) SetHeaders

func (options *GetGatewayOptions) SetHeaders(param map[string]string) *GetGatewayOptions

SetHeaders : Allow user to set Headers

func (*GetGatewayOptions) SetID

func (_options *GetGatewayOptions) SetID(id string) *GetGatewayOptions

SetID : Allow user to set ID

type GetGatewayResponse added in v0.45.0

type GetGatewayResponse struct {
	// array of AS Prepend information.
	AsPrepends []AsPrepend `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyReferenceIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfig `json:"bfd_config,omitempty"`

	// Customer BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`

	// (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
	//
	// See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn,omitempty"`

	// BGP IBM CIDR.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Carrier name.  Only set for type=dedicated gateways.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Changes pending approval for provider managed Direct Link Connect gateways.
	ChangeRequest GatewayChangeRequestIntf `json:"change_request,omitempty"`

	// Reason for completion notice rejection.  Only included on type=dedicated gateways with a rejected completion notice.
	CompletionNoticeRejectReason *string `json:"completion_notice_reject_reason,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn,omitempty"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account,omitempty"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.  Only set for type=dedicated gateways.
	CustomerName *string `json:"customer_name,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global,omitempty"`

	// The unique identifier of this gateway.
	ID *string `json:"id,omitempty"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name,omitempty"`

	// Gateway location.
	LocationName *string `json:"location_name,omitempty"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecReference `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// Only included on type=dedicated direct links.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered,omitempty"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name,omitempty"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	//
	// See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.
	OperationalStatus *string `json:"operational_status,omitempty"`

	// Context for certain values of `operational_status`.
	OperationalStatusReasons []GatewayStatusReason `json:"operational_status_reasons,omitempty"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Indicates whether gateway changes must be made via a provider portal.
	ProviderApiManaged *bool `json:"provider_api_managed,omitempty"`

	// Resource group reference.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type,omitempty"`

	// VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This
	// property will also be absent if this gateway's `crn` is in another account.
	Vlan *int64 `json:"vlan,omitempty"`
}

GetGatewayResponse : GetGatewayResponse struct Models which "extend" this model: - GetGatewayResponseGateway - GetGatewayResponseCrossAccountGateway

type GetGatewayResponseCrossAccountGateway added in v0.45.0

type GetGatewayResponseCrossAccountGateway struct {
	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn" validate:"required"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account" validate:"required"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type" validate:"required"`
}

GetGatewayResponseCrossAccountGateway : cross-account gateway read-only view. This model "extends" GetGatewayResponse

type GetGatewayResponseGateway added in v0.45.0

type GetGatewayResponseGateway struct {
	// array of AS Prepend information.
	AsPrepends []AsPrepend `json:"as_prepends,omitempty"`

	AuthenticationKey AuthenticationKeyReferenceIntf `json:"authentication_key,omitempty"`

	// BFD configuration information.
	BfdConfig *GatewayBfdConfig `json:"bfd_config,omitempty"`

	// Customer BGP ASN.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
	//
	// See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information.
	//
	// Deprecated field bgp_base_cidr will be removed from the API specification after 15-MAR-2021.
	BgpBaseCidr *string `json:"bgp_base_cidr,omitempty"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn,omitempty"`

	// BGP IBM CIDR.
	BgpIbmCidr *string `json:"bgp_ibm_cidr,omitempty"`

	// Gateway BGP status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field  must tolerate unexpected values.
	BgpStatus *string `json:"bgp_status,omitempty"`

	// Date and time bgp status was updated.
	BgpStatusUpdatedAt *strfmt.DateTime `json:"bgp_status_updated_at,omitempty"`

	// Carrier name.  Only set for type=dedicated gateways.
	CarrierName *string `json:"carrier_name,omitempty"`

	// Changes pending approval for provider managed Direct Link Connect gateways.
	ChangeRequest GatewayChangeRequestIntf `json:"change_request,omitempty"`

	// Reason for completion notice rejection.  Only included on type=dedicated gateways with a rejected completion notice.
	CompletionNoticeRejectReason *string `json:"completion_notice_reject_reason,omitempty"`

	// Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway
	// Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values
	// for this property may expand in the future. Code and processes using this field  must tolerate unexpected values.
	ConnectionMode *string `json:"connection_mode,omitempty"`

	// The date and time resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The CRN (Cloud Resource Name) of this gateway.
	Crn *string `json:"crn" validate:"required"`

	// Indicates whether this gateway is cross account gateway.
	CrossAccount *bool `json:"cross_account" validate:"required"`

	// Cross connect router. Only included on type=dedicated gateways.
	CrossConnectRouter *string `json:"cross_connect_router,omitempty"`

	// Customer name.  Only set for type=dedicated gateways.
	CustomerName *string `json:"customer_name,omitempty"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultExportRouteFilter *string `json:"default_export_route_filter" validate:"required"`

	// The default directional route filter action that applies to routes that do not match any directional route filters.
	DefaultImportRouteFilter *string `json:"default_import_route_filter" validate:"required"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// Gateway link status.  Only included on type=dedicated gateways. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field  must tolerate unexpected values.
	LinkStatus *string `json:"link_status,omitempty"`

	// Date and time link status was updated.
	LinkStatusUpdatedAt *strfmt.DateTime `json:"link_status_updated_at,omitempty"`

	// Gateway location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Gateway location.
	LocationName *string `json:"location_name" validate:"required"`

	// MACsec configuration information of a Direct Link gateway.
	Macsec *GatewayMacsecReference `json:"macsec,omitempty"`

	// Indicates the direct link's MACsec capability. It must match one of the MACsec related `capabilities` of the
	// `cross_connect_router`.
	//
	// Only included on type=dedicated direct links.
	//
	// - non_macsec: The direct link does not support MACsec.
	// - macsec: The direct link supports MACsec. The MACsec feature must be enabled.
	// - macsec_optional: The direct link supports MACsec. The MACsec feature is not required and can be enabled after
	// direct link creation.
	MacsecCapability *string `json:"macsec_capability,omitempty"`

	// Metered billing option.  When `true` gateway usage is billed per gigabyte.  When `false` there is no per gigabyte
	// usage charge, instead a flat rate is charged for the gateway.
	Metered *bool `json:"metered" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status. The list of enumerated values for this property may expand in the future. Code and
	// processes using this field  must tolerate unexpected values.
	//
	// See `operational_status_reasons[]` for possible remediation of the `failed` `operational_status`.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Context for certain values of `operational_status`.
	OperationalStatusReasons []GatewayStatusReason `json:"operational_status_reasons" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// Port information for type=connect gateways.
	Port *GatewayPortReference `json:"port,omitempty"`

	// Indicates whether gateway changes must be made via a provider portal.
	ProviderApiManaged *bool `json:"provider_api_managed,omitempty"`

	// Resource group reference.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Offering type. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field  must tolerate unexpected values.
	Type *string `json:"type" validate:"required"`

	// VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This
	// property will also be absent if this gateway's `crn` is in another account.
	Vlan *int64 `json:"vlan,omitempty"`
}

GetGatewayResponseGateway : gateway. This model "extends" GetGatewayResponse

type GetGatewayResponseIntf added in v0.45.0

type GetGatewayResponseIntf interface {
	// contains filtered or unexported methods
}

type GetGatewayRouteReportOptions added in v0.34.0

type GetGatewayRouteReportOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Route report identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayRouteReportOptions : The GetGatewayRouteReport options.

func (*GetGatewayRouteReportOptions) SetGatewayID added in v0.34.0

func (_options *GetGatewayRouteReportOptions) SetGatewayID(gatewayID string) *GetGatewayRouteReportOptions

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayRouteReportOptions) SetHeaders added in v0.34.0

SetHeaders : Allow user to set Headers

func (*GetGatewayRouteReportOptions) SetID added in v0.34.0

SetID : Allow user to set ID

type GetGatewayStatisticsOptions added in v0.11.0

type GetGatewayStatisticsOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Specify statistic to retrieve.
	Type *string `json:"type" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayStatisticsOptions : The GetGatewayStatistics options.

func (*GetGatewayStatisticsOptions) SetHeaders added in v0.11.0

func (options *GetGatewayStatisticsOptions) SetHeaders(param map[string]string) *GetGatewayStatisticsOptions

SetHeaders : Allow user to set Headers

func (*GetGatewayStatisticsOptions) SetID added in v0.11.0

SetID : Allow user to set ID

func (*GetGatewayStatisticsOptions) SetType added in v0.11.0

SetType : Allow user to set Type

type GetGatewayStatusOptions added in v0.23.0

type GetGatewayStatusOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Specify status to retrieve.
	Type *string `json:"type,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayStatusOptions : The GetGatewayStatus options.

func (*GetGatewayStatusOptions) SetHeaders added in v0.23.0

func (options *GetGatewayStatusOptions) SetHeaders(param map[string]string) *GetGatewayStatusOptions

SetHeaders : Allow user to set Headers

func (*GetGatewayStatusOptions) SetID added in v0.23.0

SetID : Allow user to set ID

func (*GetGatewayStatusOptions) SetType added in v0.23.0

func (_options *GetGatewayStatusOptions) SetType(typeVar string) *GetGatewayStatusOptions

SetType : Allow user to set Type

type GetGatewayVirtualConnectionOptions

type GetGatewayVirtualConnectionOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// The virtual connection identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetGatewayVirtualConnectionOptions : The GetGatewayVirtualConnection options.

func (*GetGatewayVirtualConnectionOptions) SetGatewayID

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayVirtualConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*GetGatewayVirtualConnectionOptions) SetID

SetID : Allow user to set ID

type GetPortOptions

type GetPortOptions struct {
	// The port identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetPortOptions : The GetPort options.

func (*GetPortOptions) SetHeaders

func (options *GetPortOptions) SetHeaders(param map[string]string) *GetPortOptions

SetHeaders : Allow user to set Headers

func (*GetPortOptions) SetID

func (_options *GetPortOptions) SetID(id string) *GetPortOptions

SetID : Allow user to set ID

type HpcsKeyIdentity added in v0.51.7

type HpcsKeyIdentity struct {
	// The CRN of the key.
	Crn *string `json:"crn" validate:"required"`
}

HpcsKeyIdentity : A [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).

type HpcsKeyReference added in v0.51.7

type HpcsKeyReference struct {
	// The CRN of the referenced key.
	Crn *string `json:"crn" validate:"required"`
}

HpcsKeyReference : A reference to a [Hyper Protect Crypto Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).

type ImportRouteFilterCollection added in v0.39.0

type ImportRouteFilterCollection struct {
	// Array of import route filters.
	ImportRouteFilters []RouteFilter `json:"import_route_filters" validate:"required"`
}

ImportRouteFilterCollection : Collection of import route filters.

type ListGatewayAsPrependsOptions added in v0.35.0

type ListGatewayAsPrependsOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayAsPrependsOptions : The ListGatewayAsPrepends options.

func (*ListGatewayAsPrependsOptions) SetGatewayID added in v0.35.0

func (_options *ListGatewayAsPrependsOptions) SetGatewayID(gatewayID string) *ListGatewayAsPrependsOptions

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayAsPrependsOptions) SetHeaders added in v0.35.0

SetHeaders : Allow user to set Headers

type ListGatewayCompletionNoticeOptions

type ListGatewayCompletionNoticeOptions struct {
	// Direct Link Dedicated gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayCompletionNoticeOptions : The ListGatewayCompletionNotice options.

func (*ListGatewayCompletionNoticeOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListGatewayCompletionNoticeOptions) SetID

SetID : Allow user to set ID

type ListGatewayExportRouteFiltersOptions added in v0.39.0

type ListGatewayExportRouteFiltersOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayExportRouteFiltersOptions : The ListGatewayExportRouteFilters options.

func (*ListGatewayExportRouteFiltersOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayExportRouteFiltersOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

type ListGatewayImportRouteFiltersOptions added in v0.39.0

type ListGatewayImportRouteFiltersOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayImportRouteFiltersOptions : The ListGatewayImportRouteFilters options.

func (*ListGatewayImportRouteFiltersOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayImportRouteFiltersOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

type ListGatewayLetterOfAuthorizationOptions

type ListGatewayLetterOfAuthorizationOptions struct {
	// Direct Link Dedicated gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayLetterOfAuthorizationOptions : The ListGatewayLetterOfAuthorization options.

func (*ListGatewayLetterOfAuthorizationOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListGatewayLetterOfAuthorizationOptions) SetID

SetID : Allow user to set ID

type ListGatewayMacsecCaksOptions added in v0.51.7

type ListGatewayMacsecCaksOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayMacsecCaksOptions : The ListGatewayMacsecCaks options.

func (*ListGatewayMacsecCaksOptions) SetHeaders added in v0.51.7

SetHeaders : Allow user to set Headers

func (*ListGatewayMacsecCaksOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type ListGatewayRouteReportsOptions added in v0.34.0

type ListGatewayRouteReportsOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayRouteReportsOptions : The ListGatewayRouteReports options.

func (*ListGatewayRouteReportsOptions) SetGatewayID added in v0.34.0

func (_options *ListGatewayRouteReportsOptions) SetGatewayID(gatewayID string) *ListGatewayRouteReportsOptions

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayRouteReportsOptions) SetHeaders added in v0.34.0

SetHeaders : Allow user to set Headers

type ListGatewayVirtualConnectionsOptions

type ListGatewayVirtualConnectionsOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewayVirtualConnectionsOptions : The ListGatewayVirtualConnections options.

func (*ListGatewayVirtualConnectionsOptions) SetGatewayID

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayVirtualConnectionsOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ListGatewaysOptions

type ListGatewaysOptions struct {

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListGatewaysOptions : The ListGateways options.

func (*ListGatewaysOptions) SetHeaders

func (options *ListGatewaysOptions) SetHeaders(param map[string]string) *ListGatewaysOptions

SetHeaders : Allow user to set Headers

type ListOfferingTypeLocationCrossConnectRoutersOptions

type ListOfferingTypeLocationCrossConnectRoutersOptions struct {
	// The Direct Link offering type.  Current supported values are `"dedicated"` and `"connect"`.
	OfferingType *string `json:"offering_type" validate:"required,ne="`

	// The name of the Direct Link location.
	LocationName *string `json:"location_name" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListOfferingTypeLocationCrossConnectRoutersOptions : The ListOfferingTypeLocationCrossConnectRouters options.

func (*ListOfferingTypeLocationCrossConnectRoutersOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListOfferingTypeLocationCrossConnectRoutersOptions) SetLocationName

SetLocationName : Allow user to set LocationName

func (*ListOfferingTypeLocationCrossConnectRoutersOptions) SetOfferingType

SetOfferingType : Allow user to set OfferingType

type ListOfferingTypeLocationsOptions

type ListOfferingTypeLocationsOptions struct {
	// The Direct Link offering type.  Current supported values are `"dedicated"` and `"connect"`.
	OfferingType *string `json:"offering_type" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListOfferingTypeLocationsOptions : The ListOfferingTypeLocations options.

func (*ListOfferingTypeLocationsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListOfferingTypeLocationsOptions) SetOfferingType

func (_options *ListOfferingTypeLocationsOptions) SetOfferingType(offeringType string) *ListOfferingTypeLocationsOptions

SetOfferingType : Allow user to set OfferingType

type ListOfferingTypeSpeedsOptions

type ListOfferingTypeSpeedsOptions struct {
	// The Direct Link offering type.  Current supported values are `"dedicated"` and `"connect"`.
	OfferingType *string `json:"offering_type" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListOfferingTypeSpeedsOptions : The ListOfferingTypeSpeeds options.

func (*ListOfferingTypeSpeedsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListOfferingTypeSpeedsOptions) SetOfferingType

func (_options *ListOfferingTypeSpeedsOptions) SetOfferingType(offeringType string) *ListOfferingTypeSpeedsOptions

SetOfferingType : Allow user to set OfferingType

type ListPortsOptions

type ListPortsOptions struct {
	// A server-supplied token determining which resource to start the page on.
	Start *string `json:"start,omitempty"`

	// The number of resources to return on a page.
	Limit *int64 `json:"limit,omitempty"`

	// Direct Link location short name.
	LocationName *string `json:"location_name,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListPortsOptions : The ListPorts options.

func (*ListPortsOptions) SetHeaders

func (options *ListPortsOptions) SetHeaders(param map[string]string) *ListPortsOptions

SetHeaders : Allow user to set Headers

func (*ListPortsOptions) SetLimit

func (_options *ListPortsOptions) SetLimit(limit int64) *ListPortsOptions

SetLimit : Allow user to set Limit

func (*ListPortsOptions) SetLocationName

func (_options *ListPortsOptions) SetLocationName(locationName string) *ListPortsOptions

SetLocationName : Allow user to set LocationName

func (*ListPortsOptions) SetStart

func (_options *ListPortsOptions) SetStart(start string) *ListPortsOptions

SetStart : Allow user to set Start

type LocationCollection

type LocationCollection struct {
	// Collection of Direct Link locations.
	Locations []LocationOutput `json:"locations" validate:"required"`
}

LocationCollection : location collection.

type LocationCrossConnectRouterCollection

type LocationCrossConnectRouterCollection struct {
	// Array of Routers for this location.
	CrossConnectRouters []CrossConnectRouter `json:"cross_connect_routers,omitempty"`
}

LocationCrossConnectRouterCollection : List of cross connect router details.

type LocationOutput

type LocationOutput struct {
	// Billing location.  Only present for locations where provisioning is enabled.
	BillingLocation *string `json:"billing_location,omitempty"`

	// Building colocation owner.  Only present for offering_type=dedicated locations where provisioning is enabled.
	BuildingColocationOwner *string `json:"building_colocation_owner,omitempty"`

	// Location long name.
	DisplayName *string `json:"display_name" validate:"required"`

	// Location type.
	LocationType *string `json:"location_type" validate:"required"`

	// Indicate whether location supports MACsec.  Only returned for gateway type=dedicated locations.  Contact IBM support
	// for access to MACsec.
	MacsecEnabled *bool `json:"macsec_enabled,omitempty"`

	// Location market.
	Market *string `json:"market" validate:"required"`

	// Location geography.  Only present for locations where provisioning is enabled.
	MarketGeography *string `json:"market_geography,omitempty"`

	// Is location a multi-zone region (MZR).  Only present for locations where provisioning is enabled.
	Mzr *bool `json:"mzr,omitempty"`

	// Location short name.
	Name *string `json:"name" validate:"required"`

	// Location offering type.
	OfferingType *string `json:"offering_type" validate:"required"`

	// Indicates for the specific offering_type whether this location supports gateway provisioning.
	ProvisionEnabled *bool `json:"provision_enabled" validate:"required"`

	// Location's VPC region.  Only present for locations where provisioning is enabled.
	VpcRegion *string `json:"vpc_region,omitempty"`
}

LocationOutput : location.

type OfferingSpeed

type OfferingSpeed struct {
	// Array of capabilities for billing option.
	Capabilities []string `json:"capabilities" validate:"required"`

	// Link speed in megabits per second.
	LinkSpeed *int64 `json:"link_speed" validate:"required"`

	// Indicate whether speed supports MACsec.  Only returned for gateway type=dedicated speeds.  Contact IBM support for
	// access to MACsec.
	MacsecEnabled *bool `json:"macsec_enabled,omitempty"`
}

OfferingSpeed : Speed.

type OfferingSpeedCollection

type OfferingSpeedCollection struct {
	// speed list.
	Speeds []OfferingSpeed `json:"speeds" validate:"required"`
}

OfferingSpeedCollection : List of speeds.

type Port

type Port struct {
	// Count of existing Direct Link gateways in this account on this port.
	DirectLinkCount *int64 `json:"direct_link_count" validate:"required"`

	// Port identifier.
	ID *string `json:"id" validate:"required"`

	// Port Label.
	Label *string `json:"label" validate:"required"`

	// Port location long name.
	LocationDisplayName *string `json:"location_display_name" validate:"required"`

	// Port location name identifier.
	LocationName *string `json:"location_name" validate:"required"`

	// Port's provider name.
	ProviderName *string `json:"provider_name" validate:"required"`

	// Port's supported speeds in megabits per second.
	SupportedLinkSpeeds []int64 `json:"supported_link_speeds" validate:"required"`
}

Port : Provider port details.

type PortCollection

type PortCollection struct {
	// A reference to the first page of resources.
	First *PortsPaginatedCollectionFirst `json:"first" validate:"required"`

	// The maximum number of resources can be returned by the request.
	Limit *int64 `json:"limit" validate:"required"`

	// A reference to the next page of resources; this reference is included for all pages except the last page.
	Next *PortsPaginatedCollectionNext `json:"next,omitempty"`

	// The total number of resources across all pages.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Array of ports.
	Ports []Port `json:"ports,omitempty"`
}

PortCollection : List of port label details.

func (*PortCollection) GetNextStart added in v0.26.0

func (resp *PortCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type PortsPager added in v0.39.0

type PortsPager struct {
	// contains filtered or unexported fields
}

PortsPager can be used to simplify the use of the "ListPorts" method.

func (*PortsPager) GetAll added in v0.39.0

func (pager *PortsPager) GetAll() (allItems []Port, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*PortsPager) GetAllWithContext added in v0.39.0

func (pager *PortsPager) GetAllWithContext(ctx context.Context) (allItems []Port, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*PortsPager) GetNext added in v0.39.0

func (pager *PortsPager) GetNext() (page []Port, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*PortsPager) GetNextWithContext added in v0.39.0

func (pager *PortsPager) GetNextWithContext(ctx context.Context) (page []Port, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*PortsPager) HasNext added in v0.39.0

func (pager *PortsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type PortsPaginatedCollectionFirst

type PortsPaginatedCollectionFirst struct {
	// The URL for the first page of resources.
	Href *string `json:"href" validate:"required"`
}

PortsPaginatedCollectionFirst : A reference to the first page of resources.

type PortsPaginatedCollectionNext

type PortsPaginatedCollectionNext struct {
	// URL for the next page of resources.
	Href *string `json:"href" validate:"required"`

	// start token for the next page of resources.
	Start *string `json:"start,omitempty"`
}

PortsPaginatedCollectionNext : A reference to the next page of resources; this reference is included for all pages except the last page.

type ReplaceGatewayAsPrependsOptions added in v0.35.0

type ReplaceGatewayAsPrependsOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// If present, the request will fail if the specified ETag value does not match the resource's current ETag value.
	IfMatch *string `json:"If-Match" validate:"required"`

	// array of AS Prepend configuration information.
	AsPrepends []AsPrependPrefixArrayTemplate `json:"as_prepends,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ReplaceGatewayAsPrependsOptions : The ReplaceGatewayAsPrepends options.

func (*ReplaceGatewayAsPrependsOptions) SetAsPrepends added in v0.35.0

SetAsPrepends : Allow user to set AsPrepends

func (*ReplaceGatewayAsPrependsOptions) SetGatewayID added in v0.35.0

func (_options *ReplaceGatewayAsPrependsOptions) SetGatewayID(gatewayID string) *ReplaceGatewayAsPrependsOptions

SetGatewayID : Allow user to set GatewayID

func (*ReplaceGatewayAsPrependsOptions) SetHeaders added in v0.35.0

SetHeaders : Allow user to set Headers

func (*ReplaceGatewayAsPrependsOptions) SetIfMatch added in v0.35.0

SetIfMatch : Allow user to set IfMatch

type ReplaceGatewayExportRouteFiltersOptions added in v0.39.0

type ReplaceGatewayExportRouteFiltersOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// If present, the request will fail if the specified ETag value does not match the resource's current ETag value.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ExportRouteFilters []GatewayTemplateRouteFilter `json:"export_route_filters,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ReplaceGatewayExportRouteFiltersOptions : The ReplaceGatewayExportRouteFilters options.

func (*ReplaceGatewayExportRouteFiltersOptions) SetExportRouteFilters added in v0.39.0

SetExportRouteFilters : Allow user to set ExportRouteFilters

func (*ReplaceGatewayExportRouteFiltersOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*ReplaceGatewayExportRouteFiltersOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*ReplaceGatewayExportRouteFiltersOptions) SetIfMatch added in v0.39.0

SetIfMatch : Allow user to set IfMatch

type ReplaceGatewayImportRouteFiltersOptions added in v0.39.0

type ReplaceGatewayImportRouteFiltersOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// If present, the request will fail if the specified ETag value does not match the resource's current ETag value.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route
	// filters, the order of the items in the array will set the ordering of the list of route filters.
	ImportRouteFilters []GatewayTemplateRouteFilter `json:"import_route_filters,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ReplaceGatewayImportRouteFiltersOptions : The ReplaceGatewayImportRouteFilters options.

func (*ReplaceGatewayImportRouteFiltersOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*ReplaceGatewayImportRouteFiltersOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*ReplaceGatewayImportRouteFiltersOptions) SetIfMatch added in v0.39.0

SetIfMatch : Allow user to set IfMatch

func (*ReplaceGatewayImportRouteFiltersOptions) SetImportRouteFilters added in v0.39.0

SetImportRouteFilters : Allow user to set ImportRouteFilters

type ResourceGroupIdentity

type ResourceGroupIdentity struct {
	// Resource group identifier.
	ID *string `json:"id" validate:"required"`
}

ResourceGroupIdentity : Resource group for this resource. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.

type ResourceGroupReference

type ResourceGroupReference struct {
	// Resource group identifier.
	ID *string `json:"id" validate:"required"`
}

ResourceGroupReference : Resource group reference.

type RouteFilter added in v0.39.0

type RouteFilter struct {
	// Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.
	Action *string `json:"action" validate:"required"`

	// Identifier of the next route filter considered if a route does not match the current filter. This property builds
	// the ordering among route filters and follows semantics:
	// - When before is an identifier of a route filter that exists and is in the same collection, a route will first
	// attempt to match on the current filter before preceding to the filter referenced in this property.
	// - When a filter is created with before that matches another filter in the same collection, the existing filter will
	// take precedence. The before of the existing filter will be updated to refer to the newly created filter. The newly
	// created filter will refer to the route filter identified by the provided before.
	// - When a filter is created without a before, it takes the lowest precedence. The existing filter of lowest
	// precedence will be updated to refer to the newly created filter.
	Before *string `json:"before,omitempty"`

	// The date and time the route filter was created in ISO 8601 format.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The minimum matching length of the prefix-set (mnemonic for greater than or equal to).
	Ge *int64 `json:"ge,omitempty"`

	// The identifier of a route filter.
	ID *string `json:"id" validate:"required"`

	// The maximum matching length of the prefix-set (mnemonic for less than or equal to).
	Le *int64 `json:"le,omitempty"`

	// IP prefix representing an address and mask length of the prefix-set.
	Prefix *string `json:"prefix" validate:"required"`

	// The date and time the route filter was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

RouteFilter : Route filter.

type RouteReport added in v0.34.0

type RouteReport struct {
	// Array of connection prefixes advertised to the on-prem network. This parameter is not returned when the route report
	// was generated prior to inclusion of this parameter.
	AdvertisedRoutes []RouteReportAdvertisedRoute `json:"advertised_routes,omitempty"`

	// Date and time route report was requested.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Array of local/direct routes.
	GatewayRoutes []RouteReportRoute `json:"gateway_routes" validate:"required"`

	// Report identifier.
	ID *string `json:"id" validate:"required"`

	// Array of on premises routes.
	OnPremRoutes []RouteReportOnPremRoute `json:"on_prem_routes" validate:"required"`

	// Array of overlapping routes.
	OverlappingRoutes []RouteReportOverlappingRouteGroup `json:"overlapping_routes" validate:"required"`

	// Route report status. The list of enumerated values for this property may expand in the future. Code and processes
	// using this field must tolerate unexpected values.
	Status *string `json:"status" validate:"required"`

	// Date and time route report was last modified.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Array of routes on virtual connections.
	VirtualConnectionRoutes []RouteReportConnection `json:"virtual_connection_routes" validate:"required"`
}

RouteReport : route report.

type RouteReportAdvertisedRoute added in v0.42.2

type RouteReportAdvertisedRoute struct {
	// The BGP AS path of the route.
	AsPath *string `json:"as_path" validate:"required"`

	// prefix.
	Prefix *string `json:"prefix" validate:"required"`
}

RouteReportAdvertisedRoute : Route advertised to the on-prem network.

type RouteReportCollection added in v0.34.0

type RouteReportCollection struct {
	// Array of route reports.
	RouteReports []RouteReport `json:"route_reports" validate:"required"`
}

RouteReportCollection : route reports.

type RouteReportConnection added in v0.34.0

type RouteReportConnection struct {
	// Array of virtual connection's routes.
	Routes []RouteReportVirtualConnectionRoute `json:"routes" validate:"required"`

	// ID of virtual connection.
	VirtualConnectionID *string `json:"virtual_connection_id,omitempty"`

	// name of virtual connection.
	VirtualConnectionName *string `json:"virtual_connection_name,omitempty"`

	// type of virtual connection.
	VirtualConnectionType *string `json:"virtual_connection_type,omitempty"`
}

RouteReportConnection : Routes of a virtual connection.

type RouteReportOnPremRoute added in v0.34.0

type RouteReportOnPremRoute struct {
	// The BGP AS path of the route.
	AsPath *string `json:"as_path,omitempty"`

	// Next hop address.
	NextHop *string `json:"next_hop,omitempty"`

	// prefix.
	Prefix *string `json:"prefix,omitempty"`
}

RouteReportOnPremRoute : on-prem route.

type RouteReportOverlappingRoute added in v0.34.0

type RouteReportOverlappingRoute struct {
	// overlapping prefix.
	Prefix *string `json:"prefix,omitempty"`

	// type of the route.
	Type *string `json:"type,omitempty"`

	// virtual connection ID.
	VirtualConnectionID *string `json:"virtual_connection_id,omitempty"`
}

RouteReportOverlappingRoute : overlapping route details. Models which "extend" this model: - RouteReportOverlappingRouteForConnection - RouteReportOverlappingRouteForOthers

type RouteReportOverlappingRouteForConnection added in v0.34.0

type RouteReportOverlappingRouteForConnection struct {
	// overlapping prefix.
	Prefix *string `json:"prefix" validate:"required"`

	// type of the route.
	Type *string `json:"type" validate:"required"`

	// virtual connection ID.
	VirtualConnectionID *string `json:"virtual_connection_id" validate:"required"`
}

RouteReportOverlappingRouteForConnection : overlapping route details. This model "extends" RouteReportOverlappingRoute

type RouteReportOverlappingRouteForOthers added in v0.34.0

type RouteReportOverlappingRouteForOthers struct {
	// overlapping prefix.
	Prefix *string `json:"prefix" validate:"required"`

	// type of the route.
	Type *string `json:"type" validate:"required"`
}

RouteReportOverlappingRouteForOthers : overlapping route details. This model "extends" RouteReportOverlappingRoute

type RouteReportOverlappingRouteGroup added in v0.34.0

type RouteReportOverlappingRouteGroup struct {
	// Array of overlapping connection/prefix pairs.
	Routes []RouteReportOverlappingRouteIntf `json:"routes,omitempty"`
}

RouteReportOverlappingRouteGroup : Collection of overlapping route.

type RouteReportOverlappingRouteIntf added in v0.34.0

type RouteReportOverlappingRouteIntf interface {
	// contains filtered or unexported methods
}

type RouteReportRoute added in v0.34.0

type RouteReportRoute struct {
	// prefix.
	Prefix *string `json:"prefix,omitempty"`
}

RouteReportRoute : route.

type RouteReportVirtualConnectionRoute added in v0.42.2

type RouteReportVirtualConnectionRoute struct {
	// Indicates whether the route is the preferred path of the prefix.
	Active *bool `json:"active,omitempty"`

	// The local preference of the route. This attribute can manipulate the chosen path on routes.
	LocalPreference *string `json:"local_preference,omitempty"`

	// prefix.
	Prefix *string `json:"prefix" validate:"required"`
}

RouteReportVirtualConnectionRoute : A route originating from an attached virtual connection.

type SakRekey added in v0.51.7

type SakRekey struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval,omitempty"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode,omitempty"`
}

SakRekey : Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Models which "extend" this model: - SakRekeyTimerMode - SakRekeyPacketNumberRolloverMode

type SakRekeyIntf added in v0.51.7

type SakRekeyIntf interface {
	// contains filtered or unexported methods
}

type SakRekeyPacketNumberRolloverMode added in v0.51.7

type SakRekeyPacketNumberRolloverMode struct {
	// Determines that the SAK rekey occurs based on the used packet numbers.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyPacketNumberRolloverMode : SAK rekey mode based on a high proportion of used packet numbers with the current SAK (the exact threshold determined at the system's discretion). This model "extends" SakRekey

type SakRekeyPatch added in v0.51.7

type SakRekeyPatch struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval,omitempty"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode,omitempty"`
}

SakRekeyPatch : Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Models which "extend" this model: - SakRekeyPatchSakRekeyTimerModePatch - SakRekeyPatchSakRekeyPacketNumberRolloverModePatch

type SakRekeyPatchIntf added in v0.51.7

type SakRekeyPatchIntf interface {
	// contains filtered or unexported methods
}

type SakRekeyPatchSakRekeyPacketNumberRolloverModePatch added in v0.51.7

type SakRekeyPatchSakRekeyPacketNumberRolloverModePatch struct {
	// Determines that the SAK rekey occurs based on the used packet numbers.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyPatchSakRekeyPacketNumberRolloverModePatch : SAK rekey mode based on a high proportion of used packet numbers with the current SAK (the exact threshold determined at the system's discretion). This model "extends" SakRekeyPatch

type SakRekeyPatchSakRekeyTimerModePatch added in v0.51.7

type SakRekeyPatchSakRekeyTimerModePatch struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval" validate:"required"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyPatchSakRekeyTimerModePatch : SAK rekey mode based on length of time since last rekey. This model "extends" SakRekeyPatch

type SakRekeyPrototype added in v0.51.7

type SakRekeyPrototype struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval,omitempty"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode,omitempty"`
}

SakRekeyPrototype : Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Models which "extend" this model: - SakRekeyPrototypeSakRekeyTimerModePrototype - SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype

type SakRekeyPrototypeIntf added in v0.51.7

type SakRekeyPrototypeIntf interface {
	// contains filtered or unexported methods
}

type SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype added in v0.51.7

type SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype struct {
	// Determines that the SAK rekey occurs based on the used packet numbers.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyPrototypeSakRekeyPacketNumberRolloverModePrototype : Packet number (PN) rollover SAK rekey mode. The SAK is rekeyed based on the proportion of used packet numbers with the current SAK. This model "extends" SakRekeyPrototype

type SakRekeyPrototypeSakRekeyTimerModePrototype added in v0.51.7

type SakRekeyPrototypeSakRekeyTimerModePrototype struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval" validate:"required"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyPrototypeSakRekeyTimerModePrototype : SAK rekey mode based on length of time since last rekey. This model "extends" SakRekeyPrototype

type SakRekeyTimerMode added in v0.51.7

type SakRekeyTimerMode struct {
	// The time, in seconds, to force a Secure Association Key (SAK) rekey.
	Interval *int64 `json:"interval" validate:"required"`

	// Determines that the SAK rekey occurs based on a timer.
	Mode *string `json:"mode" validate:"required"`
}

SakRekeyTimerMode : SAK rekey mode based on length of time since last rekey. This model "extends" SakRekey

type SetGatewayMacsecOptions added in v0.51.7

type SetGatewayMacsecOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Determines if the MACsec feature should initially be active (true) or inactive (false) for a gateway.
	Active *bool `json:"active" validate:"required"`

	// List of all connectivity association keys (CAKs) to be associated associated with the MACsec feature on a direct
	// link.
	//
	// There must be at least one CAK with `session`: `primary`. There can be at most one CAK with `session`: `fallback`
	//
	// All CAKs must reference a unique key.
	Caks []GatewayMacsecCakPrototype `json:"caks" validate:"required"`

	// Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers.
	SakRekey SakRekeyPrototypeIntf `json:"sak_rekey" validate:"required"`

	// Determines how packets without MACsec headers are handled.
	//
	// `must_secure` - Packets without MACsec headers are dropped. This policy should be used to prefer security over
	// network availability.
	// `should_secure` - Packets without MACsec headers are allowed. This policy should be used to prefer network
	// availability over security.
	SecurityPolicy *string `json:"security_policy" validate:"required"`

	// The window size determines the number of frames in a window for replay protection.
	//
	// Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not
	// replay protected.
	WindowSize *int64 `json:"window_size,omitempty"`

	// If present, the request will fail if the specified ETag value does not match the resource's current ETag value.
	//
	// `If-Match` is required when the resource exists and has an ETag value.
	IfMatch *string `json:"If-Match,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

SetGatewayMacsecOptions : The SetGatewayMacsec options.

func (*SetGatewayMacsecOptions) SetActive added in v0.51.7

func (_options *SetGatewayMacsecOptions) SetActive(active bool) *SetGatewayMacsecOptions

SetActive : Allow user to set Active

func (*SetGatewayMacsecOptions) SetCaks added in v0.51.7

SetCaks : Allow user to set Caks

func (*SetGatewayMacsecOptions) SetHeaders added in v0.51.7

func (options *SetGatewayMacsecOptions) SetHeaders(param map[string]string) *SetGatewayMacsecOptions

SetHeaders : Allow user to set Headers

func (*SetGatewayMacsecOptions) SetID added in v0.51.7

SetID : Allow user to set ID

func (*SetGatewayMacsecOptions) SetIfMatch added in v0.51.7

func (_options *SetGatewayMacsecOptions) SetIfMatch(ifMatch string) *SetGatewayMacsecOptions

SetIfMatch : Allow user to set IfMatch

func (*SetGatewayMacsecOptions) SetSakRekey added in v0.51.7

SetSakRekey : Allow user to set SakRekey

func (*SetGatewayMacsecOptions) SetSecurityPolicy added in v0.51.7

func (_options *SetGatewayMacsecOptions) SetSecurityPolicy(securityPolicy string) *SetGatewayMacsecOptions

SetSecurityPolicy : Allow user to set SecurityPolicy

func (*SetGatewayMacsecOptions) SetWindowSize added in v0.51.7

func (_options *SetGatewayMacsecOptions) SetWindowSize(windowSize int64) *SetGatewayMacsecOptions

SetWindowSize : Allow user to set WindowSize

type UnsetGatewayMacsecOptions added in v0.51.7

type UnsetGatewayMacsecOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UnsetGatewayMacsecOptions : The UnsetGatewayMacsec options.

func (*UnsetGatewayMacsecOptions) SetHeaders added in v0.51.7

func (options *UnsetGatewayMacsecOptions) SetHeaders(param map[string]string) *UnsetGatewayMacsecOptions

SetHeaders : Allow user to set Headers

func (*UnsetGatewayMacsecOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type UpdateGatewayExportRouteFilterOptions added in v0.39.0

type UpdateGatewayExportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// The export route filter update template.
	UpdateRouteFilterTemplatePatch map[string]interface{} `json:"UpdateRouteFilterTemplate_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayExportRouteFilterOptions : The UpdateGatewayExportRouteFilter options.

func (*UpdateGatewayExportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*UpdateGatewayExportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*UpdateGatewayExportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

func (*UpdateGatewayExportRouteFilterOptions) SetUpdateRouteFilterTemplatePatch added in v0.39.0

func (_options *UpdateGatewayExportRouteFilterOptions) SetUpdateRouteFilterTemplatePatch(updateRouteFilterTemplatePatch map[string]interface{}) *UpdateGatewayExportRouteFilterOptions

SetUpdateRouteFilterTemplatePatch : Allow user to set UpdateRouteFilterTemplatePatch

type UpdateGatewayImportRouteFilterOptions added in v0.39.0

type UpdateGatewayImportRouteFilterOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// Identifier of an import route filter.
	ID *string `json:"id" validate:"required,ne="`

	// The import route filter update template.
	UpdateRouteFilterTemplatePatch map[string]interface{} `json:"UpdateRouteFilterTemplate_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayImportRouteFilterOptions : The UpdateGatewayImportRouteFilter options.

func (*UpdateGatewayImportRouteFilterOptions) SetGatewayID added in v0.39.0

SetGatewayID : Allow user to set GatewayID

func (*UpdateGatewayImportRouteFilterOptions) SetHeaders added in v0.39.0

SetHeaders : Allow user to set Headers

func (*UpdateGatewayImportRouteFilterOptions) SetID added in v0.39.0

SetID : Allow user to set ID

func (*UpdateGatewayImportRouteFilterOptions) SetUpdateRouteFilterTemplatePatch added in v0.39.0

func (_options *UpdateGatewayImportRouteFilterOptions) SetUpdateRouteFilterTemplatePatch(updateRouteFilterTemplatePatch map[string]interface{}) *UpdateGatewayImportRouteFilterOptions

SetUpdateRouteFilterTemplatePatch : Allow user to set UpdateRouteFilterTemplatePatch

type UpdateGatewayMacsecCakOptions added in v0.51.7

type UpdateGatewayMacsecCakOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// MACsec CAK identifier.
	CakID *string `json:"cak_id" validate:"required,ne="`

	// The MACsec CAK patch.
	GatewayMacsecCakPatch map[string]interface{} `json:"GatewayMacsecCak_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayMacsecCakOptions : The UpdateGatewayMacsecCak options.

func (*UpdateGatewayMacsecCakOptions) SetCakID added in v0.51.7

SetCakID : Allow user to set CakID

func (*UpdateGatewayMacsecCakOptions) SetGatewayMacsecCakPatch added in v0.51.7

func (_options *UpdateGatewayMacsecCakOptions) SetGatewayMacsecCakPatch(gatewayMacsecCakPatch map[string]interface{}) *UpdateGatewayMacsecCakOptions

SetGatewayMacsecCakPatch : Allow user to set GatewayMacsecCakPatch

func (*UpdateGatewayMacsecCakOptions) SetHeaders added in v0.51.7

SetHeaders : Allow user to set Headers

func (*UpdateGatewayMacsecCakOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type UpdateGatewayMacsecOptions added in v0.51.7

type UpdateGatewayMacsecOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// The MACsec configuration patch.
	GatewayMacsecPatch map[string]interface{} `json:"GatewayMacsec_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayMacsecOptions : The UpdateGatewayMacsec options.

func (*UpdateGatewayMacsecOptions) SetGatewayMacsecPatch added in v0.51.7

func (_options *UpdateGatewayMacsecOptions) SetGatewayMacsecPatch(gatewayMacsecPatch map[string]interface{}) *UpdateGatewayMacsecOptions

SetGatewayMacsecPatch : Allow user to set GatewayMacsecPatch

func (*UpdateGatewayMacsecOptions) SetHeaders added in v0.51.7

func (options *UpdateGatewayMacsecOptions) SetHeaders(param map[string]string) *UpdateGatewayMacsecOptions

SetHeaders : Allow user to set Headers

func (*UpdateGatewayMacsecOptions) SetID added in v0.51.7

SetID : Allow user to set ID

type UpdateGatewayOptions

type UpdateGatewayOptions struct {
	// Direct Link gateway identifier.
	ID *string `json:"id" validate:"required,ne="`

	// The Direct Link gateway patch.
	GatewayPatchTemplatePatch map[string]interface{} `json:"GatewayPatchTemplate_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayOptions : The UpdateGateway options.

func (*UpdateGatewayOptions) SetGatewayPatchTemplatePatch added in v0.45.0

func (_options *UpdateGatewayOptions) SetGatewayPatchTemplatePatch(gatewayPatchTemplatePatch map[string]interface{}) *UpdateGatewayOptions

SetGatewayPatchTemplatePatch : Allow user to set GatewayPatchTemplatePatch

func (*UpdateGatewayOptions) SetHeaders

func (options *UpdateGatewayOptions) SetHeaders(param map[string]string) *UpdateGatewayOptions

SetHeaders : Allow user to set Headers

func (*UpdateGatewayOptions) SetID

func (_options *UpdateGatewayOptions) SetID(id string) *UpdateGatewayOptions

SetID : Allow user to set ID

type UpdateGatewayVirtualConnectionOptions

type UpdateGatewayVirtualConnectionOptions struct {
	// Direct Link gateway identifier.
	GatewayID *string `json:"gateway_id" validate:"required,ne="`

	// The virtual connection identifier.
	ID *string `json:"id" validate:"required,ne="`

	// The virtual connection patch template.
	GatewayVirtualConnectionPatchTemplatePatch map[string]interface{} `json:"GatewayVirtualConnectionPatchTemplate_patch" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

UpdateGatewayVirtualConnectionOptions : The UpdateGatewayVirtualConnection options.

func (*UpdateGatewayVirtualConnectionOptions) SetGatewayID

SetGatewayID : Allow user to set GatewayID

func (*UpdateGatewayVirtualConnectionOptions) SetGatewayVirtualConnectionPatchTemplatePatch added in v0.51.7

func (_options *UpdateGatewayVirtualConnectionOptions) SetGatewayVirtualConnectionPatchTemplatePatch(gatewayVirtualConnectionPatchTemplatePatch map[string]interface{}) *UpdateGatewayVirtualConnectionOptions

SetGatewayVirtualConnectionPatchTemplatePatch : Allow user to set GatewayVirtualConnectionPatchTemplatePatch

func (*UpdateGatewayVirtualConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateGatewayVirtualConnectionOptions) SetID

SetID : Allow user to set ID

type UpdateRouteFilterTemplate added in v0.39.0

type UpdateRouteFilterTemplate struct {
	// Determines whether routes that match the prefix-set will be allowed (permit) or rejected (deny) through the filter.
	Action *string `json:"action,omitempty"`

	// Identifier of the next route filter considered if a route does not match the current filter. This property builds
	// the ordering among route filters and follows semantics:
	// - When before is an identifier of a route filter that exists and is in the same collection, a route will first
	// attempt to match on the current filter before preceding to the filter referenced in this property.
	// - When a filter is created with before that matches another filter in the same collection, the existing filter will
	// take precedence. The before of the existing filter will be updated to refer to the newly created filter. The newly
	// created filter will refer to the route filter identified by the provided before.
	// - When a filter is created without a before, it takes the lowest precedence. The existing filter of lowest
	// precedence will be updated to refer to the newly created filter.
	Before *string `json:"before,omitempty"`

	// The minimum matching length of the prefix-set (mnemonic for greater than or equal to).
	//
	// To clear the minimum matching length of the filter, patch the value to `0`.
	Ge *int64 `json:"ge,omitempty"`

	// The maximum matching length of the prefix-set (mnemonic for less than or equal to).
	//
	// To clear the maximum matching length of the filter, patch the value to `0`.
	Le *int64 `json:"le,omitempty"`

	// IP prefix representing an address and mask length of the prefix-set.
	Prefix *string `json:"prefix,omitempty"`
}

UpdateRouteFilterTemplate : The route filter update template.

func (*UpdateRouteFilterTemplate) AsPatch added in v0.39.0

func (updateRouteFilterTemplate *UpdateRouteFilterTemplate) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the UpdateRouteFilterTemplate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL