2022-03-19
▼ ▲ compute.securityPolicies.aggregatedList
Path : projects/{project}/aggregated/securityPolicies
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])?))
Type : string
Required : Yes
Location : path
Description : Name of the project scoping this request.
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type : boolean
Location : query
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
maxResults
Format : uint32
Minimum : 0
Location : query
Default : 500
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`)
Type : integer
pageToken
Type : string
Location : query
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.
filter
Location : query
Type : string
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) ```
orderBy
Type : string
Location : query
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.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/aggregated/securityPolicies
Parameter Order : project
Description : Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
▼ ▲ compute.regionSecurityPolicies.list
Description : List all the policies that have been configured for the specified project and region.
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
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
filter
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) ```
Location : query
Type : string
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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])?))
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location : query
Type : boolean
maxResults
Default : 500
Type : integer
Minimum : 0
Location : query
Format : uint32
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`)
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.
Type : string
Location : query
Flat Path : projects/{project}/regions/{region}/securityPolicies
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/securityPolicies
Parameter Order :
▼ ▲ compute.regionSecurityPolicies.get
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Location : path
Type : string
project
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.
Required : Yes
securityPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name of the security policy to get.
Scopes :
Parameter Order :
Description : List all of the ordered rules present in a single specified policy.
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.delete
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
HTTP Method : DELETE
Scopes :
Parameter Order :
Parameters :
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
securityPolicy
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the security policy to delete.
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
project
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
Required : Yes
Description : Project ID for this request.
Description : Deletes the specified policy.
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.patch
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Parameters :
project
Required : Yes
Description : Project ID for this request.
Type : string
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])?))
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
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
securityPolicy
Type : string
Description : Name of the security policy to update.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
HTTP Method : PATCH
Description : Patches the specified policy with the data included in the request.
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.insert
HTTP Method : POST
Path : projects/{project}/regions/{region}/securityPolicies
Parameter Order :
Parameters :
project
Location : path
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])?))
Type : string
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
validateOnly
Location : query
Description : If true, the request will not be committed.
Type : boolean
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).
Location : query
Type : string
Scopes :
Description : Creates a new policy in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/securityPolicies
▼ ▲ compute.networkEdgeSecurityServices.aggregatedList
Flat Path : projects/{project}/aggregated/networkEdgeSecurityServices
Scopes :
Parameter Order : project
Parameters :
filter
Location : query
Type : string
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) ```
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
Description : Name of the project scoping this request.
Location : path
Type : string
orderBy
Type : string
Location : query
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.
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
maxResults
Default : 500
Location : query
Minimum : 0
Format : uint32
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`)
Type : integer
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location : query
Type : boolean
pageToken
Location : query
Type : string
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.
Description : Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.
HTTP Method : GET
Path : projects/{project}/aggregated/networkEdgeSecurityServices
▼ ▲ compute.networkEdgeSecurityServices.patch
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
region
Description : Name of the region scoping this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
updateMask
Description : Indicates fields to be updated as part of this request.
Format : google-fieldmask
Type : string
Location : query
paths
Type : string
Location : query
Repeated : Yes
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).
Location : query
Type : string
networkEdgeSecurityService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the network edge security service to update.
Location : path
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
HTTP Method : PATCH
Parameter Order :
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Scopes :
Description : Patches the specified policy with the data included in the request.
▼ ▲ compute.networkEdgeSecurityServices.insert
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
HTTP Method : POST
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
Parameters :
region
Type : string
Description : Name of the region scoping this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Location : query
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
project
Description : Project ID for this request.
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
Required : Yes
validateOnly
Description : If true, the request will not be committed.
Type : boolean
Location : query
Scopes :
Description : Creates a new service in the specified project using the data included in the request.
Parameter Order :
▼ ▲ compute.networkEdgeSecurityServices.delete
Scopes :
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Parameter Order :
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
networkEdgeSecurityService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the network edge security service to delete.
Type : string
Required : Yes
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
Description : Project ID for this request.
Type : string
Location : path
requestId
Location : query
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).
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
HTTP Method : DELETE
Description : Deletes the specified service.
▼ ▲ compute.networkEdgeSecurityServices.get
Parameters :
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : Name of the region scoping this request.
project
Required : Yes
Type : string
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
networkEdgeSecurityService
Type : string
Location : path
Required : Yes
Description : Name of the network edge security service to get.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Description : Gets a specified NetworkEdgeSecurityService.
Scopes :
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
HTTP Method : GET
Parameter Order :
▼ ▲ compute.regionTargetHttpsProxies.patch
HTTP Method : PATCH
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 :
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Scopes :
Parameters :
project
Location : path
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
Type : string
targetHttpsProxy
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Name of the TargetHttpsProxy resource to patch.
requestId
Location : query
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).
region
Description : Name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes