transports

Creates, updates, deletes, gets or lists a transports resource.

Overview

Name	transports
Type	Resource
Id	google.networkconnectivity.transports

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the resource.
advertisedRoutes	array	Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
bandwidth	string	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. (BANDWIDTH_UNSPECIFIED, BPS_50M, BPS_100M, BPS_200M, BPS_300M, BPS_400M, BPS_500M, BPS_1G, BPS_2G, BPS_5G, BPS_10G, BPS_20G, BPS_50G, BPS_100G)
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the Transport.
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.
labels	object	Optional. Labels as key value pairs.
mtuLimit	integer (int32)	Output only. The maximum transmission unit (MTU) of a packet that can be sent over this transport.
network	string	Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
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.
providedActivationKey	string	Optional. Immutable. 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.
remoteAccountId	string	Optional. Immutable. The user supplied account id for the CSP associated with the remote profile.
remoteProfile	string	Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to.
stackType	string	Optional. IP version stack for the established connectivity. (STACK_TYPE_UNSPECIFIED, IPV4_ONLY, IPV4_IPV6)
state	string	Output only. State of the underlying connectivity. (STATE_UNSPECIFIED, CREATING, PENDING_CONFIG, PENDING_KEY, ACTIVE, DELETING, DEPROVISIONED)
updateTime	string (google-datetime)	Output only. Update time stamp.

list

Name	Datatype	Description
name	string	Identifier. Name of the resource.
advertisedRoutes	array	Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
bandwidth	string	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. (BANDWIDTH_UNSPECIFIED, BPS_50M, BPS_100M, BPS_200M, BPS_300M, BPS_400M, BPS_500M, BPS_1G, BPS_2G, BPS_5G, BPS_10G, BPS_20G, BPS_50G, BPS_100G)
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the Transport.
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.
labels	object	Optional. Labels as key value pairs.
mtuLimit	integer (int32)	Output only. The maximum transmission unit (MTU) of a packet that can be sent over this transport.
network	string	Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
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.
providedActivationKey	string	Optional. Immutable. 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.
remoteAccountId	string	Optional. Immutable. The user supplied account id for the CSP associated with the remote profile.
remoteProfile	string	Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to.
stackType	string	Optional. IP version stack for the established connectivity. (STACK_TYPE_UNSPECIFIED, IPV4_ONLY, IPV4_IPV6)
state	string	Output only. State of the underlying connectivity. (STATE_UNSPECIFIED, CREATING, PENDING_CONFIG, PENDING_KEY, ACTIVE, DELETING, DEPROVISIONED)
updateTime	string (google-datetime)	Output only. Update time stamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, transportsId		Gets details of a single Transport.
list	select	projectsId, locationsId	filter, pageToken, pageSize, orderBy	Lists Transports in a given project and location.
create	insert	projectsId, locationsId	transportId, requestId	Creates a new Transport in a given project and location.
patch	update	projectsId, locationsId, transportsId	updateMask, requestId	Updates the parameters of a single Transport.
delete	delete	projectsId, locationsId, transportsId	requestId	Deletes a single Transport.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
transportsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
transportId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Transport.

SELECT
name,
advertisedRoutes,
bandwidth,
createTime,
description,
generatedActivationKey,
labels,
mtuLimit,
network,
peeringNetwork,
providedActivationKey,
remoteAccountId,
remoteProfile,
stackType,
state,
updateTime
FROM google.networkconnectivity.transports
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND transportsId = '{{ transportsId }}' -- required
;

list

Lists Transports in a given project and location.

SELECT
name,
advertisedRoutes,
bandwidth,
createTime,
description,
generatedActivationKey,
labels,
mtuLimit,
network,
peeringNetwork,
providedActivationKey,
remoteAccountId,
remoteProfile,
stackType,
state,
updateTime
FROM google.networkconnectivity.transports
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new Transport in a given project and location.

INSERT INTO google.networkconnectivity.transports (
data__labels,
data__advertisedRoutes,
data__bandwidth,
data__remoteAccountId,
data__description,
data__remoteProfile,
data__providedActivationKey,
data__stackType,
data__name,
data__network,
projectsId,
locationsId,
transportId,
requestId
)
SELECT 
'{{ labels }}',
'{{ advertisedRoutes }}',
'{{ bandwidth }}',
'{{ remoteAccountId }}',
'{{ description }}',
'{{ remoteProfile }}',
'{{ providedActivationKey }}',
'{{ stackType }}',
'{{ name }}',
'{{ network }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ transportId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: transports
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the transports resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the transports resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs.
  - name: advertisedRoutes
    value:
      - "{{ advertisedRoutes }}"
    description: |
      Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
  - name: bandwidth
    value: "{{ bandwidth }}"
    description: |
      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.
    valid_values: ['BANDWIDTH_UNSPECIFIED', 'BPS_50M', 'BPS_100M', 'BPS_200M', 'BPS_300M', 'BPS_400M', 'BPS_500M', 'BPS_1G', 'BPS_2G', 'BPS_5G', 'BPS_10G', 'BPS_20G', 'BPS_50G', 'BPS_100G']
  - name: remoteAccountId
    value: "{{ remoteAccountId }}"
    description: |
      Optional. Immutable. The user supplied account id for the CSP associated with the remote profile.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the Transport.
  - name: remoteProfile
    value: "{{ remoteProfile }}"
    description: |
      Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to.
  - name: providedActivationKey
    value: "{{ providedActivationKey }}"
    description: |
      Optional. Immutable. 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.
  - name: stackType
    value: "{{ stackType }}"
    description: |
      Optional. IP version stack for the established connectivity.
    valid_values: ['STACK_TYPE_UNSPECIFIED', 'IPV4_ONLY', 'IPV4_IPV6']
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the resource.
  - name: network
    value: "{{ network }}"
    description: |
      Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
  - name: transportId
    value: "{{ transportId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single Transport.

UPDATE google.networkconnectivity.transports
SET 
data__labels = '{{ labels }}',
data__advertisedRoutes = '{{ advertisedRoutes }}',
data__bandwidth = '{{ bandwidth }}',
data__remoteAccountId = '{{ remoteAccountId }}',
data__description = '{{ description }}',
data__remoteProfile = '{{ remoteProfile }}',
data__providedActivationKey = '{{ providedActivationKey }}',
data__stackType = '{{ stackType }}',
data__name = '{{ name }}',
data__network = '{{ network }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND transportsId = '{{ transportsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Transport.

DELETE FROM google.networkconnectivity.transports
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND transportsId = '{{ transportsId }}' --required
AND requestId = '{{ requestId }}'
;