directlinkproviderv2

package
v0.30.0 Latest Latest
Warning

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

 Go to latest Published: May 10, 2022 License: Apache-2.0 Imports: 9 Imported by: 5

Documentation

Overview

Package directlinkproviderv2 : Operations and models for the DirectLinkProviderV2 service

Index

Constants

View Source 
const (
	ProviderGateway_BgpStatus_Active      = "active"
	ProviderGateway_BgpStatus_Connect     = "connect"
	ProviderGateway_BgpStatus_Established = "established"
	ProviderGateway_BgpStatus_Idle        = "idle"
)

Constants associated with the ProviderGateway.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 (
	ProviderGateway_OperationalStatus_Configuring    = "configuring"
	ProviderGateway_OperationalStatus_CreatePending  = "create_pending"
	ProviderGateway_OperationalStatus_CreateRejected = "create_rejected"
	ProviderGateway_OperationalStatus_DeletePending  = "delete_pending"
	ProviderGateway_OperationalStatus_Provisioned    = "provisioned"
)

Constants associated with the ProviderGateway.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 DefaultServiceName = "direct_link_provider"

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

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

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	ProviderGatewayChangeRequestProviderGatewayCreate_Type_CreateGateway = "create_gateway"
)

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

View Source 
const (
	ProviderGatewayChangeRequestProviderGatewayDelete_Type_DeleteGateway = "delete_gateway"
)

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

View Source 
const (
	ProviderGatewayChangeRequestProviderGatewayUpdateAttributes_Type_UpdateAttributes = "update_attributes"
)

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

View Source 
const (
	ProviderGatewayChangeRequest_Type_CreateGateway = "create_gateway"
)

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

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.23.0 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalProviderGateway 

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

UnmarshalProviderGateway unmarshals an instance of ProviderGateway from the specified map of raw messages.

func UnmarshalProviderGatewayChangeRequest 

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

UnmarshalProviderGatewayChangeRequest unmarshals an instance of ProviderGatewayChangeRequest from the specified map of raw messages.

func UnmarshalProviderGatewayChangeRequestProviderGatewayCreate 

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

UnmarshalProviderGatewayChangeRequestProviderGatewayCreate unmarshals an instance of ProviderGatewayChangeRequestProviderGatewayCreate from the specified map of raw messages.

func UnmarshalProviderGatewayChangeRequestProviderGatewayDelete 

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

UnmarshalProviderGatewayChangeRequestProviderGatewayDelete unmarshals an instance of ProviderGatewayChangeRequestProviderGatewayDelete from the specified map of raw messages.

func UnmarshalProviderGatewayChangeRequestProviderGatewayUpdateAttributes 

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

UnmarshalProviderGatewayChangeRequestProviderGatewayUpdateAttributes unmarshals an instance of ProviderGatewayChangeRequestProviderGatewayUpdateAttributes from the specified map of raw messages.

func UnmarshalProviderGatewayCollection 

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

UnmarshalProviderGatewayCollection unmarshals an instance of ProviderGatewayCollection from the specified map of raw messages.

func UnmarshalProviderGatewayCollectionFirst 

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

UnmarshalProviderGatewayCollectionFirst unmarshals an instance of ProviderGatewayCollectionFirst from the specified map of raw messages.

func UnmarshalProviderGatewayCollectionNext 

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

UnmarshalProviderGatewayCollectionNext unmarshals an instance of ProviderGatewayCollectionNext from the specified map of raw messages.

func UnmarshalProviderGatewayPortIdentity 

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

UnmarshalProviderGatewayPortIdentity unmarshals an instance of ProviderGatewayPortIdentity from the specified map of raw messages.

func UnmarshalProviderGatewayPortReference 

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

UnmarshalProviderGatewayPortReference unmarshals an instance of ProviderGatewayPortReference from the specified map of raw messages.

func UnmarshalProviderGatewayUpdateAttributesUpdatesItem 

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

UnmarshalProviderGatewayUpdateAttributesUpdatesItem unmarshals an instance of ProviderGatewayUpdateAttributesUpdatesItem from the specified map of raw messages.

func UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate added in v0.23.0 

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

UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate unmarshals an instance of ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate from the specified map of raw messages.

func UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate added in v0.23.0 

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

UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate unmarshals an instance of ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate from the specified map of raw messages.

func UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate 

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

UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate unmarshals an instance of ProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate from the specified map of raw messages.

func UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN added in v0.26.0 

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

UnmarshalProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN unmarshals an instance of ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN from the specified map of raw messages.

func UnmarshalProviderPort 

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

UnmarshalProviderPort unmarshals an instance of ProviderPort from the specified map of raw messages.

func UnmarshalProviderPortCollection 

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

UnmarshalProviderPortCollection unmarshals an instance of ProviderPortCollection from the specified map of raw messages.

func UnmarshalProviderPortCollectionFirst 

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

UnmarshalProviderPortCollectionFirst unmarshals an instance of ProviderPortCollectionFirst from the specified map of raw messages.

func UnmarshalProviderPortCollectionNext 

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

UnmarshalProviderPortCollectionNext unmarshals an instance of ProviderPortCollectionNext from the specified map of raw messages.

Types

type CreateProviderGatewayOptions 

type CreateProviderGatewayOptions struct {
	// BGP ASN.
	//
	// For a 2-byte range, enter a value between 1-64495 or 64999. For a 2-byte or 4-byte range, enter a value between
	// 131072-4199999999. For a 4-byte range, enter a value between 4201000000-4201064511.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// Customer IBM Cloud account ID for the new gateway.  A gateway object containing the pending create request will
	// become available in the specified account.
	CustomerAccountID *string `json:"customer_account_id" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Select Port Label for the gateway.
	Port *ProviderGatewayPortIdentity `json:"port" validate:"required"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

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

	// VLAN requested for this gateway.
	//
	// VLAN provided should be in the range 1 to 4094.
	Vlan *int64 `json:"vlan,omitempty"`

	// When true, perform request validation only and do not create a gateway.
	CheckOnly *string `json:"check_only,omitempty"`

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

CreateProviderGatewayOptions : The CreateProviderGateway options.

func (*CreateProviderGatewayOptions) SetBgpAsn 

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

SetBgpAsn : Allow user to set BgpAsn

func (*CreateProviderGatewayOptions) SetBgpCerCidr 

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

SetBgpCerCidr : Allow user to set BgpCerCidr

func (*CreateProviderGatewayOptions) SetBgpIbmCidr 

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

SetBgpIbmCidr : Allow user to set BgpIbmCidr

func (*CreateProviderGatewayOptions) SetCheckOnly 

func (_options *CreateProviderGatewayOptions) SetCheckOnly(checkOnly string) *CreateProviderGatewayOptions

SetCheckOnly : Allow user to set CheckOnly

func (*CreateProviderGatewayOptions) SetCustomerAccountID 

func (_options *CreateProviderGatewayOptions) SetCustomerAccountID(customerAccountID string) *CreateProviderGatewayOptions

SetCustomerAccountID : Allow user to set CustomerAccountID

func (*CreateProviderGatewayOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateProviderGatewayOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateProviderGatewayOptions) SetPort 

func (_options *CreateProviderGatewayOptions) SetPort(port *ProviderGatewayPortIdentity) *CreateProviderGatewayOptions

SetPort : Allow user to set Port

func (*CreateProviderGatewayOptions) SetSpeedMbps 

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

SetSpeedMbps : Allow user to set SpeedMbps

func (*CreateProviderGatewayOptions) SetVlan added in v0.26.0 

func (_options *CreateProviderGatewayOptions) SetVlan(vlan int64) *CreateProviderGatewayOptions

SetVlan : Allow user to set Vlan

type DeleteProviderGatewayOptions 

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

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

DeleteProviderGatewayOptions : The DeleteProviderGateway options.

func (*DeleteProviderGatewayOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteProviderGatewayOptions) SetID 

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

SetID : Allow user to set ID

type DirectLinkProviderV2 

type DirectLinkProviderV2 struct {
	Service *core.BaseService

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

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

API Version: __VERSION__

func NewDirectLinkProviderV2 

func NewDirectLinkProviderV2(options *DirectLinkProviderV2Options) (service *DirectLinkProviderV2, err error)

NewDirectLinkProviderV2 : constructs an instance of DirectLinkProviderV2 with passed in options.

func NewDirectLinkProviderV2UsingExternalConfig 

func NewDirectLinkProviderV2UsingExternalConfig(options *DirectLinkProviderV2Options) (directLinkProvider *DirectLinkProviderV2, err error)

NewDirectLinkProviderV2UsingExternalConfig : constructs an instance of DirectLinkProviderV2 with passed in options and external configuration.

func (*DirectLinkProviderV2) Clone added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) Clone() *DirectLinkProviderV2

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

func (*DirectLinkProviderV2) CreateProviderGateway 

func (directLinkProvider *DirectLinkProviderV2) CreateProviderGateway(createProviderGatewayOptions *CreateProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

CreateProviderGateway : Create gateway Create a Direct Link Connect gateway based on the supplied template in the specified customer account.

The gateway will be 'provider_api_managed=true'.

func (*DirectLinkProviderV2) CreateProviderGatewayWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) CreateProviderGatewayWithContext(ctx context.Context, createProviderGatewayOptions *CreateProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

CreateProviderGatewayWithContext is an alternate form of the CreateProviderGateway method which supports a Context parameter

func (*DirectLinkProviderV2) DeleteProviderGateway 

func (directLinkProvider *DirectLinkProviderV2) DeleteProviderGateway(deleteProviderGatewayOptions *DeleteProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

DeleteProviderGateway : Delete gateway Delete a Direct Link Connect provider managed gateway.

func (*DirectLinkProviderV2) DeleteProviderGatewayWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) DeleteProviderGatewayWithContext(ctx context.Context, deleteProviderGatewayOptions *DeleteProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

DeleteProviderGatewayWithContext is an alternate form of the DeleteProviderGateway method which supports a Context parameter

func (*DirectLinkProviderV2) DisableRetries added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) DisableRetries()

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

func (*DirectLinkProviderV2) EnableRetries added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) 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 (*DirectLinkProviderV2) GetEnableGzipCompression added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*DirectLinkProviderV2) GetProviderGateway 

func (directLinkProvider *DirectLinkProviderV2) GetProviderGateway(getProviderGatewayOptions *GetProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

GetProviderGateway : Get gateway Get a Direct Link Connect gateway. 

Gateways with either `provider_api_managed=true` or `provider_api_managed=false` can be retrieved.

func (*DirectLinkProviderV2) GetProviderGatewayWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) GetProviderGatewayWithContext(ctx context.Context, getProviderGatewayOptions *GetProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

GetProviderGatewayWithContext is an alternate form of the GetProviderGateway method which supports a Context parameter

func (*DirectLinkProviderV2) GetProviderPort 

func (directLinkProvider *DirectLinkProviderV2) GetProviderPort(getProviderPortOptions *GetProviderPortOptions) (result *ProviderPort, response *core.DetailedResponse, err error)

GetProviderPort : Get port Get provider port information.

func (*DirectLinkProviderV2) GetProviderPortWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) GetProviderPortWithContext(ctx context.Context, getProviderPortOptions *GetProviderPortOptions) (result *ProviderPort, response *core.DetailedResponse, err error)

GetProviderPortWithContext is an alternate form of the GetProviderPort method which supports a Context parameter

func (*DirectLinkProviderV2) GetServiceURL added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*DirectLinkProviderV2) ListProviderGateways 

func (directLinkProvider *DirectLinkProviderV2) ListProviderGateways(listProviderGatewaysOptions *ListProviderGatewaysOptions) (result *ProviderGatewayCollection, response *core.DetailedResponse, err error)

ListProviderGateways : List gateways List all Direct Link Connect gateways created by this provider.

func (*DirectLinkProviderV2) ListProviderGatewaysWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) ListProviderGatewaysWithContext(ctx context.Context, listProviderGatewaysOptions *ListProviderGatewaysOptions) (result *ProviderGatewayCollection, response *core.DetailedResponse, err error)

ListProviderGatewaysWithContext is an alternate form of the ListProviderGateways method which supports a Context parameter

func (*DirectLinkProviderV2) ListProviderPorts 

func (directLinkProvider *DirectLinkProviderV2) ListProviderPorts(listProviderPortsOptions *ListProviderPortsOptions) (result *ProviderPortCollection, response *core.DetailedResponse, err error)

ListProviderPorts : List ports List all provider ports (associated with the caller).

func (*DirectLinkProviderV2) ListProviderPortsWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) ListProviderPortsWithContext(ctx context.Context, listProviderPortsOptions *ListProviderPortsOptions) (result *ProviderPortCollection, response *core.DetailedResponse, err error)

ListProviderPortsWithContext is an alternate form of the ListProviderPorts method which supports a Context parameter

func (*DirectLinkProviderV2) NewCreateProviderGatewayOptions 

func (*DirectLinkProviderV2) NewCreateProviderGatewayOptions(bgpAsn int64, customerAccountID string, name string, port *ProviderGatewayPortIdentity, speedMbps int64) *CreateProviderGatewayOptions

NewCreateProviderGatewayOptions : Instantiate CreateProviderGatewayOptions

func (*DirectLinkProviderV2) NewDeleteProviderGatewayOptions 

func (*DirectLinkProviderV2) NewDeleteProviderGatewayOptions(id string) *DeleteProviderGatewayOptions

NewDeleteProviderGatewayOptions : Instantiate DeleteProviderGatewayOptions

func (*DirectLinkProviderV2) NewGetProviderGatewayOptions 

func (*DirectLinkProviderV2) NewGetProviderGatewayOptions(id string) *GetProviderGatewayOptions

NewGetProviderGatewayOptions : Instantiate GetProviderGatewayOptions

func (*DirectLinkProviderV2) NewGetProviderPortOptions 

func (*DirectLinkProviderV2) NewGetProviderPortOptions(id string) *GetProviderPortOptions

NewGetProviderPortOptions : Instantiate GetProviderPortOptions

func (*DirectLinkProviderV2) NewListProviderGatewaysOptions 

func (*DirectLinkProviderV2) NewListProviderGatewaysOptions() *ListProviderGatewaysOptions

NewListProviderGatewaysOptions : Instantiate ListProviderGatewaysOptions

func (*DirectLinkProviderV2) NewListProviderPortsOptions 

func (*DirectLinkProviderV2) NewListProviderPortsOptions() *ListProviderPortsOptions

NewListProviderPortsOptions : Instantiate ListProviderPortsOptions

func (*DirectLinkProviderV2) NewProviderGatewayPortIdentity 

func (*DirectLinkProviderV2) NewProviderGatewayPortIdentity(id string) (_model *ProviderGatewayPortIdentity, err error)

NewProviderGatewayPortIdentity : Instantiate ProviderGatewayPortIdentity (Generic Model Constructor)

func (*DirectLinkProviderV2) NewUpdateProviderGatewayOptions 

func (*DirectLinkProviderV2) NewUpdateProviderGatewayOptions(id string) *UpdateProviderGatewayOptions

NewUpdateProviderGatewayOptions : Instantiate UpdateProviderGatewayOptions

func (*DirectLinkProviderV2) SetDefaultHeaders added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*DirectLinkProviderV2) SetEnableGzipCompression added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*DirectLinkProviderV2) SetServiceURL 

func (directLinkProvider *DirectLinkProviderV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DirectLinkProviderV2) UpdateProviderGateway 

func (directLinkProvider *DirectLinkProviderV2) UpdateProviderGateway(updateProviderGatewayOptions *UpdateProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

UpdateProviderGateway : Update gateway Update a Direct Link Connect provider managed gateway.

Name changes are applied immediately, other changes result in a gateway change_request and require approval from the client.

func (*DirectLinkProviderV2) UpdateProviderGatewayWithContext added in v0.23.0 

func (directLinkProvider *DirectLinkProviderV2) UpdateProviderGatewayWithContext(ctx context.Context, updateProviderGatewayOptions *UpdateProviderGatewayOptions) (result *ProviderGateway, response *core.DetailedResponse, err error)

UpdateProviderGatewayWithContext is an alternate form of the UpdateProviderGateway method which supports a Context parameter

type DirectLinkProviderV2Options 

type DirectLinkProviderV2Options 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 2020-04-28 up to the current
	// date may be provided. Specify the current date to request the latest version.
	Version *string `validate:"required"`
}

DirectLinkProviderV2Options : Service options

type GetProviderGatewayOptions 

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

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

GetProviderGatewayOptions : The GetProviderGateway options.

func (*GetProviderGatewayOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetProviderGatewayOptions) SetID 

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

SetID : Allow user to set ID

type GetProviderPortOptions 

type GetProviderPortOptions struct {
	// port identifier.
	ID *string `json:"id" validate:"required,ne="`

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

GetProviderPortOptions : The GetProviderPort options.

func (*GetProviderPortOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetProviderPortOptions) SetID 

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

SetID : Allow user to set ID

type ListProviderGatewaysOptions 

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

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

ListProviderGatewaysOptions : The ListProviderGateways options.

func (*ListProviderGatewaysOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListProviderGatewaysOptions) SetLimit 

func (_options *ListProviderGatewaysOptions) SetLimit(limit int64) *ListProviderGatewaysOptions

SetLimit : Allow user to set Limit

func (*ListProviderGatewaysOptions) SetStart 

func (_options *ListProviderGatewaysOptions) SetStart(start string) *ListProviderGatewaysOptions

SetStart : Allow user to set Start

type ListProviderPortsOptions 

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

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

ListProviderPortsOptions : The ListProviderPorts options.

func (*ListProviderPortsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListProviderPortsOptions) SetLimit 

func (_options *ListProviderPortsOptions) SetLimit(limit int64) *ListProviderPortsOptions

SetLimit : Allow user to set Limit

func (*ListProviderPortsOptions) SetStart 

func (_options *ListProviderPortsOptions) SetStart(start string) *ListProviderPortsOptions

SetStart : Allow user to set Start

type ProviderGateway 

type ProviderGateway struct {
	// BGP ASN.
	//
	// For a 2-byte ASN values between 1-64495 or 64999. For a 2-byte or 4-byte range ASN values between 131072-4199999999.
	// For a 4-byte ASN values 4201000000-4201064511.
	BgpAsn *int64 `json:"bgp_asn" validate:"required"`

	// BGP customer edge router CIDR.
	BgpCerCidr *string `json:"bgp_cer_cidr,omitempty"`

	// IBM BGP ASN.
	BgpIbmAsn *int64 `json:"bgp_ibm_asn" validate:"required"`

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

	ChangeRequest ProviderGatewayChangeRequestIntf `json:"change_request,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,omitempty"`

	// Customer IBM Cloud account ID.
	CustomerAccountID *string `json:"customer_account_id" validate:"required"`

	// The unique identifier of this gateway.
	ID *string `json:"id" validate:"required"`

	// The unique user-defined name for this gateway.
	Name *string `json:"name" validate:"required"`

	// Gateway operational status.
	//
	// The list of enumerated values for this property may expand in the future. Code and processes using this field must
	// tolerate unexpected values.
	OperationalStatus *string `json:"operational_status" validate:"required"`

	// Port identifier for the gateway.
	Port *ProviderGatewayPortReference `json:"port" validate:"required"`

	// Set to `true` for gateways created through the Direct Link Provider APIs.
	//
	// Most Direct Link Provider APIs cannot interact with `provider_api_managed=false` gateways.
	ProviderApiManaged *bool `json:"provider_api_managed" validate:"required"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps" validate:"required"`

	// Gateway type.
	Type *string `json:"type" validate:"required"`

	// VLAN for this gateway.
	Vlan *int64 `json:"vlan,omitempty"`
}

ProviderGateway : gateway.

type ProviderGatewayChangeRequest 

type ProviderGatewayChangeRequest struct {
	// type of gateway change request.
	Type *string `json:"type,omitempty"`

	// array of pending updates.
	Updates []ProviderGatewayUpdateAttributesUpdatesItemIntf `json:"updates,omitempty"`
}

ProviderGatewayChangeRequest : ProviderGatewayChangeRequest struct Models which "extend" this model: - ProviderGatewayChangeRequestProviderGatewayCreate - ProviderGatewayChangeRequestProviderGatewayDelete - ProviderGatewayChangeRequestProviderGatewayUpdateAttributes

type ProviderGatewayChangeRequestIntf 

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

type ProviderGatewayChangeRequestProviderGatewayCreate 

type ProviderGatewayChangeRequestProviderGatewayCreate struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`
}

ProviderGatewayChangeRequestProviderGatewayCreate : gateway create. This model "extends" ProviderGatewayChangeRequest

type ProviderGatewayChangeRequestProviderGatewayDelete 

type ProviderGatewayChangeRequestProviderGatewayDelete struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`
}

ProviderGatewayChangeRequestProviderGatewayDelete : gateway delete. This model "extends" ProviderGatewayChangeRequest

type ProviderGatewayChangeRequestProviderGatewayUpdateAttributes 

type ProviderGatewayChangeRequestProviderGatewayUpdateAttributes struct {
	// type of gateway change request.
	Type *string `json:"type" validate:"required"`

	// array of pending updates.
	Updates []ProviderGatewayUpdateAttributesUpdatesItemIntf `json:"updates" validate:"required"`
}

ProviderGatewayChangeRequestProviderGatewayUpdateAttributes : gateway attributes update. This model "extends" ProviderGatewayChangeRequest

type ProviderGatewayCollection 

type ProviderGatewayCollection struct {
	// A reference to the first page of resources.
	First *ProviderGatewayCollectionFirst `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 *ProviderGatewayCollectionNext `json:"next,omitempty"`

	// The total number of resources across all pages.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Collection of Direct Link gateways.
	Gateways []ProviderGateway `json:"gateways" validate:"required"`
}

ProviderGatewayCollection : A paginated collection of resources.

func (*ProviderGatewayCollection) GetNextStart added in v0.26.0 

func (resp *ProviderGatewayCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ProviderGatewayCollectionFirst 

type ProviderGatewayCollectionFirst struct {
	// The URL for the first page of resources.
	Href *string `json:"href" validate:"required"`
}

ProviderGatewayCollectionFirst : A reference to the first page of resources.

type ProviderGatewayCollectionNext 

type ProviderGatewayCollectionNext struct {
	// The 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" validate:"required"`
}

ProviderGatewayCollectionNext : A reference to the next page of resources; this reference is included for all pages except the last page.

type ProviderGatewayPortIdentity 

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

ProviderGatewayPortIdentity : Select Port Label for the gateway.

type ProviderGatewayPortReference 

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

ProviderGatewayPortReference : Port identifier for the gateway.

type ProviderGatewayUpdateAttributesUpdatesItem 

type ProviderGatewayUpdateAttributesUpdatesItem 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 provided should be in the range 1 to 4094.
	Vlan *int64 `json:"vlan,omitempty"`
}

ProviderGatewayUpdateAttributesUpdatesItem : ProviderGatewayUpdateAttributesUpdatesItem struct Models which "extend" this model: - ProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate - ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate - ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate - ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN

type ProviderGatewayUpdateAttributesUpdatesItemIntf 

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

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate added in v0.23.0 

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate struct {
	// New gateway BGP ASN.
	BgpAsn *int64 `json:"bgp_asn,omitempty"`
}

ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPASNUpdate : The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0 gateway. This model "extends" ProviderGatewayUpdateAttributesUpdatesItem

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate added in v0.23.0 

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate 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"`
}

ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayBGPIPUpdate : Update BGP customer and IBM CIDR. This model "extends" ProviderGatewayUpdateAttributesUpdatesItem

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate 

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate struct {
	// New gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`
}

ProviderGatewayUpdateAttributesUpdatesItemProviderGatewaySpeedUpdate : gateway speed change. This model "extends" ProviderGatewayUpdateAttributesUpdatesItem

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN added in v0.26.0 

type ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN struct {
	// VLAN to be updated for this gateway.
	//
	// VLAN provided should be in the range 1 to 4094.
	Vlan *int64 `json:"vlan,omitempty"`
}

ProviderGatewayUpdateAttributesUpdatesItemProviderGatewayVLAN : Update VLAN for this gateway.

VLAN provided should be in the range 1 to 4094. This model "extends" ProviderGatewayUpdateAttributesUpdatesItem

type ProviderPort 

type ProviderPort struct {
	// 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 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"`
}

ProviderPort : Provider port details.

type ProviderPortCollection 

type ProviderPortCollection struct {
	// A reference to the first page of resources.
	First *ProviderPortCollectionFirst `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 *ProviderPortCollectionNext `json:"next,omitempty"`

	// The total number of resources across all pages.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Array of ports.
	Ports []ProviderPort `json:"ports,omitempty"`
}

ProviderPortCollection : List of port label details.

func (*ProviderPortCollection) GetNextStart added in v0.26.0 

func (resp *ProviderPortCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ProviderPortCollectionFirst 

type ProviderPortCollectionFirst struct {
	// The URL for the first page of resources.
	Href *string `json:"href" validate:"required"`
}

ProviderPortCollectionFirst : A reference to the first page of resources.

type ProviderPortCollectionNext 

type ProviderPortCollectionNext 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" validate:"required"`
}

ProviderPortCollectionNext : A reference to the next page of resources; this reference is included for all pages except the last page.

type UpdateProviderGatewayOptions 

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

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

	// The unique user-defined name for this gateway.
	Name *string `json:"name,omitempty"`

	// Gateway speed in megabits per second.
	SpeedMbps *int64 `json:"speed_mbps,omitempty"`

	// VLAN to be modified for this gateway.
	//
	// VLAN provided should be in the range 1 to 4094.
	Vlan *int64 `json:"vlan,omitempty"`

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

UpdateProviderGatewayOptions : The UpdateProviderGateway options.

func (*UpdateProviderGatewayOptions) SetBgpAsn added in v0.23.0 

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

SetBgpAsn : Allow user to set BgpAsn

func (*UpdateProviderGatewayOptions) SetBgpCerCidr added in v0.23.0 

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

SetBgpCerCidr : Allow user to set BgpCerCidr

func (*UpdateProviderGatewayOptions) SetBgpIbmCidr added in v0.23.0 

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

SetBgpIbmCidr : Allow user to set BgpIbmCidr

func (*UpdateProviderGatewayOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateProviderGatewayOptions) SetID 

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

SetID : Allow user to set ID

func (*UpdateProviderGatewayOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdateProviderGatewayOptions) SetSpeedMbps 

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

SetSpeedMbps : Allow user to set SpeedMbps

func (*UpdateProviderGatewayOptions) SetVlan added in v0.26.0 

func (_options *UpdateProviderGatewayOptions) SetVlan(vlan int64) *UpdateProviderGatewayOptions

SetVlan : Allow user to set Vlan

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.