2023-05-13
▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single ServiceConnectionPolicy.
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Description: Required. Name of the ServiceConnectionPolicy to get.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionPolicies/[^/]+$
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}
Parameter Order: name
▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.patch
Description: Updates the parameters of a single ServiceConnectionPolicy.
Parameters:
requestId
Type: string
Location: query
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).
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the ServiceConnectionPolicy 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 will be overwritten.
name
Type: string
Description: Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionPolicies/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
HTTP Method: PATCH
▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.list
Parameters:
filter
Type: string
Description: A filter expression that filters the results listed in the response.
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of results per page that should be returned.
orderBy
Location: query
Description: Sort the results by a certain order.
Type: string
parent
Type: string
Location: path
Required: Yes
Description: Required. The parent resource's name.
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Description: The page token.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies
Path: v1/{+parent}/serviceConnectionPolicies
Description: Lists ServiceConnectionPolicies in a given project and location.
HTTP Method: GET
▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.delete
Parameters:
requestId
Location: query
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).
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionPolicies/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The name of the ServiceConnectionPolicy to delete.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}
Description: Deletes a single ServiceConnectionPolicy.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Path: v1/{+name}
▼ ▲ networkconnectivity.projects.locations.serviceConnectionPolicies.create
Parameters:
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).
Type: string
Location: query
serviceConnectionPolicyId
Location: query
Description: Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
Type: string
parent
Description: Required. The parent resource's name of the ServiceConnectionPolicy.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1/{+parent}/serviceConnectionPolicies
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies
Description: Creates a new ServiceConnectionPolicy in a given project and location.
Parameter Order: parent
▼ ▲ networkconnectivity.projects.locations.serviceConnectionMaps.create
Description: Creates a new ServiceConnectionMap in a given project and location.
Path: v1/{+parent}/serviceConnectionMaps
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps
Parameters:
parent
Location: path
Type: string
Description: Required. The parent resource's name of the ServiceConnectionMap.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
requestId
Location: query
Type: string
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).
serviceConnectionMapId
Description: Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
Location: query
Type: string
Parameter Order: parent
HTTP Method: POST
▼ ▲ networkconnectivity.projects.locations.serviceConnectionMaps.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionMaps/[^/]+$
Location: path
Description: Required. The name of the ServiceConnectionMap to delete.
Required: Yes
Type: string
requestId
Location: query
Type: string
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).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
Path: v1/{+name}
Description: Deletes a single ServiceConnectionMap.
▼ ▲ networkconnectivity.projects.locations.serviceConnectionMaps.list
Parameters:
parent
Description: Required. The parent resource's name.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
orderBy
Type: string
Location: query
Description: Sort the results by a certain order.
filter
Type: string
Description: A filter expression that filters the results listed in the response.
Location: query
pageToken
Location: query
Description: The page token.
Type: string
pageSize
Type: integer
Format: int32
Location: query
Description: The maximum number of results per page that should be returned.
HTTP Method: GET
Parameter Order: parent
Path: v1/{+parent}/serviceConnectionMaps
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists ServiceConnectionMaps in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps
▼ ▲ networkconnectivity.projects.locations.serviceConnectionMaps.patch
Parameter Order: name
Parameters:
updateMask
Type: string
Location: query
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the ServiceConnectionMap 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 will be overwritten.
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
name
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionMaps/[^/]+$
Description: Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
Type: string
Required: Yes
Location: path
Description: Updates the parameters of a single ServiceConnectionMap.
HTTP Method: PATCH
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}
▼ ▲ networkconnectivity.projects.locations.serviceConnectionMaps.get
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionMaps/[^/]+$
Description: Required. Name of the ServiceConnectionMap to get.
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Description: Gets details of a single ServiceConnectionMap.
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}
▼ ▲ networkconnectivity.projects.locations.serviceConnectionTokens.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/serviceConnectionTokens
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens
Description: Creates a new ServiceConnectionToken in a given project and location.
Parameters:
parent
Type: string
Location: path
Description: Required. The parent resource's name of the ServiceConnectionToken.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
serviceConnectionTokenId
Type: string
Location: query
Description: Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
requestId
Location: query
Type: string
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).
Parameter Order: parent
▼ ▲ networkconnectivity.projects.locations.serviceConnectionTokens.list
Path: v1/{+parent}/serviceConnectionTokens
Description: Lists ServiceConnectionTokens in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The parent resource's name.
filter
Description: A filter expression that filters the results listed in the response.
Location: query
Type: string
pageToken
Type: string
Description: The page token.
Location: query
orderBy
Type: string
Description: Sort the results by a certain order.
Location: query
pageSize
Location: query
Format: int32
Description: The maximum number of results per page that should be returned.
Type: integer
▼ ▲ networkconnectivity.projects.locations.serviceConnectionTokens.delete
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens/{serviceConnectionTokensId}
Description: Deletes a single ServiceConnectionToken.
Parameters:
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
name
Description: Required. The name of the ServiceConnectionToken to delete.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionTokens/[^/]+$
Location: path
Path: v1/{+name}
▼ ▲ networkconnectivity.projects.locations.serviceConnectionTokens.get
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the ServiceConnectionToken to get.
Pattern: ^projects/[^/]+/locations/[^/]+/serviceConnectionTokens/[^/]+$
Location: path
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens/{serviceConnectionTokensId}
Description: Gets details of a single ServiceConnectionToken.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ networkconnectivity.projects.locations.serviceClasses.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. Name of the ServiceClass to get.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/serviceClasses/[^/]+$
Path: v1/{+name}
Description: Gets details of a single ServiceClass.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}
Parameter Order: name
▼ ▲ networkconnectivity.projects.locations.serviceClasses.patch
Description: Updates the parameters of a single ServiceClass.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}
Path: v1/{+name}
Parameter Order: name
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the ServiceClass 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 will be overwritten.
Type: string
requestId
Type: string
Location: query
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).
name
Pattern: ^projects/[^/]+/locations/[^/]+/serviceClasses/[^/]+$
Location: path
Description: Immutable. The name of a ServiceClass resource. Format: projects/{project}/locations/{location}/serviceClasses/{service_class} See: https://google.aip.dev/122#fields-representing-resource-names
Required: Yes
Type: string
▼ ▲ networkconnectivity.projects.locations.serviceClasses.create
Path: v1/{+parent}/serviceClasses
Description: Creates a new ServiceClass in a given project and location.
Parameters:
parent
Description: Required. The parent resource's name of the ServiceClass.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
serviceClassId
Location: query
Description: Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceClasses/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
Type: string
requestId
Type: string
Location: query
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).
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceClasses
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ networkconnectivity.projects.locations.serviceClasses.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceClasses
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Type: string
Description: Required. The parent resource's name.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Location: query
Type: string
Description: A filter expression that filters the results listed in the response.
pageSize
Type: integer
Format: int32
Description: The maximum number of results per page that should be returned.
Location: query
orderBy
Description: Sort the results by a certain order.
Location: query
Type: string
pageToken
Description: The page token.
Type: string
Location: query
Parameter Order: parent
Path: v1/{+parent}/serviceClasses
Description: Lists ServiceClasses in a given project and location.
HTTP Method: GET
▼ ▲ networkconnectivity.projects.locations.serviceClasses.delete
Parameters:
name
Type: string
Location: path
Required: Yes
Description: Required. The name of the ServiceClass to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/serviceClasses/[^/]+$
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).
Type: string
Location: query
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a single ServiceClass.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}