Documentation
¶
Overview ¶
Package directlinkv1 : Operations and models for the DirectLinkV1 service
Index ¶
- Constants
- func UnmarshalCrossConnectRouter(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGateway(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayActionTemplateUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequest(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestGatewayClientGatewayCreate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestGatewayClientGatewayDelete(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestUpdatesItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayPort(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayPortIdentity(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayTemplate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayTemplateGatewayTypeConnectTemplate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayVirtualConnection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayVirtualConnectionCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLocationCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLocationCrossConnectRouterCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLocationOutput(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalOfferingSpeed(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalOfferingSpeedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPort(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPortCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPortsPaginatedCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPortsPaginatedCollectionNext(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalResourceGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalResourceGroupReference(m map[string]json.RawMessage, result interface{}) (err error)
- type CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetAction(action string) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetGlobal(global bool) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetHeaders(param map[string]string) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetID(id string) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetMetered(metered bool) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetResourceGroup(resourceGroup *ResourceGroupIdentity) *CreateGatewayActionOptions
- func (options *CreateGatewayActionOptions) SetUpdates(updates []GatewayActionTemplateUpdatesItemIntf) *CreateGatewayActionOptions
- type CreateGatewayCompletionNoticeOptions
- func (options *CreateGatewayCompletionNoticeOptions) SetHeaders(param map[string]string) *CreateGatewayCompletionNoticeOptions
- func (options *CreateGatewayCompletionNoticeOptions) SetID(id string) *CreateGatewayCompletionNoticeOptions
- func (options *CreateGatewayCompletionNoticeOptions) SetUpload(upload io.ReadCloser) *CreateGatewayCompletionNoticeOptions
- func (options *CreateGatewayCompletionNoticeOptions) SetUploadContentType(uploadContentType string) *CreateGatewayCompletionNoticeOptions
- type CreateGatewayOptions
- type CreateGatewayVirtualConnectionOptions
- func (options *CreateGatewayVirtualConnectionOptions) SetGatewayID(gatewayID string) *CreateGatewayVirtualConnectionOptions
- func (options *CreateGatewayVirtualConnectionOptions) SetHeaders(param map[string]string) *CreateGatewayVirtualConnectionOptions
- func (options *CreateGatewayVirtualConnectionOptions) SetName(name string) *CreateGatewayVirtualConnectionOptions
- func (options *CreateGatewayVirtualConnectionOptions) SetNetworkID(networkID string) *CreateGatewayVirtualConnectionOptions
- func (options *CreateGatewayVirtualConnectionOptions) SetType(typeVar string) *CreateGatewayVirtualConnectionOptions
- type CrossConnectRouter
- type DeleteGatewayOptions
- type DeleteGatewayVirtualConnectionOptions
- func (options *DeleteGatewayVirtualConnectionOptions) SetGatewayID(gatewayID string) *DeleteGatewayVirtualConnectionOptions
- func (options *DeleteGatewayVirtualConnectionOptions) SetHeaders(param map[string]string) *DeleteGatewayVirtualConnectionOptions
- func (options *DeleteGatewayVirtualConnectionOptions) SetID(id string) *DeleteGatewayVirtualConnectionOptions
- type DirectLinkV1
- func (directLink *DirectLinkV1) CreateGateway(createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) CreateGatewayAction(createGatewayActionOptions *CreateGatewayActionOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) CreateGatewayCompletionNotice(createGatewayCompletionNoticeOptions *CreateGatewayCompletionNoticeOptions) (response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) CreateGatewayVirtualConnection(createGatewayVirtualConnectionOptions *CreateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) DeleteGateway(deleteGatewayOptions *DeleteGatewayOptions) (response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) DeleteGatewayVirtualConnection(deleteGatewayVirtualConnectionOptions *DeleteGatewayVirtualConnectionOptions) (response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) GetGateway(getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) GetGatewayVirtualConnection(getGatewayVirtualConnectionOptions *GetGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) GetPort(getPortOptions *GetPortOptions) (result *Port, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListGatewayCompletionNotice(listGatewayCompletionNoticeOptions *ListGatewayCompletionNoticeOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListGatewayLetterOfAuthorization(...) (result io.ReadCloser, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListGatewayVirtualConnections(listGatewayVirtualConnectionsOptions *ListGatewayVirtualConnectionsOptions) (result *GatewayVirtualConnectionCollection, response *core.DetailedResponse, ...)
- func (directLink *DirectLinkV1) ListGateways(listGatewaysOptions *ListGatewaysOptions) (result *GatewayCollection, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListOfferingTypeLocationCrossConnectRouters(...) (result *LocationCrossConnectRouterCollection, response *core.DetailedResponse, ...)
- func (directLink *DirectLinkV1) ListOfferingTypeLocations(listOfferingTypeLocationsOptions *ListOfferingTypeLocationsOptions) (result *LocationCollection, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListOfferingTypeSpeeds(listOfferingTypeSpeedsOptions *ListOfferingTypeSpeedsOptions) (result *OfferingSpeedCollection, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) ListPorts(listPortsOptions *ListPortsOptions) (result *PortCollection, response *core.DetailedResponse, err error)
- func (*DirectLinkV1) NewCreateGatewayActionOptions(id string, action string) *CreateGatewayActionOptions
- func (*DirectLinkV1) NewCreateGatewayCompletionNoticeOptions(id string) *CreateGatewayCompletionNoticeOptions
- func (*DirectLinkV1) NewCreateGatewayOptions(gatewayTemplate GatewayTemplateIntf) *CreateGatewayOptions
- func (*DirectLinkV1) NewCreateGatewayVirtualConnectionOptions(gatewayID string, name string, typeVar string) *CreateGatewayVirtualConnectionOptions
- func (*DirectLinkV1) NewDeleteGatewayOptions(id string) *DeleteGatewayOptions
- func (*DirectLinkV1) NewDeleteGatewayVirtualConnectionOptions(gatewayID string, id string) *DeleteGatewayVirtualConnectionOptions
- func (*DirectLinkV1) NewGatewayPortIdentity(id string) (model *GatewayPortIdentity, err error)
- func (*DirectLinkV1) NewGatewayTemplateGatewayTypeConnectTemplate(bgpAsn int64, bgpBaseCidr string, global bool, metered bool, name string, ...) (model *GatewayTemplateGatewayTypeConnectTemplate, err error)
- func (*DirectLinkV1) NewGatewayTemplateGatewayTypeDedicatedTemplate(bgpAsn int64, bgpBaseCidr string, global bool, metered bool, name string, ...) (model *GatewayTemplateGatewayTypeDedicatedTemplate, err error)
- func (*DirectLinkV1) NewGetGatewayOptions(id string) *GetGatewayOptions
- func (*DirectLinkV1) NewGetGatewayVirtualConnectionOptions(gatewayID string, id string) *GetGatewayVirtualConnectionOptions
- func (*DirectLinkV1) NewGetPortOptions(id string) *GetPortOptions
- func (*DirectLinkV1) NewListGatewayCompletionNoticeOptions(id string) *ListGatewayCompletionNoticeOptions
- func (*DirectLinkV1) NewListGatewayLetterOfAuthorizationOptions(id string) *ListGatewayLetterOfAuthorizationOptions
- func (*DirectLinkV1) NewListGatewayVirtualConnectionsOptions(gatewayID string) *ListGatewayVirtualConnectionsOptions
- func (*DirectLinkV1) NewListGatewaysOptions() *ListGatewaysOptions
- func (*DirectLinkV1) NewListOfferingTypeLocationCrossConnectRoutersOptions(offeringType string, locationName string) *ListOfferingTypeLocationCrossConnectRoutersOptions
- func (*DirectLinkV1) NewListOfferingTypeLocationsOptions(offeringType string) *ListOfferingTypeLocationsOptions
- func (*DirectLinkV1) NewListOfferingTypeSpeedsOptions(offeringType string) *ListOfferingTypeSpeedsOptions
- func (*DirectLinkV1) NewListPortsOptions() *ListPortsOptions
- func (*DirectLinkV1) NewResourceGroupIdentity(id string) (model *ResourceGroupIdentity, err error)
- func (*DirectLinkV1) NewUpdateGatewayOptions(id string) *UpdateGatewayOptions
- func (*DirectLinkV1) NewUpdateGatewayVirtualConnectionOptions(gatewayID string, id string) *UpdateGatewayVirtualConnectionOptions
- func (directLink *DirectLinkV1) SetServiceURL(url string) error
- func (directLink *DirectLinkV1) UpdateGateway(updateGatewayOptions *UpdateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (directLink *DirectLinkV1) UpdateGatewayVirtualConnection(updateGatewayVirtualConnectionOptions *UpdateGatewayVirtualConnectionOptions) (result *GatewayVirtualConnection, response *core.DetailedResponse, err error)
- type DirectLinkV1Options
- type Gateway
- type GatewayActionTemplateUpdatesItem
- type GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate
- type GatewayActionTemplateUpdatesItemIntf
- type GatewayChangeRequest
- type GatewayChangeRequestGatewayClientGatewayCreate
- type GatewayChangeRequestGatewayClientGatewayDelete
- type GatewayChangeRequestGatewayClientGatewayUpdateAttributes
- type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem
- type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate
- type GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemIntf
- type GatewayChangeRequestIntf
- type GatewayChangeRequestUpdatesItem
- type GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate
- type GatewayChangeRequestUpdatesItemIntf
- type GatewayCollection
- type GatewayPort
- type GatewayPortIdentity
- type GatewayTemplate
- type GatewayTemplateGatewayTypeConnectTemplate
- type GatewayTemplateGatewayTypeDedicatedTemplate
- type GatewayTemplateIntf
- type GatewayVirtualConnection
- type GatewayVirtualConnectionCollection
- type GetGatewayOptions
- type GetGatewayVirtualConnectionOptions
- func (options *GetGatewayVirtualConnectionOptions) SetGatewayID(gatewayID string) *GetGatewayVirtualConnectionOptions
- func (options *GetGatewayVirtualConnectionOptions) SetHeaders(param map[string]string) *GetGatewayVirtualConnectionOptions
- func (options *GetGatewayVirtualConnectionOptions) SetID(id string) *GetGatewayVirtualConnectionOptions
- type GetPortOptions
- type ListGatewayCompletionNoticeOptions
- type ListGatewayLetterOfAuthorizationOptions
- type ListGatewayVirtualConnectionsOptions
- type ListGatewaysOptions
- type ListOfferingTypeLocationCrossConnectRoutersOptions
- func (options *ListOfferingTypeLocationCrossConnectRoutersOptions) SetHeaders(param map[string]string) *ListOfferingTypeLocationCrossConnectRoutersOptions
- func (options *ListOfferingTypeLocationCrossConnectRoutersOptions) SetLocationName(locationName string) *ListOfferingTypeLocationCrossConnectRoutersOptions
- func (options *ListOfferingTypeLocationCrossConnectRoutersOptions) SetOfferingType(offeringType string) *ListOfferingTypeLocationCrossConnectRoutersOptions
- type ListOfferingTypeLocationsOptions
- type ListOfferingTypeSpeedsOptions
- type ListPortsOptions
- func (options *ListPortsOptions) SetHeaders(param map[string]string) *ListPortsOptions
- func (options *ListPortsOptions) SetLimit(limit int64) *ListPortsOptions
- func (options *ListPortsOptions) SetLocationName(locationName string) *ListPortsOptions
- func (options *ListPortsOptions) SetStart(start string) *ListPortsOptions
- type LocationCollection
- type LocationCrossConnectRouterCollection
- type LocationOutput
- type OfferingSpeed
- type OfferingSpeedCollection
- type Port
- type PortCollection
- type PortsPaginatedCollectionFirst
- type PortsPaginatedCollectionNext
- type ResourceGroupIdentity
- type ResourceGroupReference
- type UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetGlobal(global bool) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetHeaders(param map[string]string) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetID(id string) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetLoaRejectReason(loaRejectReason string) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetMetered(metered bool) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetName(name string) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetOperationalStatus(operationalStatus string) *UpdateGatewayOptions
- func (options *UpdateGatewayOptions) SetSpeedMbps(speedMbps int64) *UpdateGatewayOptions
- type UpdateGatewayVirtualConnectionOptions
- func (options *UpdateGatewayVirtualConnectionOptions) SetGatewayID(gatewayID string) *UpdateGatewayVirtualConnectionOptions
- func (options *UpdateGatewayVirtualConnectionOptions) SetHeaders(param map[string]string) *UpdateGatewayVirtualConnectionOptions
- func (options *UpdateGatewayVirtualConnectionOptions) SetID(id string) *UpdateGatewayVirtualConnectionOptions
- func (options *UpdateGatewayVirtualConnectionOptions) SetName(name string) *UpdateGatewayVirtualConnectionOptions
- func (options *UpdateGatewayVirtualConnectionOptions) SetStatus(status string) *UpdateGatewayVirtualConnectionOptions
Constants ¶
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.
const ( CreateGatewayVirtualConnectionOptions_Type_Classic = "classic" CreateGatewayVirtualConnectionOptions_Type_Vpc = "vpc" )
Constants associated with the CreateGatewayVirtualConnectionOptions.Type property. The type of virtual connection.
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.
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.
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_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.
const ( Gateway_Type_Connect = "connect" Gateway_Type_Dedicated = "dedicated" )
Constants associated with the Gateway.Type property. Gateway type.
The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
const ( GatewayTemplate_Type_Connect = "connect" GatewayTemplate_Type_Dedicated = "dedicated" )
Constants associated with the GatewayTemplate.Type property. Gateway type.
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.
const ( GatewayVirtualConnection_Type_Classic = "classic" 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.
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"`.
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"`.
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.
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.
const ( GatewayTemplateGatewayTypeConnectTemplate_Type_Connect = "connect" GatewayTemplateGatewayTypeConnectTemplate_Type_Dedicated = "dedicated" )
Constants associated with the GatewayTemplateGatewayTypeConnectTemplate.Type property. Gateway type.
const ( GatewayTemplateGatewayTypeDedicatedTemplate_Type_Connect = "connect" GatewayTemplateGatewayTypeDedicatedTemplate_Type_Dedicated = "dedicated" )
Constants associated with the GatewayTemplateGatewayTypeDedicatedTemplate.Type property. Gateway type.
const DefaultServiceName = "direct_link"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://directlink.cloud.ibm.com/v1"
DefaultServiceURL is the default URL to make service requests to.
const (
GatewayChangeRequestGatewayClientGatewayCreate_Type_CreateGateway = "create_gateway"
)
Constants associated with the GatewayChangeRequestGatewayClientGatewayCreate.Type property. type of gateway change request.
const (
GatewayChangeRequestGatewayClientGatewayDelete_Type_DeleteGateway = "delete_gateway"
)
Constants associated with the GatewayChangeRequestGatewayClientGatewayDelete.Type property. type of gateway change request.
const (
GatewayChangeRequestGatewayClientGatewayUpdateAttributes_Type_UpdateAttributes = "update_attributes"
)
Constants associated with the GatewayChangeRequestGatewayClientGatewayUpdateAttributes.Type property. type of gateway change request.
const (
GatewayChangeRequest_Type_CreateGateway = "create_gateway"
)
Constants associated with the GatewayChangeRequest.Type property. type of gateway change request.
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 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 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 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 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 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 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 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 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 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 UnmarshalGatewayTemplate ¶
func UnmarshalGatewayTemplate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGatewayTemplate unmarshals an instance of GatewayTemplate from the specified map of raw messages.
func UnmarshalGatewayTemplateGatewayTypeConnectTemplate ¶
func UnmarshalGatewayTemplateGatewayTypeConnectTemplate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGatewayTemplateGatewayTypeConnectTemplate unmarshals an instance of GatewayTemplateGatewayTypeConnectTemplate from the specified map of raw messages.
func UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate ¶
func UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGatewayTemplateGatewayTypeDedicatedTemplate unmarshals an instance of GatewayTemplateGatewayTypeDedicatedTemplate from the specified map of raw messages.
func 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"` // Action request. Action *string `json:"action" validate:"required"` // Required 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"` // Required 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) 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"` // 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"` // 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 { // 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"` // 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"` // The virtual connection identifier. ID *string `json:"id" validate:"required"` // 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)
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) 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) 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) 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) 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) GetGateway ¶
func (directLink *DirectLinkV1) GetGateway(getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
GetGateway : Get gateway Retrieve a Direct Link gateway.
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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) NewGatewayPortIdentity ¶
func (*DirectLinkV1) NewGatewayPortIdentity(id string) (model *GatewayPortIdentity, err error)
NewGatewayPortIdentity : Instantiate GatewayPortIdentity (Generic Model Constructor)
func (*DirectLinkV1) NewGatewayTemplateGatewayTypeConnectTemplate ¶
func (*DirectLinkV1) NewGatewayTemplateGatewayTypeConnectTemplate(bgpAsn int64, bgpBaseCidr string, 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, bgpBaseCidr string, 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) 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) 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.
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 { // Customer BGP ASN. BgpAsn *int64 `json:"bgp_asn" validate:"required"` // BGP base CIDR. 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"` // 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"` // 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"` // 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"` // Gateway location long name. LocationDisplayName *string `json:"location_display_name" validate:"required"` // Gateway location. LocationName *string `json:"location_name" 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 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 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"` // Gateway 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 GatewayActionTemplateUpdatesItem ¶
type GatewayActionTemplateUpdatesItem struct { // New gateway speed in megabits per second. SpeedMbps *int64 `json:"speed_mbps,omitempty"` }
GatewayActionTemplateUpdatesItem : GatewayActionTemplateUpdatesItem struct Models which "extend" this model: - GatewayActionTemplateUpdatesItemGatewayClientSpeedUpdate
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 GatewayActionTemplateUpdatesItemIntf ¶
type GatewayActionTemplateUpdatesItemIntf interface {
// contains filtered or unexported methods
}
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"` }
GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem : GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItem struct Models which "extend" this model: - GatewayChangeRequestGatewayClientGatewayUpdateAttributesUpdatesItemGatewayClientSpeedUpdate
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 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"` }
GatewayChangeRequestUpdatesItem : GatewayChangeRequestUpdatesItem struct Models which "extend" this model: - GatewayChangeRequestUpdatesItemGatewayClientSpeedUpdate
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 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 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 GatewayTemplate ¶
type GatewayTemplate struct { // BGP ASN. BgpAsn *int64 `json:"bgp_asn" validate:"required"` // BGP base CIDR. BgpBaseCidr *string `json:"bgp_base_cidr" validate:"required"` // BGP customer edge router CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this // field can be ommitted and a CIDR will be selected automatically. BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"` // BGP IBM CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this field can be // ommitted and a CIDR will be selected automatically. BgpIbmCidr *string `json:"bgp_ibm_cidr,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"` // 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"` // Gateway 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"` // Select Port Label for new type=connect gateway. Port *GatewayPortIdentity `json:"port,omitempty"` }
GatewayTemplate : Create gateway template. Models which "extend" this model: - GatewayTemplateGatewayTypeDedicatedTemplate - GatewayTemplateGatewayTypeConnectTemplate
type GatewayTemplateGatewayTypeConnectTemplate ¶
type GatewayTemplateGatewayTypeConnectTemplate struct { // BGP ASN. BgpAsn *int64 `json:"bgp_asn" validate:"required"` // BGP base CIDR. BgpBaseCidr *string `json:"bgp_base_cidr" validate:"required"` // BGP customer edge router CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this // field can be ommitted and a CIDR will be selected automatically. BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"` // BGP IBM CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this field can be // ommitted and a CIDR will be selected automatically. BgpIbmCidr *string `json:"bgp_ibm_cidr,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"` // 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"` // Gateway 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 { // BGP ASN. BgpAsn *int64 `json:"bgp_asn" validate:"required"` // BGP base CIDR. BgpBaseCidr *string `json:"bgp_base_cidr" validate:"required"` // BGP customer edge router CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this // field can be ommitted and a CIDR will be selected automatically. BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"` // BGP IBM CIDR. Specify a value within `bgp_base_cidr`. If `bgp_base_cidr` is 169.254.0.0/16 this field can be // ommitted and a CIDR will be selected automatically. BgpIbmCidr *string `json:"bgp_ibm_cidr,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"` // 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"` // Gateway 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"` }
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"` // 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 GetGatewayVirtualConnectionOptions ¶
type GetGatewayVirtualConnectionOptions struct { // Direct Link gateway identifier. GatewayID *string `json:"gateway_id" validate:"required"` // The virtual connection identifier. ID *string `json:"id" validate:"required"` // 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"` // 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"` // 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"` // 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"` // 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"` // The name of the Direct Link location. LocationName *string `json:"location_name" validate:"required"` // 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"` // 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"` // 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"` // 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 { // Link speed in megabits per second. LinkSpeed *int64 `json:"link_speed" validate:"required"` }
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.
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"` // Gateways with global routing (`true`) can connect to networks outside of their associated region. Global *bool `json:"global,omitempty"` // Use this field during LOA rejection to provide the reason for the rejection. // // Only allowed for type=dedicated gateways. LoaRejectReason *string `json:"loa_reject_reason,omitempty"` // Metered billing option. When `true` gateway usage is billed per gigabyte. When `false` there is no per gigabyte // usage charge, instead a flat rate is charged for the gateway. Metered *bool `json:"metered,omitempty"` // The unique user-defined name for this gateway. Name *string `json:"name,omitempty"` // Gateway operational status. // // For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. // When rejecting an LOA, provide reject reasoning in `loa_reject_reason`. // // Only allowed for type=dedicated gateways. OperationalStatus *string `json:"operational_status,omitempty"` // Gateway 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) 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) 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) 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"` // The virtual connection identifier. 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,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