2022-02-01
▼ ▲ compute.regionNetworks.getIamPolicy
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/regions/{region}/networks/{resource}/getIamPolicy
Parameter Order:
Parameters:
optionsRequestedPolicyVersion
Type: integer
Location: query
Description: Requested IAM Policy version.
Format: int32
resource
Type: string
Location: path
Required: Yes
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
region
Type: string
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Scopes:
Path: projects/{project}/regions/{region}/networks/{resource}/getIamPolicy
HTTP Method: GET
▼ ▲ compute.regionNetworks.list
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/networks
Scopes:
Path: projects/{project}/regions/{region}/networks
Description: Retrieves the list of networks available to the specified project in the given region.
Parameters:
returnPartialSuccess
Location: query
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
maxResults
Minimum: 0
Type: integer
Format: uint32
Location: query
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
Description: Name of the region scoping this request.
filter
Type: string
Location: query
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
pageToken
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Type: string
Location: query
project
Location: path
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Location: query
Type: string
Parameter Order:
▼ ▲ compute.regionNetworks.insert
Scopes:
Path: projects/{project}/regions/{region}/networks
Parameter Order:
Description: Creates a network in the specified project and region using the data included in the request.
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
Description: Project ID for this request.
requestId
Description: 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. 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
region
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
Flat Path: projects/{project}/regions/{region}/networks
HTTP Method: POST
▼ ▲ compute.regionNetworks.delete
Parameters:
requestId
Description: 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. 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
region
Location: path
Type: string
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
Location: path
network
Required: Yes
Description: Name of the network to delete.
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order:
Path: projects/{project}/regions/{region}/networks/{network}
Description: Deletes the specified network.
HTTP Method: DELETE
Scopes:
Flat Path: projects/{project}/regions/{region}/networks/{network}
▼ ▲ compute.regionNetworks.setIamPolicy
Path: projects/{project}/regions/{region}/networks/{resource}/setIamPolicy
Flat Path: projects/{project}/regions/{region}/networks/{resource}/setIamPolicy
HTTP Method: POST
Scopes:
Parameters:
resource
Required: Yes
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Type: string
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Location: path
Required: Yes
Type: string
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
Location: path
Description: The name of the region for this request.
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order:
▼ ▲ compute.regionNetworks.testIamPermissions
Path: projects/{project}/regions/{region}/networks/{resource}/testIamPermissions
Flat Path: projects/{project}/regions/{region}/networks/{resource}/testIamPermissions
Parameter Order:
Parameters:
region
Type: string
Description: The name of the region for this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
project
Location: path
Type: string
Required: Yes
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
resource
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Type: string
Required: Yes
Scopes:
Description: Returns permissions that a caller has on the specified resource.
HTTP Method: POST
▼ ▲ compute.regionNetworks.get
Parameters:
region
Type: string
Description: Name of the region scoping this request.
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
Type: string
Description: Project ID for this request.
network
Description: Name of the network to return.
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes:
Parameter Order:
Description: Returns the specified network.
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/networks/{network}
Path: projects/{project}/regions/{region}/networks/{network}
▼ ▲ compute.regionTargetHttpsProxies.patch
Parameters:
project
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Type: string
requestId
Type: string
Description: 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. 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
region
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region for this request.
targetHttpsProxy
Required: Yes
Description: Name of the TargetHttpsProxy resource to patch.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
HTTP Method: PATCH
Flat Path: projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Path: projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Scopes:
Description: Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Parameter Order:
▼ ▲ compute.regionNetworks.getIamPolicy
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path: projects/{project}/regions/{region}/networks/{resource}/getIamPolicy
Parameter Order:
Parameters:
optionsRequestedPolicyVersion
Type: integer
Location: query
Description: Requested IAM Policy version.
Format: int32
resource
Type: string
Location: path
Required: Yes
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
region
Type: string
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Scopes:
Path: projects/{project}/regions/{region}/networks/{resource}/getIamPolicy
HTTP Method: GET
▼ ▲ compute.regionNetworks.list
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/networks
Scopes:
Path: projects/{project}/regions/{region}/networks
Description: Retrieves the list of networks available to the specified project in the given region.
Parameters:
returnPartialSuccess
Location: query
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
maxResults
Minimum: 0
Type: integer
Format: uint32
Location: query
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
region
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
Description: Name of the region scoping this request.
filter
Type: string
Location: query
Description: A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
pageToken
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Type: string
Location: query
project
Location: path
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Location: query
Type: string
Parameter Order:
▼ ▲ compute.regionNetworks.insert
Scopes:
Path: projects/{project}/regions/{region}/networks
Parameter Order:
Description: Creates a network in the specified project and region using the data included in the request.
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
Description: Project ID for this request.
requestId
Description: 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. 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
region
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region scoping this request.
Required: Yes
Flat Path: projects/{project}/regions/{region}/networks
HTTP Method: POST
▼ ▲ compute.regionNetworks.delete
Parameters:
requestId
Description: 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. 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
region
Location: path
Type: string
Description: Name of the region scoping this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
Location: path
network
Required: Yes
Description: Name of the network to delete.
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order:
Path: projects/{project}/regions/{region}/networks/{network}
Description: Deletes the specified network.
HTTP Method: DELETE
Scopes:
Flat Path: projects/{project}/regions/{region}/networks/{network}
▼ ▲ compute.regionNetworks.setIamPolicy
Path: projects/{project}/regions/{region}/networks/{resource}/setIamPolicy
Flat Path: projects/{project}/regions/{region}/networks/{resource}/setIamPolicy
HTTP Method: POST
Scopes:
Parameters:
resource
Required: Yes
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Type: string
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Location: path
Required: Yes
Type: string
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
Location: path
Description: The name of the region for this request.
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order:
▼ ▲ compute.regionNetworks.testIamPermissions
Path: projects/{project}/regions/{region}/networks/{resource}/testIamPermissions
Flat Path: projects/{project}/regions/{region}/networks/{resource}/testIamPermissions
Parameter Order:
Parameters:
region
Type: string
Description: The name of the region for this request.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
project
Location: path
Type: string
Required: Yes
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
resource
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request.
Type: string
Required: Yes
Scopes:
Description: Returns permissions that a caller has on the specified resource.
HTTP Method: POST
▼ ▲ compute.regionNetworks.get
Parameters:
region
Type: string
Description: Name of the region scoping this request.
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
Type: string
Description: Project ID for this request.
network
Description: Name of the network to return.
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes:
Parameter Order:
Description: Returns the specified network.
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/networks/{network}
Path: projects/{project}/regions/{region}/networks/{network}
▼ ▲ compute.regionTargetHttpsProxies.patch
Parameters:
project
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Type: string
requestId
Type: string
Description: 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. 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
region
Required: Yes
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region for this request.
targetHttpsProxy
Required: Yes
Description: Name of the TargetHttpsProxy resource to patch.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
HTTP Method: PATCH
Flat Path: projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Path: projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Scopes:
Description: Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Parameter Order: