Network Connectivity API (networkconnectivity:v1)

▼ ▲ networkconnectivity.projects.locations.remoteTransportProfiles.list

Path : v1/{+parent}/remoteTransportProfiles

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListRemoteTransportProfilesRequest

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A token identifying a page of results the server should return.

Location : query

Type : string

filter

Description : Optional. Filtering results

Location : query

Type : string

orderBy

Description : Optional. Hint for how to order the results

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists RemoteTransportProfiles in a given project and location.

▼ ▲ networkconnectivity.projects.locations.remoteTransportProfiles.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/remoteTransportProfiles/{remoteTransportProfilesId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource

Pattern : ^projects/[^/]+/locations/[^/]+/remoteTransportProfiles/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets details of a single RemoteTransportProfile.

▼ ▲ networkconnectivity.projects.locations.transports.list

Path : v1/{+parent}/transports

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/transports

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListTransportsRequest

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A token identifying a page of results the server should return.

Location : query

Type : string

filter

Description : Optional. Filtering results

Location : query

Type : string

orderBy

Description : Optional. Hint for how to order the results

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists Transports in a given project and location.

▼ ▲ networkconnectivity.projects.locations.transports.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource

Pattern : ^projects/[^/]+/locations/[^/]+/transports/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets details of a single Transport.

▼ ▲ networkconnectivity.projects.locations.transports.create

Path : v1/{+parent}/transports

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/transports

HTTP Method : POST

Parameters :

parent

Description : Required. Value for parent.

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

Type : string

transportId

Description : Required. Id of the requesting object

Location : query

Type : string

requestId

Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Creates a new Transport in a given project and location.

▼ ▲ networkconnectivity.projects.locations.transports.patch

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}

HTTP Method : PATCH

Parameters :

name

Description : Identifier. name of resource

Pattern : ^projects/[^/]+/locations/[^/]+/transports/[^/]+$

Location : path

Required : Yes

Type : string

updateMask

Description : Optional. Field mask is used to specify the fields to be overwritten in the Transport resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.

Location : query

Type : string

Format : google-fieldmask

requestId

Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Updates the parameters of a single Transport.

▼ ▲ networkconnectivity.projects.locations.transports.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/transports/{transportsId}

HTTP Method : DELETE

Parameters :

name

Description : Required. Name of the resource

Pattern : ^projects/[^/]+/locations/[^/]+/transports/[^/]+$

Location : path

Required : Yes

Type : string

requestId

Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Deletes a single Transport.

▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.create

Parameters :

subnetworkMode

Description : Optional. If this field is not set, USER_PROVIDED is the inferred value to use.

Location : query

Type : string

Enum Descriptions :

• The default value if the enum is unset. Note user is not allowed to set the subnetwork mode to this value.
• Subnetworks are provided from the user input.
• Subnetwork list is empty from the user input. A subnetwork will be created automatically.

Enum :

• SUBNETWORK_MODE_UNSPECIFIED
• USER_PROVIDED
• AUTO_CREATED

autoSubnetworkConfig.ipStack

Description : Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used.

Location : query

Type : string

Enum Descriptions :

• Default value. Will create an IPV4_ONLY subnetwork by default.
• Will create an IPV4_ONLY subnetwork.
• Will create an IPV6_ONLY subnetwork.
• Will use IPv4 and IPv6 (dual stack).

Enum :

• SUBNET_IP_STACK_UNSPECIFIED
• IPV4_ONLY
• IPV6_ONLY
• IPV4_IPV6

autoSubnetworkConfig.prefixLength

Description : Optional. The desired prefix length for the subnet's IP address range. E.g., 24 for a /24. The actual range is allocated from available space. If not specified, 24 is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.

Location : query

Type : integer

Format : int32

autoSubnetworkConfig.allocRangeSpace

Description : Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.

Location : query

Type : string