transitgatewayapisv1

package
v0.12.2 Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2020 License: Apache-2.0 Imports: 6 Imported by: 15

Documentation

Overview

Package transitgatewayapisv1 : Operations and models for the TransitGatewayApisV1 service

Index

Constants

View Source
const (
	CreateTransitGatewayConnectionActionsOptions_Action_Approve = "approve"
	CreateTransitGatewayConnectionActionsOptions_Action_Reject  = "reject"
)

Constants associated with the CreateTransitGatewayConnectionActionsOptions.Action property. The action that is to be performed against the connection request.

View Source
const (
	CreateTransitGatewayConnectionOptions_NetworkType_Classic = "classic"
	CreateTransitGatewayConnectionOptions_NetworkType_Vpc     = "vpc"
)

Constants associated with the CreateTransitGatewayConnectionOptions.NetworkType property. Defines what type of network is connected via this connection.

View Source
const (
	TransitGateway_Status_Available = "available"
	TransitGateway_Status_Deleting  = "deleting"
	TransitGateway_Status_Failed    = "failed"
	TransitGateway_Status_Pending   = "pending"
)

Constants associated with the TransitGateway.Status property. The status of the Transit Gateway.

View Source
const (
	TransitGatewayConnectionCust_NetworkType_Classic = "classic"
	TransitGatewayConnectionCust_NetworkType_Vpc     = "vpc"
)

Constants associated with the TransitGatewayConnectionCust.NetworkType property. Defines what type of network is connected via this connection.

View Source
const (
	TransitGatewayConnectionCust_RequestStatus_Approved = "approved"
	TransitGatewayConnectionCust_RequestStatus_Detached = "detached"
	TransitGatewayConnectionCust_RequestStatus_Expired  = "expired"
	TransitGatewayConnectionCust_RequestStatus_Pending  = "pending"
	TransitGatewayConnectionCust_RequestStatus_Rejected = "rejected"
)

Constants associated with the TransitGatewayConnectionCust.RequestStatus property. Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.

View Source
const (
	TransitGatewayConnectionCust_Status_Attached  = "attached"
	TransitGatewayConnectionCust_Status_Deleting  = "deleting"
	TransitGatewayConnectionCust_Status_Detached  = "detached"
	TransitGatewayConnectionCust_Status_Detaching = "detaching"
	TransitGatewayConnectionCust_Status_Failed    = "failed"
	TransitGatewayConnectionCust_Status_Pending   = "pending"
)

Constants associated with the TransitGatewayConnectionCust.Status property. What is the current configuration state of this connection.

View Source
const DefaultServiceName = "transit_gateway_apis"

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

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

DefaultServiceURL is the default URL to make service requests to.

View Source
const (
	TSLocalLocation_Type_Region = "region"
)

Constants associated with the TSLocalLocation.Type property. The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.

Variables

This section is empty.

Functions

func UnmarshalResourceGroupIdentity

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

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

func UnmarshalResourceGroupReference

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

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

func UnmarshalTSCollection

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

UnmarshalTSCollection unmarshals an instance of TSCollection from the specified map of raw messages.

func UnmarshalTSLocalLocation

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

UnmarshalTSLocalLocation unmarshals an instance of TSLocalLocation from the specified map of raw messages.

func UnmarshalTSLocation

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

UnmarshalTSLocation unmarshals an instance of TSLocation from the specified map of raw messages.

func UnmarshalTSLocationBasic

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

UnmarshalTSLocationBasic unmarshals an instance of TSLocationBasic from the specified map of raw messages.

func UnmarshalTransitGateway

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

UnmarshalTransitGateway unmarshals an instance of TransitGateway from the specified map of raw messages.

func UnmarshalTransitGatewayCollection

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

UnmarshalTransitGatewayCollection unmarshals an instance of TransitGatewayCollection from the specified map of raw messages.

func UnmarshalTransitGatewayConnectionCollection

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

UnmarshalTransitGatewayConnectionCollection unmarshals an instance of TransitGatewayConnectionCollection from the specified map of raw messages.

func UnmarshalTransitGatewayConnectionCust

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

UnmarshalTransitGatewayConnectionCust unmarshals an instance of TransitGatewayConnectionCust from the specified map of raw messages.

Types

type CreateTransitGatewayConnectionActionsOptions added in v0.2.0

type CreateTransitGatewayConnectionActionsOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

	// The connection identifier.
	ID *string `json:"id" validate:"required"`

	// The action that is to be performed against the connection request.
	Action *string `json:"action" validate:"required"`

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

CreateTransitGatewayConnectionActionsOptions : The CreateTransitGatewayConnectionActions options.

func (*CreateTransitGatewayConnectionActionsOptions) SetAction added in v0.2.0

SetAction : Allow user to set Action

func (*CreateTransitGatewayConnectionActionsOptions) SetHeaders added in v0.2.0

SetHeaders : Allow user to set Headers

func (*CreateTransitGatewayConnectionActionsOptions) SetID added in v0.2.0

SetID : Allow user to set ID

func (*CreateTransitGatewayConnectionActionsOptions) SetTransitGatewayID added in v0.2.0

SetTransitGatewayID : Allow user to set TransitGatewayID

type CreateTransitGatewayConnectionOptions

type CreateTransitGatewayConnectionOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

	// Defines what type of network is connected via this connection.
	NetworkType *string `json:"network_type" validate:"required"`

	// The user-defined name for this transit gateway. If unspecified, the name will be the network name (the name of the
	// VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
	Name *string `json:"name,omitempty"`

	// The ID of the network being connected via this connection. This field is required for some types, such as 'vpc'. For
	// network type 'vpc' this is the CRN of the VPC to be connected. This field is required to be unspecified for network
	// type 'classic'.
	NetworkID *string `json:"network_id,omitempty"`

	// The ID of the account which owns the network that is being connected. Generally only used if the network is in a
	// different account than the gateway.
	NetworkAccountID *string `json:"network_account_id,omitempty"`

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

CreateTransitGatewayConnectionOptions : The CreateTransitGatewayConnection options.

func (*CreateTransitGatewayConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateTransitGatewayConnectionOptions) SetName

SetName : Allow user to set Name

func (*CreateTransitGatewayConnectionOptions) SetNetworkAccountID added in v0.2.0

func (options *CreateTransitGatewayConnectionOptions) SetNetworkAccountID(networkAccountID string) *CreateTransitGatewayConnectionOptions

SetNetworkAccountID : Allow user to set NetworkAccountID

func (*CreateTransitGatewayConnectionOptions) SetNetworkID

SetNetworkID : Allow user to set NetworkID

func (*CreateTransitGatewayConnectionOptions) SetNetworkType

SetNetworkType : Allow user to set NetworkType

func (*CreateTransitGatewayConnectionOptions) SetTransitGatewayID

func (options *CreateTransitGatewayConnectionOptions) SetTransitGatewayID(transitGatewayID string) *CreateTransitGatewayConnectionOptions

SetTransitGatewayID : Allow user to set TransitGatewayID

type CreateTransitGatewayOptions

type CreateTransitGatewayOptions struct {
	// Location of Transit Gateway Services.
	Location *string `json:"location" validate:"required"`

	// Name Transit Gateway Services.
	Name *string `json:"name" validate:"required"`

	// Allow global routing for a Transit Gateway. If unspecified, the default value is false.
	Global *bool `json:"global,omitempty"`

	// The resource group to use. If unspecified, the account's [default resource
	// group](https://console.bluemix.net/apidocs/resource-manager#introduction) is used.
	ResourceGroup *ResourceGroupIdentity `json:"resource_group,omitempty"`

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

CreateTransitGatewayOptions : The CreateTransitGateway options.

func (*CreateTransitGatewayOptions) SetGlobal

func (options *CreateTransitGatewayOptions) SetGlobal(global bool) *CreateTransitGatewayOptions

SetGlobal : Allow user to set Global

func (*CreateTransitGatewayOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateTransitGatewayOptions) SetLocation

func (options *CreateTransitGatewayOptions) SetLocation(location string) *CreateTransitGatewayOptions

SetLocation : Allow user to set Location

func (*CreateTransitGatewayOptions) SetName

SetName : Allow user to set Name

func (*CreateTransitGatewayOptions) SetResourceGroup

func (options *CreateTransitGatewayOptions) SetResourceGroup(resourceGroup *ResourceGroupIdentity) *CreateTransitGatewayOptions

SetResourceGroup : Allow user to set ResourceGroup

type DeleteTransitGatewayConnectionOptions

type DeleteTransitGatewayConnectionOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

	// The connection identifier.
	ID *string `json:"id" validate:"required"`

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

DeleteTransitGatewayConnectionOptions : The DeleteTransitGatewayConnection options.

func (*DeleteTransitGatewayConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*DeleteTransitGatewayConnectionOptions) SetID

SetID : Allow user to set ID

func (*DeleteTransitGatewayConnectionOptions) SetTransitGatewayID

func (options *DeleteTransitGatewayConnectionOptions) SetTransitGatewayID(transitGatewayID string) *DeleteTransitGatewayConnectionOptions

SetTransitGatewayID : Allow user to set TransitGatewayID

type DeleteTransitGatewayOptions

type DeleteTransitGatewayOptions struct {
	// The Transit Gateway identifier.
	ID *string `json:"id" validate:"required"`

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

DeleteTransitGatewayOptions : The DeleteTransitGateway options.

func (*DeleteTransitGatewayOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteTransitGatewayOptions) SetID

SetID : Allow user to set ID

type GetGatewayLocationOptions added in v0.2.0

type GetGatewayLocationOptions struct {
	// The Transit Gateway location Name.
	Name *string `json:"name" validate:"required"`

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

GetGatewayLocationOptions : The GetGatewayLocation options.

func (*GetGatewayLocationOptions) SetHeaders added in v0.2.0

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

SetHeaders : Allow user to set Headers

func (*GetGatewayLocationOptions) SetName added in v0.2.0

SetName : Allow user to set Name

type GetTransitGatewayConnectionOptions added in v0.2.0

type GetTransitGatewayConnectionOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

	// The connection identifier.
	ID *string `json:"id" validate:"required"`

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

GetTransitGatewayConnectionOptions : The GetTransitGatewayConnection options.

func (*GetTransitGatewayConnectionOptions) SetHeaders added in v0.2.0

SetHeaders : Allow user to set Headers

func (*GetTransitGatewayConnectionOptions) SetID added in v0.2.0

SetID : Allow user to set ID

func (*GetTransitGatewayConnectionOptions) SetTransitGatewayID added in v0.2.0

func (options *GetTransitGatewayConnectionOptions) SetTransitGatewayID(transitGatewayID string) *GetTransitGatewayConnectionOptions

SetTransitGatewayID : Allow user to set TransitGatewayID

type GetTransitGatewayOptions added in v0.2.0

type GetTransitGatewayOptions struct {
	// The Transit Gateway identifier.
	ID *string `json:"id" validate:"required"`

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

GetTransitGatewayOptions : The GetTransitGateway options.

func (*GetTransitGatewayOptions) SetHeaders added in v0.2.0

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

SetHeaders : Allow user to set Headers

func (*GetTransitGatewayOptions) SetID added in v0.2.0

SetID : Allow user to set ID

type ListGatewayLocationsOptions

type ListGatewayLocationsOptions struct {

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

ListGatewayLocationsOptions : The ListGatewayLocations options.

func (*ListGatewayLocationsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type ListTransitGatewayConnectionsOptions

type ListTransitGatewayConnectionsOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

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

ListTransitGatewayConnectionsOptions : The ListTransitGatewayConnections options.

func (*ListTransitGatewayConnectionsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListTransitGatewayConnectionsOptions) SetTransitGatewayID

func (options *ListTransitGatewayConnectionsOptions) SetTransitGatewayID(transitGatewayID string) *ListTransitGatewayConnectionsOptions

SetTransitGatewayID : Allow user to set TransitGatewayID

type ListTransitGatewaysOptions

type ListTransitGatewaysOptions struct {

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

ListTransitGatewaysOptions : The ListTransitGateways options.

func (*ListTransitGatewaysOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type ResourceGroupIdentity

type ResourceGroupIdentity struct {
	// The unique identifier for this resource group.
	ID *string `json:"id" validate:"required"`
}

ResourceGroupIdentity : The resource group to use. If unspecified, the account's [default resource group](https://console.bluemix.net/apidocs/resource-manager#introduction) is used.

type ResourceGroupReference

type ResourceGroupReference struct {
	// The unique identifier for this resource group.
	ID *string `json:"id" validate:"required"`

	// The URL for this resource group.
	Href *string `json:"href" validate:"required"`
}

ResourceGroupReference : The resource group to use. If unspecified, the account's [default resource group](https://console.bluemix.net/apidocs/resource-manager#introduction) is used.

type TSCollection

type TSCollection struct {
	// Collection of Transit Gateway locations.
	Locations []TSLocationBasic `json:"locations" validate:"required"`
}

TSCollection : A list of Transit Gateway locations.

type TSLocalLocation

type TSLocalLocation struct {
	// A descriptive display name for the location.
	DisplayName *string `json:"display_name" validate:"required"`

	// The name of the location.
	Name *string `json:"name" validate:"required"`

	// The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
	Type *string `json:"type" validate:"required"`
}

TSLocalLocation : Details of a local connection location.

type TSLocation

type TSLocation struct {
	// The geographical location of this location, used for billing purposes.
	BillingLocation *string `json:"billing_location" validate:"required"`

	// Name of the Location.
	Name *string `json:"name" validate:"required"`

	// The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
	Type *string `json:"type" validate:"required"`

	// The set of network locations that are considered local for this Transit Gateway location.
	LocalConnectionLocations []TSLocalLocation `json:"local_connection_locations" validate:"required"`
}

TSLocation : Details of a Transit Gateway location.

type TSLocationBasic

type TSLocationBasic struct {
	// The geographical location of this location, used for billing purposes.
	BillingLocation *string `json:"billing_location" validate:"required"`

	// Name of the Location.
	Name *string `json:"name" validate:"required"`

	// The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
	Type *string `json:"type" validate:"required"`
}

TSLocationBasic : Details of a Transit Gateway location.

type TransitGateway

type TransitGateway struct {
	// The unique identifier for this Transit Gateway.
	ID *string `json:"id" validate:"required"`

	// The CRN for this Transit Gateway.
	Crn *string `json:"crn" validate:"required"`

	// A human readable name for the transit gateway.
	Name *string `json:"name" validate:"required"`

	// Location of Transit Gateway Services.
	Location *string `json:"location" validate:"required"`

	// The date and time that this gateway was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Allow global routing for a Transit Gateway.
	Global *bool `json:"global" validate:"required"`

	// The resource group to use. If unspecified, the account's [default resource
	// group](https://console.bluemix.net/apidocs/resource-manager#introduction) is used.
	ResourceGroup *ResourceGroupReference `json:"resource_group,omitempty"`

	// The status of the Transit Gateway.
	Status *string `json:"status" validate:"required"`

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

TransitGateway : Details of a Transit Gateway.

type TransitGatewayApisV1

type TransitGatewayApisV1 struct {
	Service *core.BaseService

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

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

Version: __VERSION__

func NewTransitGatewayApisV1

func NewTransitGatewayApisV1(options *TransitGatewayApisV1Options) (service *TransitGatewayApisV1, err error)

NewTransitGatewayApisV1 : constructs an instance of TransitGatewayApisV1 with passed in options.

func NewTransitGatewayApisV1UsingExternalConfig

func NewTransitGatewayApisV1UsingExternalConfig(options *TransitGatewayApisV1Options) (transitGatewayApis *TransitGatewayApisV1, err error)

NewTransitGatewayApisV1UsingExternalConfig : constructs an instance of TransitGatewayApisV1 with passed in options and external configuration.

func (*TransitGatewayApisV1) CreateTransitGateway

func (transitGatewayApis *TransitGatewayApisV1) CreateTransitGateway(createTransitGatewayOptions *CreateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

CreateTransitGateway : Creates a Transit Gateway Create a Transit Gateway based on the supplied input template.

func (*TransitGatewayApisV1) CreateTransitGatewayConnection

func (transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnection(createTransitGatewayConnectionOptions *CreateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

CreateTransitGatewayConnection : Add connection to a Transit Gateway Add a connection to Transit Gateway.

func (*TransitGatewayApisV1) CreateTransitGatewayConnectionActions added in v0.2.0

func (transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions *CreateTransitGatewayConnectionActionsOptions) (response *core.DetailedResponse, err error)

CreateTransitGatewayConnectionActions : Perform actions on a connection for a Transit Gateway Allow a network owner to approve or reject a cross-account connection request.

func (*TransitGatewayApisV1) DeleteTransitGateway

func (transitGatewayApis *TransitGatewayApisV1) DeleteTransitGateway(deleteTransitGatewayOptions *DeleteTransitGatewayOptions) (response *core.DetailedResponse, err error)

DeleteTransitGateway : Deletes specified Transit Gateway This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.

func (*TransitGatewayApisV1) DeleteTransitGatewayConnection

func (transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions *DeleteTransitGatewayConnectionOptions) (response *core.DetailedResponse, err error)

DeleteTransitGatewayConnection : Remove connection from Transit Gateway After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.

func (*TransitGatewayApisV1) GetGatewayLocation added in v0.2.0

func (transitGatewayApis *TransitGatewayApisV1) GetGatewayLocation(getGatewayLocationOptions *GetGatewayLocationOptions) (result *TSLocation, response *core.DetailedResponse, err error)

GetGatewayLocation : Show the details of a given Transit Gateway location Get the details of a Transit Gateway Location.

func (*TransitGatewayApisV1) GetTransitGateway added in v0.2.0

func (transitGatewayApis *TransitGatewayApisV1) GetTransitGateway(getTransitGatewayOptions *GetTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

GetTransitGateway : Retrieves specified Transit Gateway This request retrieves a single Transit Gateway specified by the identifier in the URL.

func (*TransitGatewayApisV1) GetTransitGatewayConnection added in v0.2.0

func (transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnection(getTransitGatewayConnectionOptions *GetTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

GetTransitGatewayConnection : Retrieves specified Transit Gateway connection This request retrieves a connection from the Transit Gateway.

func (*TransitGatewayApisV1) ListGatewayLocations

func (transitGatewayApis *TransitGatewayApisV1) ListGatewayLocations(listGatewayLocationsOptions *ListGatewayLocationsOptions) (result *TSCollection, response *core.DetailedResponse, err error)

ListGatewayLocations : List all locations that support Transit Gateways List all locations that support Transit Gateways.

func (*TransitGatewayApisV1) ListTransitGatewayConnections

func (transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnections(listTransitGatewayConnectionsOptions *ListTransitGatewayConnectionsOptions) (result *TransitGatewayConnectionCollection, response *core.DetailedResponse, err error)

ListTransitGatewayConnections : Retrieves all connections in a Transit Gateway This request retrieves all connections in a Transit Gateway.

func (*TransitGatewayApisV1) ListTransitGateways

func (transitGatewayApis *TransitGatewayApisV1) ListTransitGateways(listTransitGatewaysOptions *ListTransitGatewaysOptions) (result *TransitGatewayCollection, response *core.DetailedResponse, err error)

ListTransitGateways : Retrieves all Transit Gateways List all the Transit Gateways in the account. User will get a list of Transit Gateways they have access to 'view'.

func (*TransitGatewayApisV1) NewCreateTransitGatewayConnectionActionsOptions added in v0.2.0

func (*TransitGatewayApisV1) NewCreateTransitGatewayConnectionActionsOptions(transitGatewayID string, id string, action string) *CreateTransitGatewayConnectionActionsOptions

NewCreateTransitGatewayConnectionActionsOptions : Instantiate CreateTransitGatewayConnectionActionsOptions

func (*TransitGatewayApisV1) NewCreateTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewCreateTransitGatewayConnectionOptions(transitGatewayID string, networkType string) *CreateTransitGatewayConnectionOptions

NewCreateTransitGatewayConnectionOptions : Instantiate CreateTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewCreateTransitGatewayOptions

func (*TransitGatewayApisV1) NewCreateTransitGatewayOptions(location string, name string) *CreateTransitGatewayOptions

NewCreateTransitGatewayOptions : Instantiate CreateTransitGatewayOptions

func (*TransitGatewayApisV1) NewDeleteTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewDeleteTransitGatewayConnectionOptions(transitGatewayID string, id string) *DeleteTransitGatewayConnectionOptions

NewDeleteTransitGatewayConnectionOptions : Instantiate DeleteTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewDeleteTransitGatewayOptions

func (*TransitGatewayApisV1) NewDeleteTransitGatewayOptions(id string) *DeleteTransitGatewayOptions

NewDeleteTransitGatewayOptions : Instantiate DeleteTransitGatewayOptions

func (*TransitGatewayApisV1) NewGetGatewayLocationOptions added in v0.2.0

func (*TransitGatewayApisV1) NewGetGatewayLocationOptions(name string) *GetGatewayLocationOptions

NewGetGatewayLocationOptions : Instantiate GetGatewayLocationOptions

func (*TransitGatewayApisV1) NewGetTransitGatewayConnectionOptions added in v0.2.0

func (*TransitGatewayApisV1) NewGetTransitGatewayConnectionOptions(transitGatewayID string, id string) *GetTransitGatewayConnectionOptions

NewGetTransitGatewayConnectionOptions : Instantiate GetTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewGetTransitGatewayOptions added in v0.2.0

func (*TransitGatewayApisV1) NewGetTransitGatewayOptions(id string) *GetTransitGatewayOptions

NewGetTransitGatewayOptions : Instantiate GetTransitGatewayOptions

func (*TransitGatewayApisV1) NewListGatewayLocationsOptions

func (*TransitGatewayApisV1) NewListGatewayLocationsOptions() *ListGatewayLocationsOptions

NewListGatewayLocationsOptions : Instantiate ListGatewayLocationsOptions

func (*TransitGatewayApisV1) NewListTransitGatewayConnectionsOptions

func (*TransitGatewayApisV1) NewListTransitGatewayConnectionsOptions(transitGatewayID string) *ListTransitGatewayConnectionsOptions

NewListTransitGatewayConnectionsOptions : Instantiate ListTransitGatewayConnectionsOptions

func (*TransitGatewayApisV1) NewListTransitGatewaysOptions

func (*TransitGatewayApisV1) NewListTransitGatewaysOptions() *ListTransitGatewaysOptions

NewListTransitGatewaysOptions : Instantiate ListTransitGatewaysOptions

func (*TransitGatewayApisV1) NewResourceGroupIdentity

func (*TransitGatewayApisV1) NewResourceGroupIdentity(id string) (model *ResourceGroupIdentity, err error)

NewResourceGroupIdentity : Instantiate ResourceGroupIdentity (Generic Model Constructor)

func (*TransitGatewayApisV1) NewUpdateTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewUpdateTransitGatewayConnectionOptions(transitGatewayID string, id string) *UpdateTransitGatewayConnectionOptions

NewUpdateTransitGatewayConnectionOptions : Instantiate UpdateTransitGatewayConnectionOptions

func (*TransitGatewayApisV1) NewUpdateTransitGatewayOptions

func (*TransitGatewayApisV1) NewUpdateTransitGatewayOptions(id string) *UpdateTransitGatewayOptions

NewUpdateTransitGatewayOptions : Instantiate UpdateTransitGatewayOptions

func (*TransitGatewayApisV1) SetServiceURL

func (transitGatewayApis *TransitGatewayApisV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*TransitGatewayApisV1) UpdateTransitGateway

func (transitGatewayApis *TransitGatewayApisV1) UpdateTransitGateway(updateTransitGatewayOptions *UpdateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

UpdateTransitGateway : Updates specified Transit Gateway This request updates a Transit Gateway's name and/or global flag.

func (*TransitGatewayApisV1) UpdateTransitGatewayConnection

func (transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnection(updateTransitGatewayConnectionOptions *UpdateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

UpdateTransitGatewayConnection : Updates specified Transit Gateway connection Update the name of a connection to a Transit Gateway.

type TransitGatewayApisV1Options

type TransitGatewayApisV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Requests the version of the API as of a date in the format `YYYY-MM-DD`. Any date up to the current date may be
	// provided. Specify the current date to request the latest version.
	Version *string `validate:"required"`
}

TransitGatewayApisV1Options : Service options

type TransitGatewayCollection

type TransitGatewayCollection struct {
	// Collection of Transit Services gateways.
	TransitGateways []TransitGateway `json:"transit_gateways" validate:"required"`
}

TransitGatewayCollection : A list of Transit Gateways.

type TransitGatewayConnectionCollection

type TransitGatewayConnectionCollection struct {
	// Array of transit gateways network Connections.
	Connections []TransitGatewayConnectionCust `json:"connections" validate:"required"`
}

TransitGatewayConnectionCollection : A set of Transit Gateway network connections.

type TransitGatewayConnectionCust

type TransitGatewayConnectionCust struct {
	// The user-defined name for this transit gateway. If unspecified, the name will be the network name (the name of the
	// VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
	Name *string `json:"name,omitempty"`

	// The ID of the network being connected via this connection. This field is required for some types, such as 'vpc'. For
	// network type 'vpc' this is the CRN of the VPC to be connected. This field is required to be unspecified for network
	// type 'classic'.
	NetworkID *string `json:"network_id,omitempty"`

	// Defines what type of network is connected via this connection.
	NetworkType *string `json:"network_type" validate:"required"`

	// The ID of the account which owns the network that is being connected. Generally only used if the network is in a
	// different account than the gateway.
	NetworkAccountID *string `json:"network_account_id,omitempty"`

	// The unique identifier for this Transit Gateway Connection to Network (vpc/classic).
	ID *string `json:"id" validate:"required"`

	// The date and time that this connection was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Only visible for cross account connections, this field represents the status of the request to connect the given
	// network between accounts.
	RequestStatus *string `json:"request_status,omitempty"`

	// What is the current configuration state of this connection.
	Status *string `json:"status,omitempty"`

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

TransitGatewayConnectionCust : Connection included in transit gateway.

type UpdateTransitGatewayConnectionOptions

type UpdateTransitGatewayConnectionOptions struct {
	// The Transit Gateway identifier.
	TransitGatewayID *string `json:"transit_gateway_id" validate:"required"`

	// The connection identifier.
	ID *string `json:"id" validate:"required"`

	// The user-defined name for this transit gateway. If specified as empty string or nil,  the name will be the network
	// name (the name of the VPC in the case of network type 'vpc',  and the word Classic, in the case of network type
	// 'classic').
	Name *string `json:"name,omitempty"`

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

UpdateTransitGatewayConnectionOptions : The UpdateTransitGatewayConnection options.

func (*UpdateTransitGatewayConnectionOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateTransitGatewayConnectionOptions) SetID

SetID : Allow user to set ID

func (*UpdateTransitGatewayConnectionOptions) SetName

SetName : Allow user to set Name

func (*UpdateTransitGatewayConnectionOptions) SetTransitGatewayID

func (options *UpdateTransitGatewayConnectionOptions) SetTransitGatewayID(transitGatewayID string) *UpdateTransitGatewayConnectionOptions

SetTransitGatewayID : Allow user to set TransitGatewayID

type UpdateTransitGatewayOptions

type UpdateTransitGatewayOptions struct {
	// The Transit Gateway identifier.
	ID *string `json:"id" validate:"required"`

	// Allow global routing for a Transit Gateway.
	Global *bool `json:"global,omitempty"`

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

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

UpdateTransitGatewayOptions : The UpdateTransitGateway options.

func (*UpdateTransitGatewayOptions) SetGlobal

func (options *UpdateTransitGatewayOptions) SetGlobal(global bool) *UpdateTransitGatewayOptions

SetGlobal : Allow user to set Global

func (*UpdateTransitGatewayOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateTransitGatewayOptions) SetID

SetID : Allow user to set ID

func (*UpdateTransitGatewayOptions) SetName

SetName : Allow user to set Name

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL