2022-11-10
▼ ▲ networkconnectivity.projects.locations.internalRanges.delete
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 t he 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 InternalRange to delete.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Required : Yes
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
HTTP Method : DELETE
Path : v1alpha1/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single InternalRange.
▼ ▲ networkconnectivity.projects.locations.internalRanges.create
HTTP Method : POST
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 t he 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).
internalRangeId
Type : string
Description : Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
Location : query
parent
Location : path
Description : Required. The parent resource's name of the InternalRange.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Parameter Order : parent
Description : Creates a new InternalRange in a given project and location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha1/{+parent}/internalRanges
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges
▼ ▲ networkconnectivity.projects.locations.internalRanges.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single InternalRange.
Parameters :
name
Description : Required. Name of the InternalRange to get.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Path : v1alpha1/{+name}
HTTP Method : GET
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
Parameter Order : name
▼ ▲ networkconnectivity.projects.locations.internalRanges.list
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges
Description : Lists InternalRanges in a given project and location.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Type : string
Description : The page token.
Location : query
orderBy
Type : string
Location : query
Description : Sort the results by a certain order.
pageSize
Type : integer
Format : int32
Description : The maximum number of results per page that should be returned.
Location : query
filter
Type : string
Location : query
Description : A filter expression that filters the results listed in the response.
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The parent resource's name.
Path : v1alpha1/{+parent}/internalRanges
HTTP Method : GET
▼ ▲ networkconnectivity.projects.locations.internalRanges.patch
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
Description : Updates the parameters of a single InternalRange.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha1/{+name}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The name of a InternalRange. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Required : Yes
Type : string
Location : path
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 t he 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
Description : Optional. Field mask is used to specify the fields to be overwritten in the InternalRange 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.
Format : google-fieldmask
Type : string
Parameter Order : name
▼ ▲ networkconnectivity.projects.locations.internalRanges.patch
HTTP Method : PATCH
Path : v1alpha1/{+name}
Parameter Order : name
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 t he 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
Type : string
Format : google-fieldmask
Location : query
Description : Optional. Field mask is used to specify the fields to be overwritten in the InternalRange 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
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Type : string
Description : Immutable. The name of a InternalRange. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single InternalRange.
▼ ▲ networkconnectivity.projects.locations.internalRanges.delete
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single InternalRange.
Parameter Order : name
Path : v1alpha1/{+name}
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 t he 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
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Location : path
Type : string
Description : Required. The name of the InternalRange to delete.
HTTP Method : DELETE
▼ ▲ networkconnectivity.projects.locations.internalRanges.create
Path : v1alpha1/{+parent}/internalRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
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 since the first request. For example, consider a situation where you make an initial request and t he 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
parent
Required : Yes
Type : string
Description : Required. The parent resource's name of the InternalRange.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
internalRangeId
Type : string
Location : query
Description : Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges
HTTP Method : POST
Description : Creates a new InternalRange in a given project and location.
Parameter Order : parent
▼ ▲ networkconnectivity.projects.locations.internalRanges.list
Parameter Order : parent
Description : Lists InternalRanges in a given project and location.
Path : v1alpha1/{+parent}/internalRanges
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Type : string
Description : Required. The parent resource's name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Type : integer
Description : The maximum number of results per page that should be returned.
Format : int32
Location : query
filter
Type : string
Location : query
Description : A filter expression that filters the results listed in the response.
orderBy
Location : query
Description : Sort the results by a certain order.
Type : string
pageToken
Type : string
Description : The page token.
Location : query
HTTP Method : GET
▼ ▲ networkconnectivity.projects.locations.internalRanges.get
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$
Location : path
Required : Yes
Description : Required. Name of the InternalRange to get.
HTTP Method : GET
Path : v1alpha1/{+name}
Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}
Description : Gets details of a single InternalRange.