directlinkv1

package
v0.32.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2022 License: Apache-2.0 Imports: 10 Imported by: 6

Documentation

Overview

Package directlinkv1 : Operations and models for the DirectLinkV1 service

Index

Constants

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 (
	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_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_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_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.

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 (
	GatewayMacsecConfig_Status_Init    = "init"
	GatewayMacsecConfig_Status_Offline = "offline"
	GatewayMacsecConfig_Status_Pending = "pending"
	GatewayMacsecConfig_Status_Secured = "secured"
)

Constants associated with the GatewayMacsecConfig.Status property. Current status of MACsec on this gateway.

Status 'offline' is returned during gateway creation and deletion.

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_Type_Connect   = "connect"
	GatewayTemplate_Type_Dedicated = "dedicated"
)

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

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 (
	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 (
	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 (
	UpdateGatewayOptions_ConnectionMode_Direct  = "direct"
	UpdateGatewayOptions_ConnectionMode_Transit = "transit"
)

Constants associated with the UpdateGatewayOptions.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 (
	UpdateGatewayOptions_OperationalStatus_LoaAccepted = "loa_accepted"
	UpdateGatewayOptions_OperationalStatus_LoaRejected = "loa_rejected"
)

Constants associated with the UpdateGatewayOptions.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 (
	UpdateGatewayVirtualConnectionOptions_Status_Attached = "attached"
	UpdateGatewayVirtualConnectionOptions_Status_Rejected = "rejected"
)

Constants associated with the UpdateGatewayVirtualConnectionOptions.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 (
	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_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_Type_Connect   = "connect"
	GatewayTemplateGatewayTypeDedicatedTemplate_Type_Dedicated = "dedicated"
)

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

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 (
	GatewayMacsecConfig_CipherSuite_GcmAesXpn256 = "gcm_aes_xpn_256"
)

Constants associated with the GatewayMacsecConfig.CipherSuite property. SAK cipher suite.

View Source 
const (
	GatewayMacsecConfig_CryptographicAlgorithm_Aes256Cmac = "aes_256_cmac"
)

Constants associated with the GatewayMacsecConfig.CryptographicAlgorithm property. cryptographic algorithm.

View Source 
const (
	GatewayMacsecConfig_SecurityPolicy_MustSecure = "must_secure"
)

Constants associated with the GatewayMacsecConfig.SecurityPolicy property. Packets without MACsec headers are dropped when security_policy is `must_secure`.

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 (
	GatewayStatus_Type_Bgp = "bgp"
)

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

View Source 
const (
	ListOfferingTypeLocationCrossConnectRoutersOptions_OfferingType_Dedicated = "dedicated"
)

Constants associated with the ListOfferingTypeLocationCrossConnectRoutersOptions.OfferingType property. The Direct Link offering type. Only value `"dedicated"` is supported for this API.

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 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 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 UnmarshalGatewayActionTemplateAuthenticationKey added in v0.15.0 

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

UnmarshalGatewayActionTemplateAuthenticationKey unmarshals an instance of GatewayActionTemplateAuthenticationKey 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 UnmarshalGatewayAuthenticationKey added in v0.15.0 

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

UnmarshalGatewayAuthenticationKey unmarshals an instance of GatewayAuthenticationKey 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 UnmarshalGatewayMacsecConfig added in v0.11.0 

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

UnmarshalGatewayMacsecConfig unmarshals an instance of GatewayMacsecConfig from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigActiveCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigActiveCak unmarshals an instance of GatewayMacsecConfigActiveCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigFallbackCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigFallbackCak unmarshals an instance of GatewayMacsecConfigFallbackCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigPatchTemplate added in v0.11.0 

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

UnmarshalGatewayMacsecConfigPatchTemplate unmarshals an instance of GatewayMacsecConfigPatchTemplate from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigPatchTemplateFallbackCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigPatchTemplateFallbackCak unmarshals an instance of GatewayMacsecConfigPatchTemplateFallbackCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigPatchTemplatePrimaryCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigPatchTemplatePrimaryCak unmarshals an instance of GatewayMacsecConfigPatchTemplatePrimaryCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigPrimaryCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigPrimaryCak unmarshals an instance of GatewayMacsecConfigPrimaryCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigTemplate added in v0.11.0 

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

UnmarshalGatewayMacsecConfigTemplate unmarshals an instance of GatewayMacsecConfigTemplate from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigTemplateFallbackCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigTemplateFallbackCak unmarshals an instance of GatewayMacsecConfigTemplateFallbackCak from the specified map of raw messages.

func UnmarshalGatewayMacsecConfigTemplatePrimaryCak added in v0.11.1 

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

UnmarshalGatewayMacsecConfigTemplatePrimaryCak unmarshals an instance of GatewayMacsecConfigTemplatePrimaryCak from the specified map of raw messages.

func UnmarshalGatewayPatchTemplateAuthenticationKey added in v0.18.0 

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

UnmarshalGatewayPatchTemplateAuthenticationKey unmarshals an instance of GatewayPatchTemplateAuthenticationKey from the specified map of raw messages.

func UnmarshalGatewayPort 

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

UnmarshalGatewayPort unmarshals an instance of GatewayPort 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 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 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 UnmarshalGatewayTemplateAuthenticationKey added in v0.18.0 

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

UnmarshalGatewayTemplateAuthenticationKey unmarshals an instance of GatewayTemplateAuthenticationKey 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 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 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.

Types

type CreateGatewayActionOptions 

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

	// Action request.
	Action *string `json:"action" validate:"required"`

	// Applicable for create_gateway_approve requests to select the gateway's BGP MD5 authentication key.
	// The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in
	// length.
	// To clear the optional `authentication_key` field patch its crn to `""`.
	AuthenticationKey *GatewayActionTemplateAuthenticationKey `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"`

	// 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"`

	// 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) SetAuthenticationKey added in v0.15.0 

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

SetAuthenticationKey : Allow user to set AuthenticationKey

func (*CreateGatewayActionOptions) SetBfdConfig added in v0.23.0 

func (_options *CreateGatewayActionOptions) SetBfdConfig(bfdConfig *GatewayBfdConfigActionTemplate) *CreateGatewayActionOptions

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) 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 

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

SetID : Allow user to set ID

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 

func (_options *CreateGatewayActionOptions) SetUpdates(updates []GatewayActionTemplateUpdatesItemIntf) *CreateGatewayActionOptions

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 

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

SetHeaders : Allow user to set Headers

func (*CreateGatewayCompletionNoticeOptions) SetID 

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

SetID : Allow user to set ID

func (*CreateGatewayCompletionNoticeOptions) SetUpload 

func (_options *CreateGatewayCompletionNoticeOptions) SetUpload(upload io.ReadCloser) *CreateGatewayCompletionNoticeOptions

SetUpload : Allow user to set Upload

func (*CreateGatewayCompletionNoticeOptions) SetUploadContentType 

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

SetUploadContentType : Allow user to set UploadContentType

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 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 

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

SetGatewayID : Allow user to set GatewayID

func (*CreateGatewayVirtualConnectionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateGatewayVirtualConnectionOptions) SetName 

func (_options *CreateGatewayVirtualConnectionOptions) SetName(name string) *CreateGatewayVirtualConnectionOptions

SetName : Allow user to set Name

func (*CreateGatewayVirtualConnectionOptions) SetNetworkID 

func (_options *CreateGatewayVirtualConnectionOptions) SetNetworkID(networkID string) *CreateGatewayVirtualConnectionOptions

SetNetworkID : Allow user to set NetworkID

func (*CreateGatewayVirtualConnectionOptions) SetType 

func (_options *CreateGatewayVirtualConnectionOptions) SetType(typeVar string) *CreateGatewayVirtualConnectionOptions

SetType : Allow user to set Type

type CrossConnectRouter 

type CrossConnectRouter struct {
	// Array of capabilities for this router.
	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 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 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 

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

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayVirtualConnectionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteGatewayVirtualConnectionOptions) SetID 

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

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) 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) 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 *Gateway, response *core.DetailedResponse, err error)

GetGateway : Get gateway Retrieve a Direct Link gateway.

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 *Gateway, 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) 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) 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) 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) NewCreateGatewayActionOptions 

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

NewCreateGatewayActionOptions : Instantiate CreateGatewayActionOptions

func (*DirectLinkV1) NewCreateGatewayCompletionNoticeOptions 

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

NewCreateGatewayCompletionNoticeOptions : Instantiate CreateGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewCreateGatewayOptions 

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

NewCreateGatewayOptions : Instantiate CreateGatewayOptions

func (*DirectLinkV1) NewCreateGatewayVirtualConnectionOptions 

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

NewCreateGatewayVirtualConnectionOptions : Instantiate CreateGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewDeleteGatewayOptions 

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

NewDeleteGatewayOptions : Instantiate DeleteGatewayOptions

func (*DirectLinkV1) NewDeleteGatewayVirtualConnectionOptions 

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

NewDeleteGatewayVirtualConnectionOptions : Instantiate DeleteGatewayVirtualConnectionOptions

func (*DirectLinkV1) NewGatewayActionTemplateAuthenticationKey added in v0.15.0 

func (*DirectLinkV1) NewGatewayActionTemplateAuthenticationKey(crn string) (_model *GatewayActionTemplateAuthenticationKey, err error)

NewGatewayActionTemplateAuthenticationKey : Instantiate GatewayActionTemplateAuthenticationKey (Generic Model Constructor)

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) NewGatewayMacsecConfigPatchTemplateFallbackCak added in v0.11.1 

func (*DirectLinkV1) NewGatewayMacsecConfigPatchTemplateFallbackCak(crn string) (_model *GatewayMacsecConfigPatchTemplateFallbackCak, err error)

NewGatewayMacsecConfigPatchTemplateFallbackCak : Instantiate GatewayMacsecConfigPatchTemplateFallbackCak (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecConfigPatchTemplatePrimaryCak added in v0.11.1 

func (*DirectLinkV1) NewGatewayMacsecConfigPatchTemplatePrimaryCak(crn string) (_model *GatewayMacsecConfigPatchTemplatePrimaryCak, err error)

NewGatewayMacsecConfigPatchTemplatePrimaryCak : Instantiate GatewayMacsecConfigPatchTemplatePrimaryCak (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecConfigTemplate added in v0.11.0 

func (*DirectLinkV1) NewGatewayMacsecConfigTemplate(active bool, primaryCak *GatewayMacsecConfigTemplatePrimaryCak) (_model *GatewayMacsecConfigTemplate, err error)

NewGatewayMacsecConfigTemplate : Instantiate GatewayMacsecConfigTemplate (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecConfigTemplateFallbackCak added in v0.11.1 

func (*DirectLinkV1) NewGatewayMacsecConfigTemplateFallbackCak(crn string) (_model *GatewayMacsecConfigTemplateFallbackCak, err error)

NewGatewayMacsecConfigTemplateFallbackCak : Instantiate GatewayMacsecConfigTemplateFallbackCak (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayMacsecConfigTemplatePrimaryCak added in v0.11.1 

func (*DirectLinkV1) NewGatewayMacsecConfigTemplatePrimaryCak(crn string) (_model *GatewayMacsecConfigTemplatePrimaryCak, err error)

NewGatewayMacsecConfigTemplatePrimaryCak : Instantiate GatewayMacsecConfigTemplatePrimaryCak (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayPatchTemplateAuthenticationKey added in v0.18.0 

func (*DirectLinkV1) NewGatewayPatchTemplateAuthenticationKey(crn string) (_model *GatewayPatchTemplateAuthenticationKey, err error)

NewGatewayPatchTemplateAuthenticationKey : Instantiate GatewayPatchTemplateAuthenticationKey (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayPortIdentity 

func (*DirectLinkV1) NewGatewayPortIdentity(id string) (_model *GatewayPortIdentity, err error)

NewGatewayPortIdentity : Instantiate GatewayPortIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewGatewayTemplateAuthenticationKey added in v0.18.0 

func (*DirectLinkV1) NewGatewayTemplateAuthenticationKey(crn string) (_model *GatewayTemplateAuthenticationKey, err error)

NewGatewayTemplateAuthenticationKey : Instantiate GatewayTemplateAuthenticationKey (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) NewGetGatewayOptions 

func (*DirectLinkV1) NewGetGatewayOptions(id string) *GetGatewayOptions

NewGetGatewayOptions : Instantiate GetGatewayOptions

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) NewListGatewayCompletionNoticeOptions 

func (*DirectLinkV1) NewListGatewayCompletionNoticeOptions(id string) *ListGatewayCompletionNoticeOptions

NewListGatewayCompletionNoticeOptions : Instantiate ListGatewayCompletionNoticeOptions

func (*DirectLinkV1) NewListGatewayLetterOfAuthorizationOptions 

func (*DirectLinkV1) NewListGatewayLetterOfAuthorizationOptions(id string) *ListGatewayLetterOfAuthorizationOptions

NewListGatewayLetterOfAuthorizationOptions : Instantiate ListGatewayLetterOfAuthorizationOptions

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) NewResourceGroupIdentity 

func (*DirectLinkV1) NewResourceGroupIdentity(id string) (_model *ResourceGroupIdentity, err error)

NewResourceGroupIdentity : Instantiate ResourceGroupIdentity (Generic Model Constructor)

func (*DirectLinkV1) NewUpdateGatewayOptions 

func (*DirectLinkV1) NewUpdateGatewayOptions(id string) *UpdateGatewayOptions

NewUpdateGatewayOptions : Instantiate UpdateGatewayOptions

func (*DirectLinkV1) NewUpdateGatewayVirtualConnectionOptions 

func (*DirectLinkV1) NewUpdateGatewayVirtualConnectionOptions(gatewayID string, id string) *UpdateGatewayVirtualConnectionOptions

NewUpdateGatewayVirtualConnectionOptions : Instantiate UpdateGatewayVirtualConnectionOptions

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) SetServiceURL 

func (directLink *DirectLinkV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

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) 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 Gateway 

type Gateway struct {
	// The identity of the standard key to use for BGP MD5 authentication key.
	// The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in
	// length.
	// To clear the optional `authentication_key` field patch its crn to `""`.
	AuthenticationKey *GatewayAuthenticationKey `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 specificiation 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"`

	// 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"`

	// 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.  For Dedicated Gateways with MACsec configured, return configuration information.
	// Contact IBM support for access to MACsec.
	MacsecConfig *GatewayMacsecConfig `json:"macsec_config,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.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Gateway patch panel complete notification from implementation team.
	PatchPanelCompletionNotice *string `json:"patch_panel_completion_notice,omitempty"`

	// gateway port for type=connect gateways.
	Port *GatewayPort `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 allocated for this gateway.  Only set for type=connect gateways.
	Vlan *int64 `json:"vlan,omitempty"`
}

Gateway : gateway.

type GatewayActionTemplateAuthenticationKey added in v0.15.0 

type GatewayActionTemplateAuthenticationKey struct {
	// The CRN of the [Key Protect Standard
	// Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto
	// Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.
	Crn *string `json:"crn" validate:"required"`
}

GatewayActionTemplateAuthenticationKey : Applicable for create_gateway_approve requests to select the gateway's BGP MD5 authentication key. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`.

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 1 to 4094. This model "extends" GatewayActionTemplateUpdatesItem

type GatewayActionTemplateUpdatesItemIntf 

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

type GatewayAuthenticationKey added in v0.15.0 

type GatewayAuthenticationKey struct {
	// The CRN of the [Key Protect Standard
	// Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto
	// Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.
	Crn *string `json:"crn" validate:"required"`
}

GatewayAuthenticationKey : The identity of the standard key to use for BGP MD5 authentication key. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`.

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 1 to 4094. 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 1 to 4094. 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 []Gateway `json:"gateways" validate:"required"`
}

GatewayCollection : GatewayCollection struct

type GatewayMacsecConfig added in v0.11.0 

type GatewayMacsecConfig struct {
	// Indicate whether MACsec should currently be active (true) or inactive (false) for a MACsec enabled gateway.   To be
	// MACsec enabled a `macsec_config` must be specified at gateway create time.
	Active *bool `json:"active" validate:"required"`

	// Active connectivity association key.
	//
	// During normal operation `active_cak` will match the desired `primary_cak`.  During CAK changes this field can be
	// used to indicate which key is currently active on the gateway.
	ActiveCak *GatewayMacsecConfigActiveCak `json:"active_cak,omitempty"`

	// SAK cipher suite.
	CipherSuite *string `json:"cipher_suite,omitempty"`

	// confidentiality offset.
	ConfidentialityOffset *int64 `json:"confidentiality_offset,omitempty"`

	// cryptographic algorithm.
	CryptographicAlgorithm *string `json:"cryptographic_algorithm,omitempty"`

	// fallback connectivity association key.
	FallbackCak *GatewayMacsecConfigFallbackCak `json:"fallback_cak,omitempty"`

	// key server priority.
	KeyServerPriority *int64 `json:"key_server_priority,omitempty"`

	// desired primary connectivity association key.
	PrimaryCak *GatewayMacsecConfigPrimaryCak `json:"primary_cak" validate:"required"`

	// Secure Association Key (SAK) expiry time in seconds.
	SakExpiryTime *int64 `json:"sak_expiry_time,omitempty"`

	// Packets without MACsec headers are dropped when security_policy is `must_secure`.
	SecurityPolicy *string `json:"security_policy,omitempty"`

	// Current status of MACsec on this gateway.
	//
	// Status 'offline' is returned during gateway creation and deletion.
	Status *string `json:"status" validate:"required"`

	// replay protection window size.
	WindowSize *int64 `json:"window_size,omitempty"`
}

GatewayMacsecConfig : MACsec configuration information. For Dedicated Gateways with MACsec configured, return configuration information. Contact IBM support for access to MACsec.

type GatewayMacsecConfigActiveCak added in v0.11.1 

type GatewayMacsecConfigActiveCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`

	// connectivity association key status.
	Status *string `json:"status" validate:"required"`
}

GatewayMacsecConfigActiveCak : Active connectivity association key.

During normal operation `active_cak` will match the desired `primary_cak`. During CAK changes this field can be used to indicate which key is currently active on the gateway.

type GatewayMacsecConfigFallbackCak added in v0.11.1 

type GatewayMacsecConfigFallbackCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`

	// connectivity association key status.
	Status *string `json:"status" validate:"required"`
}

GatewayMacsecConfigFallbackCak : fallback connectivity association key.

type GatewayMacsecConfigPatchTemplate added in v0.11.0 

type GatewayMacsecConfigPatchTemplate struct {
	// Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway.
	Active *bool `json:"active,omitempty"`

	// Fallback connectivity association key.
	//
	// MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters
	// [a-fA-F0-9].
	// The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].
	//
	// To clear the optional `fallback_cak` field patch its crn to `""`.
	//
	// A gateway's `fallback_cak` crn cannot match its `primary_cak` crn.
	FallbackCak *GatewayMacsecConfigPatchTemplateFallbackCak `json:"fallback_cak,omitempty"`

	// Desired primary connectivity association key.
	//
	// MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters
	// [a-fA-F0-9].
	// The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].
	//
	// A gateway's `primary_cak` crn cannot match its `fallback_cak` crn.
	PrimaryCak *GatewayMacsecConfigPatchTemplatePrimaryCak `json:"primary_cak,omitempty"`

	// replay protection window size.
	WindowSize *int64 `json:"window_size,omitempty"`
}

GatewayMacsecConfigPatchTemplate : MACsec configuration information. When patching any macsec_config fields, no other fields may be specified in the patch request. Contact IBM support for access to MACsec.

A MACsec config cannot be added to a gateway created without MACsec.

type GatewayMacsecConfigPatchTemplateFallbackCak added in v0.11.1 

type GatewayMacsecConfigPatchTemplateFallbackCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`
}

GatewayMacsecConfigPatchTemplateFallbackCak : Fallback connectivity association key.

MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters [a-fA-F0-9]. The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].

To clear the optional `fallback_cak` field patch its crn to `""`.

A gateway's `fallback_cak` crn cannot match its `primary_cak` crn.

type GatewayMacsecConfigPatchTemplatePrimaryCak added in v0.11.1 

type GatewayMacsecConfigPatchTemplatePrimaryCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`
}

GatewayMacsecConfigPatchTemplatePrimaryCak : Desired primary connectivity association key.

MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters [a-fA-F0-9]. The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].

A gateway's `primary_cak` crn cannot match its `fallback_cak` crn.

type GatewayMacsecConfigPrimaryCak added in v0.11.1 

type GatewayMacsecConfigPrimaryCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`

	// connectivity association key status.
	Status *string `json:"status" validate:"required"`
}

GatewayMacsecConfigPrimaryCak : desired primary connectivity association key.

type GatewayMacsecConfigTemplate added in v0.11.0 

type GatewayMacsecConfigTemplate struct {
	// Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway.
	Active *bool `json:"active" validate:"required"`

	// Fallback connectivity association key.
	//
	// The `fallback_cak` crn cannot match the `primary_cak` crn.
	// MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters
	// [a-fA-F0-9].
	// The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].
	FallbackCak *GatewayMacsecConfigTemplateFallbackCak `json:"fallback_cak,omitempty"`

	// Desired primary connectivity association key.
	//
	// MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters
	// [a-fA-F0-9].
	// The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].
	PrimaryCak *GatewayMacsecConfigTemplatePrimaryCak `json:"primary_cak" validate:"required"`

	// replay protection window size.
	WindowSize *int64 `json:"window_size,omitempty"`
}

GatewayMacsecConfigTemplate : MACsec configuration information. Contact IBM support for access to MACsec.

type GatewayMacsecConfigTemplateFallbackCak added in v0.11.1 

type GatewayMacsecConfigTemplateFallbackCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`
}

GatewayMacsecConfigTemplateFallbackCak : Fallback connectivity association key.

The `fallback_cak` crn cannot match the `primary_cak` crn. MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters [a-fA-F0-9]. The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].

type GatewayMacsecConfigTemplatePrimaryCak added in v0.11.1 

type GatewayMacsecConfigTemplatePrimaryCak struct {
	// connectivity association key crn.
	Crn *string `json:"crn" validate:"required"`
}

GatewayMacsecConfigTemplatePrimaryCak : Desired primary connectivity association key.

MACsec keys must be type=standard with key name lengths between 2 to 64 inclusive and contain only characters [a-fA-F0-9]. The key material must be exactly 64 characters in length and contain only [a-fA-F0-9].

type GatewayPatchTemplateAuthenticationKey added in v0.18.0 

type GatewayPatchTemplateAuthenticationKey struct {
	// The CRN of the [Key Protect Standard
	// Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto
	// Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.
	Crn *string `json:"crn" validate:"required"`
}

GatewayPatchTemplateAuthenticationKey : The identity of the standard key to use for BGP MD5 authentication key. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`.

type GatewayPort 

type GatewayPort struct {
	// Port Identifier.
	ID *string `json:"id" validate:"required"`
}

GatewayPort : gateway port for type=connect gateways.

type GatewayPortIdentity 

type GatewayPortIdentity struct {
	// port id.
	ID *string `json:"id" validate:"required"`
}

GatewayPortIdentity : Select Port Label for new type=connect gateway.

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 {
	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 GatewayTemplate 

type GatewayTemplate struct {
	// The identity of the standard key to use for BGP MD5 authentication key.
	// The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in
	// length.
	// To clear the optional `authentication_key` field patch its crn to `""`.
	AuthenticationKey *GatewayTemplateAuthenticationKey `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 specificiation 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"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// 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.  Contact IBM support for access to MACsec.
	MacsecConfig *GatewayMacsecConfigTemplate `json:"macsec_config,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 GatewayTemplateAuthenticationKey added in v0.18.0 

type GatewayTemplateAuthenticationKey struct {
	// The CRN of the [Key Protect Standard
	// Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto
	// Service Standard Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.
	Crn *string `json:"crn" validate:"required"`
}

GatewayTemplateAuthenticationKey : The identity of the standard key to use for BGP MD5 authentication key. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`.

type GatewayTemplateGatewayTypeConnectTemplate 

type GatewayTemplateGatewayTypeConnectTemplate struct {
	AuthenticationKey *GatewayTemplateAuthenticationKey `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 specificiation 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"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// 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 {
	AuthenticationKey *GatewayTemplateAuthenticationKey `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 specificiation 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"`

	// Gateways with global routing (`true`) can connect to networks outside their associated region.
	Global *bool `json:"global" validate:"required"`

	// 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.  Contact IBM support for access to MACsec.
	MacsecConfig *GatewayMacsecConfigTemplate `json:"macsec_config,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 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 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 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 

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

SetID : Allow user to set ID

func (*GetGatewayStatisticsOptions) SetType added in v0.11.0 

func (_options *GetGatewayStatisticsOptions) SetType(typeVar string) *GetGatewayStatisticsOptions

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 

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

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 

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

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayVirtualConnectionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetGatewayVirtualConnectionOptions) SetID 

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

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 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 

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

SetHeaders : Allow user to set Headers

func (*ListGatewayCompletionNoticeOptions) SetID 

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

SetID : Allow user to set ID

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 

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

SetHeaders : Allow user to set Headers

func (*ListGatewayLetterOfAuthorizationOptions) SetID 

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

SetID : Allow user to set ID

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 

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

SetGatewayID : Allow user to set GatewayID

func (*ListGatewayVirtualConnectionsOptions) SetHeaders 

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

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.  Only value `"dedicated"` is supported for this API.
	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 

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

SetHeaders : Allow user to set Headers

func (*ListOfferingTypeLocationCrossConnectRoutersOptions) SetLocationName 

func (_options *ListOfferingTypeLocationCrossConnectRoutersOptions) SetLocationName(locationName string) *ListOfferingTypeLocationCrossConnectRoutersOptions

SetLocationName : Allow user to set LocationName

func (*ListOfferingTypeLocationCrossConnectRoutersOptions) SetOfferingType 

func (_options *ListOfferingTypeLocationCrossConnectRoutersOptions) SetOfferingType(offeringType string) *ListOfferingTypeLocationCrossConnectRoutersOptions

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 

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

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 

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

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 : OfferingSpeedCollection struct

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 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 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 UpdateGatewayOptions 

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

	// The identity of the standard key to use for BGP MD5 authentication key.
	// The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in
	// length.
	// To clear the optional `authentication_key` field patch its crn to `""`.
	AuthenticationKey *GatewayPatchTemplateAuthenticationKey `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"`

	// 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"`

	// MACsec configuration information.  When patching any macsec_config fields, no other fields may be specified in the
	// patch request.  Contact IBM support for access to MACsec.
	//
	// A MACsec config cannot be added to a gateway created without MACsec.
	MacsecConfig *GatewayMacsecConfigPatchTemplate `json:"macsec_config,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"`

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

UpdateGatewayOptions : The UpdateGateway options.

func (*UpdateGatewayOptions) SetAuthenticationKey added in v0.18.0 

func (_options *UpdateGatewayOptions) SetAuthenticationKey(authenticationKey *GatewayPatchTemplateAuthenticationKey) *UpdateGatewayOptions

SetAuthenticationKey : Allow user to set AuthenticationKey

func (*UpdateGatewayOptions) SetBfdConfig added in v0.23.0 

func (_options *UpdateGatewayOptions) SetBfdConfig(bfdConfig *GatewayBfdPatchTemplate) *UpdateGatewayOptions

SetBfdConfig : Allow user to set BfdConfig

func (*UpdateGatewayOptions) SetBgpAsn added in v0.23.0 

func (_options *UpdateGatewayOptions) SetBgpAsn(bgpAsn int64) *UpdateGatewayOptions

SetBgpAsn : Allow user to set BgpAsn

func (*UpdateGatewayOptions) SetBgpCerCidr added in v0.23.0 

func (_options *UpdateGatewayOptions) SetBgpCerCidr(bgpCerCidr string) *UpdateGatewayOptions

SetBgpCerCidr : Allow user to set BgpCerCidr

func (*UpdateGatewayOptions) SetBgpIbmCidr added in v0.23.0 

func (_options *UpdateGatewayOptions) SetBgpIbmCidr(bgpIbmCidr string) *UpdateGatewayOptions

SetBgpIbmCidr : Allow user to set BgpIbmCidr

func (*UpdateGatewayOptions) SetConnectionMode added in v0.20.0 

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

SetConnectionMode : Allow user to set ConnectionMode

func (*UpdateGatewayOptions) SetGlobal 

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

SetGlobal : Allow user to set Global

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

func (*UpdateGatewayOptions) SetLoaRejectReason 

func (_options *UpdateGatewayOptions) SetLoaRejectReason(loaRejectReason string) *UpdateGatewayOptions

SetLoaRejectReason : Allow user to set LoaRejectReason

func (*UpdateGatewayOptions) SetMacsecConfig added in v0.11.0 

func (_options *UpdateGatewayOptions) SetMacsecConfig(macsecConfig *GatewayMacsecConfigPatchTemplate) *UpdateGatewayOptions

SetMacsecConfig : Allow user to set MacsecConfig

func (*UpdateGatewayOptions) SetMetered 

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

SetMetered : Allow user to set Metered

func (*UpdateGatewayOptions) SetName 

func (_options *UpdateGatewayOptions) SetName(name string) *UpdateGatewayOptions

SetName : Allow user to set Name

func (*UpdateGatewayOptions) SetOperationalStatus 

func (_options *UpdateGatewayOptions) SetOperationalStatus(operationalStatus string) *UpdateGatewayOptions

SetOperationalStatus : Allow user to set OperationalStatus

func (*UpdateGatewayOptions) SetPatchPanelCompletionNotice added in v0.23.0 

func (_options *UpdateGatewayOptions) SetPatchPanelCompletionNotice(patchPanelCompletionNotice string) *UpdateGatewayOptions

SetPatchPanelCompletionNotice : Allow user to set PatchPanelCompletionNotice

func (*UpdateGatewayOptions) SetSpeedMbps 

func (_options *UpdateGatewayOptions) SetSpeedMbps(speedMbps int64) *UpdateGatewayOptions

SetSpeedMbps : Allow user to set SpeedMbps

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 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"`

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

UpdateGatewayVirtualConnectionOptions : The UpdateGatewayVirtualConnection options.

func (*UpdateGatewayVirtualConnectionOptions) SetGatewayID 

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

SetGatewayID : Allow user to set GatewayID

func (*UpdateGatewayVirtualConnectionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateGatewayVirtualConnectionOptions) SetID 

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

SetID : Allow user to set ID

func (*UpdateGatewayVirtualConnectionOptions) SetName 

func (_options *UpdateGatewayVirtualConnectionOptions) SetName(name string) *UpdateGatewayVirtualConnectionOptions

SetName : Allow user to set Name

func (*UpdateGatewayVirtualConnectionOptions) SetStatus 

func (_options *UpdateGatewayVirtualConnectionOptions) SetStatus(status string) *UpdateGatewayVirtualConnectionOptions

SetStatus : Allow user to set Status

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.