REST Resource: projects.locations.transports

Resource: Transport

Message describing Transport object.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "remoteProfile": string,
  "providedActivationKey": string,
  "generatedActivationKey": string,
  "bandwidth": enum (Bandwidth),
  "stackType": enum (StackType),
  "state": enum (State),
  "mtuLimit": integer,
  "adminEnabled": boolean,
  "network": string,
  "advertisedRoutes": [
    string
  ],
  "remoteAccountId": string,
  "peeringNetwork": string
}
Fields
name

string

Identifier. Name of the resource.
createTime

string (Timestamp format)

Output only. Create time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Optional. Description of the Transport.
remoteProfile

string

Optional. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}
providedActivationKey

string

Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.
generatedActivationKey

string

Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.
bandwidth

enum (Bandwidth)

Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided.
stackType

enum (StackType)

Optional. IP version stack for the established connectivity.
state

enum (State)

Output only. State of the underlying connectivity.
mtuLimit

integer

Output only. The maximum transmission unit (MTU) of a packet that can be sent over this transport.
adminEnabled

boolean

Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.
network

string

Optional. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
advertisedRoutes[]

string

Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
remoteAccountId

string

Optional. The user supplied account id for the CSP associated with the remote profile.
peeringNetwork

string

Output only. VPC Network URI that was created for the VPC Peering connection to the provided network. If VPC Peering is disconnected, this can be used to re-establish.

Bandwidth

Supported bandwidth options.

Enums
BANDWIDTH_UNSPECIFIED Unspecified bandwidth.
BPS_50M 50 Megabits per second.
BPS_100M 100 Megabits per second.
BPS_200M 200 Megabits per second.
BPS_300M 300 Megabits per second.
BPS_400M 400 Megabits per second.
BPS_500M 500 Megabits per second.
BPS_1G 1 Gigabit per second.
BPS_2G 2 Gigabits per second.
BPS_5G 5 Gigabits per second.
BPS_10G 10 Gigabits per second.
BPS_20G 20 Gigabits per second.
BPS_50G 50 Gigabits per second.
BPS_100G 100 Gigabits per second.

StackType

IP version stack for the established connectivity.

Enums
STACK_TYPE_UNSPECIFIED Unspecified stack type.
IPV4_ONLY Only IPv4 is supported. (default)
IPV4_IPV6 Both IPv4 and IPv6 are supported.

State

Represents the status of the underlying connectivity. One of the following states, depending on who has initiated the Transport request.

Enums
STATE_UNSPECIFIED Unspecified state.
CREATING The resource exists locally and is being created / associated with the resource on the remote provider's end of the underlying connectivity.
PENDING_CONFIG The Transport exists on both sides of the connection, and is waiting for configuration to finalize and be verified as operational.
PENDING_KEY The Transport was created in Google Cloud Platform. Depending on the profile's key provisioning flow, this is either waiting for an activation key to be input (the key will be validated that it uses remote resources that match the Transport), or for the generated key to be input to the provider for finalizing. The configured bandwidth is not yet guaranteed.
ACTIVE The Transport is configured and the underlying connectivity is considered operational.

Methods

create

 Creates a new Transport in a given project and location.

delete

 Deletes a single Transport.

get

 Gets details of a single Transport.

list

 Lists Transports in a given project and location.

patch

 Updates the parameters of a single Transport.