transitgatewayapisv1

package
v0.18.0 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2021 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_GreTunnel = "gre_tunnel"
	CreateTransitGatewayConnectionOptions_NetworkType_Vpc       = "vpc"
)

Constants associated with the CreateTransitGatewayConnectionOptions.NetworkType property. Defines what type of network is connected via this connection. For access to gre_tunnel connections contact IBM support.

View Source 
const (
	TransitConnection_NetworkType_Classic   = "classic"
	TransitConnection_NetworkType_GreTunnel = "gre_tunnel"
	TransitConnection_NetworkType_Vpc       = "vpc"
)

Constants associated with the TransitConnection.NetworkType property. Defines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source 
const (
	TransitConnection_RequestStatus_Approved = "approved"
	TransitConnection_RequestStatus_Detached = "detached"
	TransitConnection_RequestStatus_Expired  = "expired"
	TransitConnection_RequestStatus_Pending  = "pending"
	TransitConnection_RequestStatus_Rejected = "rejected"
)

Constants associated with the TransitConnection.RequestStatus property. Only visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. 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 (
	TransitConnection_Status_Attached  = "attached"
	TransitConnection_Status_Deleting  = "deleting"
	TransitConnection_Status_Detached  = "detached"
	TransitConnection_Status_Detaching = "detaching"
	TransitConnection_Status_Failed    = "failed"
	TransitConnection_Status_Pending   = "pending"
)

Constants associated with the TransitConnection.Status property. Connection state. 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 (
	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. 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 (
	TransitGatewayConnectionCust_NetworkType_Classic   = "classic"
	TransitGatewayConnectionCust_NetworkType_GreTunnel = "gre_tunnel"
	TransitGatewayConnectionCust_NetworkType_Vpc       = "vpc"
)

Constants associated with the TransitGatewayConnectionCust.NetworkType property. Defines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

View Source 
const (
	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 a connection request between IBM Cloud accounts. 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 (
	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. Connection's current configuration state. 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 = "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. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.

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 UnmarshalTransitConnection added in v0.17.0 

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

UnmarshalTransitConnection unmarshals an instance of TransitConnection from the specified map of raw messages.

func UnmarshalTransitConnectionCollection added in v0.17.0 

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

UnmarshalTransitConnectionCollection unmarshals an instance of TransitConnectionCollection from the specified map of raw messages.

func UnmarshalTransitConnectionCollectionFirst added in v0.17.0 

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

UnmarshalTransitConnectionCollectionFirst unmarshals an instance of TransitConnectionCollectionFirst from the specified map of raw messages.

func UnmarshalTransitConnectionCollectionNext added in v0.17.0 

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

UnmarshalTransitConnectionCollectionNext unmarshals an instance of TransitConnectionCollectionNext 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 UnmarshalTransitGatewayCollectionFirst added in v0.17.0 

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

UnmarshalTransitGatewayCollectionFirst unmarshals an instance of TransitGatewayCollectionFirst from the specified map of raw messages.

func UnmarshalTransitGatewayCollectionNext added in v0.17.0 

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

UnmarshalTransitGatewayCollectionNext unmarshals an instance of TransitGatewayCollectionNext 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.

func UnmarshalTransitGatewayConnectionCustZone added in v0.17.0 

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

UnmarshalTransitGatewayConnectionCustZone unmarshals an instance of TransitGatewayConnectionCustZone from the specified map of raw messages.

func UnmarshalTransitGatewayReference added in v0.17.0 

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

UnmarshalTransitGatewayReference unmarshals an instance of TransitGatewayReference from the specified map of raw messages.

func UnmarshalZoneIdentity added in v0.17.0 

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

UnmarshalZoneIdentity unmarshals an instance of ZoneIdentity from the specified map of raw messages.

func UnmarshalZoneIdentityByName added in v0.17.0 

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

UnmarshalZoneIdentityByName unmarshals an instance of ZoneIdentityByName from the specified map of raw messages.

func UnmarshalZoneReference added in v0.17.0 

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

UnmarshalZoneReference unmarshals an instance of ZoneReference 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 

func (options *CreateTransitGatewayConnectionActionsOptions) SetAction(action string) *CreateTransitGatewayConnectionActionsOptions

SetAction : Allow user to set Action

func (*CreateTransitGatewayConnectionActionsOptions) SetHeaders added in v0.2.0 

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

SetHeaders : Allow user to set Headers

func (*CreateTransitGatewayConnectionActionsOptions) SetID added in v0.2.0 

func (options *CreateTransitGatewayConnectionActionsOptions) SetID(id string) *CreateTransitGatewayConnectionActionsOptions

SetID : Allow user to set ID

func (*CreateTransitGatewayConnectionActionsOptions) SetTransitGatewayID added in v0.2.0 

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

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. For access to gre_tunnel connections contact IBM
	// support.
	NetworkType *string `json:"network_type" validate:"required"`

	// network_type 'gre_tunnel' connections must be created over an existing network_type 'classic' connection. This field
	// is required for 'gre_tunnel' connections and must specify the ID of an active transit gateway network_type 'classic'
	// connection in the same transit gateway. Omit 'base_connection_id' for any connection type other than 'gre_tunnel'.
	BaseConnectionID *string `json:"base_connection_id,omitempty"`

	// Local gateway IP address.  This field is required for and only applicable to type gre_tunnel connections.
	LocalGatewayIp *string `json:"local_gateway_ip,omitempty"`

	// Local tunnel IP address.  This field is required for and only applicable to type gre_tunnel connections.  The
	// local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network.  Neither can be the network nor
	// broadcast addresses.
	LocalTunnelIp *string `json:"local_tunnel_ip,omitempty"`

	// The user-defined name for this transit gateway connection. Network type 'vpc'  connections are defaulted to the name
	// of the VPC.  Network type 'classic' connections are named 'Classic'.   Name specification is required for network
	// type 'gre_tunnel' connections.
	Name *string `json:"name,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. This field is required to be unspecified for network type 'gre_tunnel'.
	NetworkAccountID *string `json:"network_account_id,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' and 'gre_tunnel' connections.
	NetworkID *string `json:"network_id,omitempty"`

	// Remote network BGP ASN.  This field is only applicable to 'gre_tunnel' type connections. The following ASN values
	// are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If
	// 'remote_bgp_asn' is omitted on gre_tunnel connection create requests IBM will assign an ASN.
	RemoteBgpAsn *string `json:"remote_bgp_asn,omitempty"`

	// Remote gateway IP address.  This field is required for and only applicable to type gre_tunnel connections.
	RemoteGatewayIp *string `json:"remote_gateway_ip,omitempty"`

	// Remote tunnel IP address.  This field is required for and only applicable to type gre_tunnel connections.  The
	// local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network.  Neither can be the network nor
	// broadcast addresses.
	RemoteTunnelIp *string `json:"remote_tunnel_ip,omitempty"`

	// For network_type 'gre_tunnel' connections specify the connection's location.  The specified availability zone must
	// reside in the gateway's region.
	// Use the IBM Cloud global catalog to list zones within the desired region.
	// This field is required for and only applicable to network type 'gre_tunnel' connections.
	Zone ZoneIdentityIntf `json:"zone,omitempty"`

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

CreateTransitGatewayConnectionOptions : The CreateTransitGatewayConnection options.

func (*CreateTransitGatewayConnectionOptions) SetBaseConnectionID added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetBaseConnectionID(baseConnectionID string) *CreateTransitGatewayConnectionOptions

SetBaseConnectionID : Allow user to set BaseConnectionID

func (*CreateTransitGatewayConnectionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateTransitGatewayConnectionOptions) SetLocalGatewayIp added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetLocalGatewayIp(localGatewayIp string) *CreateTransitGatewayConnectionOptions

SetLocalGatewayIp : Allow user to set LocalGatewayIp

func (*CreateTransitGatewayConnectionOptions) SetLocalTunnelIp added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetLocalTunnelIp(localTunnelIp string) *CreateTransitGatewayConnectionOptions

SetLocalTunnelIp : Allow user to set LocalTunnelIp

func (*CreateTransitGatewayConnectionOptions) SetName 

func (options *CreateTransitGatewayConnectionOptions) SetName(name string) *CreateTransitGatewayConnectionOptions

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 

func (options *CreateTransitGatewayConnectionOptions) SetNetworkID(networkID string) *CreateTransitGatewayConnectionOptions

SetNetworkID : Allow user to set NetworkID

func (*CreateTransitGatewayConnectionOptions) SetNetworkType 

func (options *CreateTransitGatewayConnectionOptions) SetNetworkType(networkType string) *CreateTransitGatewayConnectionOptions

SetNetworkType : Allow user to set NetworkType

func (*CreateTransitGatewayConnectionOptions) SetRemoteBgpAsn added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetRemoteBgpAsn(remoteBgpAsn string) *CreateTransitGatewayConnectionOptions

SetRemoteBgpAsn : Allow user to set RemoteBgpAsn

func (*CreateTransitGatewayConnectionOptions) SetRemoteGatewayIp added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetRemoteGatewayIp(remoteGatewayIp string) *CreateTransitGatewayConnectionOptions

SetRemoteGatewayIp : Allow user to set RemoteGatewayIp

func (*CreateTransitGatewayConnectionOptions) SetRemoteTunnelIp added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetRemoteTunnelIp(remoteTunnelIp string) *CreateTransitGatewayConnectionOptions

SetRemoteTunnelIp : Allow user to set RemoteTunnelIp

func (*CreateTransitGatewayConnectionOptions) SetTransitGatewayID 

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

SetTransitGatewayID : Allow user to set TransitGatewayID

func (*CreateTransitGatewayConnectionOptions) SetZone added in v0.17.0 

func (options *CreateTransitGatewayConnectionOptions) SetZone(zone ZoneIdentityIntf) *CreateTransitGatewayConnectionOptions

SetZone : Allow user to set Zone

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 

func (options *CreateTransitGatewayOptions) SetName(name string) *CreateTransitGatewayOptions

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 

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

SetHeaders : Allow user to set Headers

func (*DeleteTransitGatewayConnectionOptions) SetID 

func (options *DeleteTransitGatewayConnectionOptions) SetID(id string) *DeleteTransitGatewayConnectionOptions

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 

func (options *DeleteTransitGatewayOptions) SetID(id string) *DeleteTransitGatewayOptions

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 

func (options *GetGatewayLocationOptions) SetName(name string) *GetGatewayLocationOptions

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 

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

SetHeaders : Allow user to set Headers

func (*GetTransitGatewayConnectionOptions) SetID added in v0.2.0 

func (options *GetTransitGatewayConnectionOptions) SetID(id string) *GetTransitGatewayConnectionOptions

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 

func (options *GetTransitGatewayOptions) SetID(id string) *GetTransitGatewayOptions

SetID : Allow user to set ID

type ListConnectionsOptions added in v0.17.0 

type ListConnectionsOptions struct {
	// The maximum number of resources to return per page.
	Limit *int64 `json:"limit,omitempty"`

	// A server supplied token determining which resource to start the page on.
	Start *string `json:"start,omitempty"`

	// Search for connections with the given network_id value.
	NetworkID *string `json:"network_id,omitempty"`

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

ListConnectionsOptions : The ListConnections options.

func (*ListConnectionsOptions) SetHeaders added in v0.17.0 

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

SetHeaders : Allow user to set Headers

func (*ListConnectionsOptions) SetLimit added in v0.17.0 

func (options *ListConnectionsOptions) SetLimit(limit int64) *ListConnectionsOptions

SetLimit : Allow user to set Limit

func (*ListConnectionsOptions) SetNetworkID added in v0.17.0 

func (options *ListConnectionsOptions) SetNetworkID(networkID string) *ListConnectionsOptions

SetNetworkID : Allow user to set NetworkID

func (*ListConnectionsOptions) SetStart added in v0.17.0 

func (options *ListConnectionsOptions) SetStart(start string) *ListConnectionsOptions

SetStart : Allow user to set Start

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 

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

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 {
	// The maximum number of resources to return per page.
	Limit *int64 `json:"limit,omitempty"`

	// A server supplied token determining which resource to start the page on.
	Start *string `json:"start,omitempty"`

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

func (*ListTransitGatewaysOptions) SetLimit added in v0.17.0 

func (options *ListTransitGatewaysOptions) SetLimit(limit int64) *ListTransitGatewaysOptions

SetLimit : Allow user to set Limit

func (*ListTransitGatewaysOptions) SetStart added in v0.17.0 

func (options *ListTransitGatewaysOptions) SetStart(start string) *ListTransitGatewaysOptions

SetStart : Allow user to set Start

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

	// The name of the location.
	Name *string `json:"name,omitempty"`

	// The type of the location, determining is this a multi-zone region, a single data center, or a point of presence. The
	// list of enumerated values for this property may expand in the future. Code and processes using this field must
	// tolerate unexpected values.
	Type *string `json:"type,omitempty"`
}

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 TransitConnection added in v0.17.0 

type TransitConnection struct {
	// network_type 'gre_tunnel' connections use 'base_connection_id' to specify the id of a network_type 'classic'
	// connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in
	// an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted.
	// This field only applies to and is required for network type 'gre_tunnel' connections.
	BaseConnectionID *string `json:"base_connection_id,omitempty"`

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

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

	// Local network BGP ASN.  This field only applies to network type 'gre_tunnel' connections.
	LocalBgpAsn *int64 `json:"local_bgp_asn,omitempty"`

	// Local gateway IP address.  This field only applies to network type 'gre_tunnel' connections.
	LocalGatewayIp *string `json:"local_gateway_ip,omitempty"`

	// Local tunnel IP address.  This field only applies to network type 'gre_tunnel' connections.
	LocalTunnelIp *string `json:"local_tunnel_ip,omitempty"`

	// GRE tunnel MTU.  This field only applies to network type 'gre_tunnel' connections.
	Mtu *int64 `json:"mtu,omitempty"`

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

	// The ID of the account which owns the connected network. Generally only used if the network is in a different IBM
	// Cloud account than the gateway.
	NetworkAccountID *string `json:"network_account_id,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.
	NetworkID *string `json:"network_id,omitempty"`

	// Defines what type of network is connected via this connection. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field must tolerate unexpected values.
	NetworkType *string `json:"network_type" validate:"required"`

	// Remote network BGP ASN.  This field only applies to network type 'gre_tunnel' connections.
	RemoteBgpAsn *int64 `json:"remote_bgp_asn,omitempty"`

	// Remote gateway IP address.  This field only applies to network type 'gre_tunnel' connections.
	RemoteGatewayIp *string `json:"remote_gateway_ip,omitempty"`

	// Remote tunnel IP address.  This field only applies to network type 'gre_tunnel' connections.
	RemoteTunnelIp *string `json:"remote_tunnel_ip,omitempty"`

	// Only visible for cross account connections, this field represents the status of a connection request between IBM
	// Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field must tolerate unexpected values.
	RequestStatus *string `json:"request_status,omitempty"`

	// Connection state. 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"`

	// Reference to the transit gateway that contains this connection.
	TransitGateway *TransitGatewayReference `json:"transit_gateway" validate:"required"`

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

	// Location of GRE tunnel.  This field only applies to network type 'gre_tunnel' connections.
	Zone *ZoneReference `json:"zone,omitempty"`
}

TransitConnection : Transit gateway connection.

type TransitConnectionCollection added in v0.17.0 

type TransitConnectionCollection struct {
	// Array of transit gateway connections.
	Connections []TransitConnection `json:"connections" validate:"required"`

	// A reference to the first page of resources.
	First *TransitConnectionCollectionFirst `json:"first" validate:"required"`

	// The maximum number of connections returned on one 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 *TransitConnectionCollectionNext `json:"next,omitempty"`
}

TransitConnectionCollection : Transit gateway connections.

type TransitConnectionCollectionFirst added in v0.17.0 

type TransitConnectionCollectionFirst struct {
	// url.
	Href *string `json:"href" validate:"required"`
}

TransitConnectionCollectionFirst : A reference to the first page of resources.

type TransitConnectionCollectionNext added in v0.17.0 

type TransitConnectionCollectionNext struct {
	// url.
	Href *string `json:"href,omitempty"`

	// server generated start token for next page of resources.
	Start *string `json:"start,omitempty"`
}

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

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

	// 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) ListConnections added in v0.17.0 

func (transitGatewayApis *TransitGatewayApisV1) ListConnections(listConnectionsOptions *ListConnectionsOptions) (result *TransitConnectionCollection, response *core.DetailedResponse, err error)

ListConnections : Retrieves all connections List all transit gateway connections associated with this account.

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 Transit Gateways in account the caller is authorized 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) NewListConnectionsOptions added in v0.17.0 

func (*TransitGatewayApisV1) NewListConnectionsOptions() *ListConnectionsOptions

NewListConnectionsOptions : Instantiate ListConnectionsOptions

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 {
	// A reference to the first page of resources.
	First *TransitGatewayCollectionFirst `json:"first" validate:"required"`

	// The maximum number of gateways returned on one 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 *TransitGatewayCollectionNext `json:"next,omitempty"`

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

TransitGatewayCollection : A list of Transit Gateways.

type TransitGatewayCollectionFirst added in v0.17.0 

type TransitGatewayCollectionFirst struct {
	// url.
	Href *string `json:"href" validate:"required"`
}

TransitGatewayCollectionFirst : A reference to the first page of resources.

type TransitGatewayCollectionNext added in v0.17.0 

type TransitGatewayCollectionNext struct {
	// url.
	Href *string `json:"href" validate:"required"`

	// server generated start token for next page of resources.
	Start *string `json:"start" validate:"required"`
}

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

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 connection.
	Name *string `json:"name" validate:"required"`

	// 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.
	NetworkID *string `json:"network_id,omitempty"`

	// Defines what type of network is connected via this connection. The list of enumerated values for this property may
	// expand in the future. Code and processes using this field must tolerate unexpected values.
	NetworkType *string `json:"network_type" validate:"required"`

	// The unique identifier for this Transit Gateway Connection.
	ID *string `json:"id" validate:"required"`

	// network_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic'
	// connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in
	// an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted.
	// This field only applies to and is required for network type 'gre_tunnel' connections.
	BaseConnectionID *string `json:"base_connection_id,omitempty"`

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

	// Local network BGP ASN.  This field only applies to network type 'gre_tunnel' connections.
	LocalBgpAsn *int64 `json:"local_bgp_asn,omitempty"`

	// Local gateway IP address.  This field only applies to network type 'gre_tunnel' connections.
	LocalGatewayIp *string `json:"local_gateway_ip,omitempty"`

	// Local tunnel IP address.  This field only applies to network type 'gre_tunnel' connections.
	LocalTunnelIp *string `json:"local_tunnel_ip,omitempty"`

	// GRE tunnel MTU.  This field only applies to network type 'gre_tunnel' connections.
	Mtu *int64 `json:"mtu,omitempty"`

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

	// Remote network BGP ASN.  This field only applies to network type 'gre_tunnel' connections.
	RemoteBgpAsn *int64 `json:"remote_bgp_asn,omitempty"`

	// Remote gateway IP address.  This field only applies to network type 'gre_tunnel' connections.
	RemoteGatewayIp *string `json:"remote_gateway_ip,omitempty"`

	// Remote tunnel IP address.  This field only applies to network type 'gre_tunnel' connections.
	RemoteTunnelIp *string `json:"remote_tunnel_ip,omitempty"`

	// Only visible for cross account connections, this field represents the status of a connection request between IBM
	// Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using
	// this field must tolerate unexpected values.
	RequestStatus *string `json:"request_status,omitempty"`

	// Connection's current configuration state. 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,omitempty"`

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

	// Location of GRE tunnel.  This field only applies to network type 'gre_tunnel' connections.
	Zone *TransitGatewayConnectionCustZone `json:"zone,omitempty"`
}

TransitGatewayConnectionCust : Connection included in transit gateway.

type TransitGatewayConnectionCustZone added in v0.17.0 

type TransitGatewayConnectionCustZone struct {
	// Availability zone name.
	Name *string `json:"name" validate:"required"`
}

TransitGatewayConnectionCustZone : Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections.

type TransitGatewayReference added in v0.17.0 

type TransitGatewayReference struct {
	// gateway CRN.
	Crn *string `json:"crn" validate:"required"`

	// gateway ID.
	ID *string `json:"id" validate:"required"`

	// transit gateway name.
	Name *string `json:"name" validate:"required"`
}

TransitGatewayReference : Transit gateway reference.

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 

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

SetHeaders : Allow user to set Headers

func (*UpdateTransitGatewayConnectionOptions) SetID 

func (options *UpdateTransitGatewayConnectionOptions) SetID(id string) *UpdateTransitGatewayConnectionOptions

SetID : Allow user to set ID

func (*UpdateTransitGatewayConnectionOptions) SetName 

func (options *UpdateTransitGatewayConnectionOptions) SetName(name string) *UpdateTransitGatewayConnectionOptions

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 

func (options *UpdateTransitGatewayOptions) SetID(id string) *UpdateTransitGatewayOptions

SetID : Allow user to set ID

func (*UpdateTransitGatewayOptions) SetName 

func (options *UpdateTransitGatewayOptions) SetName(name string) *UpdateTransitGatewayOptions

SetName : Allow user to set Name

type ZoneIdentity added in v0.17.0 

type ZoneIdentity struct {
	// Availability zone name.
	Name *string `json:"name,omitempty"`
}

ZoneIdentity : ZoneIdentity struct Models which "extend" this model: - ZoneIdentityByName

type ZoneIdentityByName added in v0.17.0 

type ZoneIdentityByName struct {
	// Availability zone name.
	Name *string `json:"name,omitempty"`
}

ZoneIdentityByName : Availability zone. This model "extends" ZoneIdentity

type ZoneIdentityIntf added in v0.17.0 

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

type ZoneReference added in v0.17.0 

type ZoneReference struct {
	// Availability zone name.
	Name *string `json:"name" validate:"required"`
}

ZoneReference : Availability zone reference.

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.