2022-02-15
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
HTTP Method : POST
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Parameters :
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
Type : string
Description : Project ID for this request.
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])?))
region
Required : Yes
Location : path
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Description : Patches the specified network firewall policy.
Scopes :
Parameters :
firewallPolicy
Type : string
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
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])?))
Description : Project ID for this request.
Required : Yes
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
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method : PATCH
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Scopes :
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Type : integer
Location : query
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name or id of the resource for this request.
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request.
HTTP Method : GET
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Description : Copies rules to the specified network firewall policy.
Parameter Order :
Parameters :
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
project
Location : path
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])?))
Description : Project ID for this request.
Type : string
firewallPolicy
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
sourceFirewallPolicy
Location : query
Type : string
Description : The firewall policy from which to copy rules.
Scopes :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
▼ ▲ compute.regionNetworkFirewallPolicies.delete
Parameter Order :
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters :
project
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
Location : path
Type : string
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
firewallPolicy
Location : path
Description : Name of the firewall policy to delete.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Deletes the specified network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Scopes :
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
resource
Description : Name or id of the resource for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
region
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Scopes :
HTTP Method : POST
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
HTTP Method : POST
Description : Patches a rule of the specified priority.
Parameter Order :
Parameters :
firewallPolicy
Required : Yes
Description : Name of the firewall policy to update.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required : Yes
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])?))
priority
Type : integer
Description : The priority of the rule to patch.
Location : query
Format : int32
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
region
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Scopes :
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Description : Gets an association with the specified name.
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Parameters :
region
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
name
Location : query
Description : The name of the association to get from the firewall policy.
Type : string
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])?))
firewallPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to which the queried association belongs.
Required : Yes
Location : path
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Flat Path : projects/{project}/regions/{region}/firewallPolicies
Path : projects/{project}/regions/{region}/firewallPolicies
HTTP Method : POST
Scopes :
Description : Creates a new network firewall policy in the specified project and region.
Parameters :
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
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])?
project
Type : string
Description : Project ID for this request.
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])?))
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Parameter Order :
Description : Deletes a rule of the specified priority.
Parameters :
project
Location : path
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.
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region scoping this request.
requestId
Type : string
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).
priority
Description : The priority of the rule to remove from the firewall policy.
Location : query
Format : int32
Type : integer
firewallPolicy
Type : string
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method : POST
▼ ▲ compute.regionNetworkFirewallPolicies.get
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method : GET
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region scoping this request.
Required : Yes
firewallPolicy
Type : string
Required : Yes
Description : Name of the firewall policy to get.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Location : path
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.
Scopes :
Parameter Order :
Description : Returns the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.list
HTTP Method : GET
Path : projects/{project}/regions/{region}/firewallPolicies
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies
Scopes :
Parameters :
maxResults
Minimum : 0
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
Type : integer
Location : query
Format : uint32
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) ```
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.
returnPartialSuccess
Type : boolean
Location : query
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
project
Required : Yes
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
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
pageToken
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.
Type : string
Description : Lists all the network firewall policies that have been configured for the specified project in the given region.
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Scopes :
Description : Removes an association for the specified network firewall policy.
Parameters :
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
name
Location : query
Description : Name for the association that will be removed.
Type : string
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
firewallPolicy
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region scoping this request.
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Parameter Order :
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])?))
Required : Yes
Location : path
Type : string
Description : Project ID for this request.
priority
Format : int32
Type : integer
Description : The priority of the rule to get from the firewall policy.
Location : query
firewallPolicy
Description : Name of the firewall policy to which the queried rule belongs.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Description : Name of the region scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Scopes :
HTTP Method : GET
Description : Gets a rule of the specified priority.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Description : Inserts an association for the specified network firewall policy.
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Parameters :
replaceExistingAssociation
Location : query
Description : Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.
Type : boolean
firewallPolicy
Description : Name of the firewall policy to update.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
requestId
Type : string
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).
project
Required : Yes
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])?))
Location : path
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Scopes :
Parameters :
maxPriority
Type : integer
Location : query
Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Format : int32
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
minPriority
Location : query
Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Type : integer
Format : int32
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Type : string
project
Type : string
Description : Project ID for this request.
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])?))
firewallPolicy
Type : string
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
HTTP Method : POST
Description : Inserts a rule into a network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Scopes :
Description : Returns the effective firewalls on a given network.
Parameters :
region
Required : Yes
Location : path
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
Required : Yes
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])?))
network
Type : string
Required : Yes
Location : query
Description : Network reference
Flat Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Parameter Order :
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.insert
Parameter Order : project
Path : projects/{project}/global/firewallPolicies
Parameters :
project
Required : Yes
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])?))
Type : string
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
Description : Creates a new policy in the specified project using the data included in the request.
Flat Path : projects/{project}/global/firewallPolicies
Scopes :
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.getAssociation
Scopes :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Parameter Order :
Parameters :
firewallPolicy
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to which the queried association belongs.
Type : string
name
Location : query
Type : string
Description : The name of the association to get from the firewall policy.
project
Type : string
Location : path
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])?))
Description : Project ID for this request.
HTTP Method : GET
Description : Gets an association with the specified name.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.networkFirewallPolicies.get
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Description : Returns the specified network firewall policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes :
Parameters :
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])?))
Description : Project ID for this request.
Location : path
Type : string
firewallPolicy
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the firewall policy to get.
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.removeRule
Parameters :
priority
Description : The priority of the rule to remove from the firewall policy.
Location : query
Format : int32
Type : integer
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
project
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
Location : path
firewallPolicy
Description : Name of the firewall policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Parameter Order :
HTTP Method : POST
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Scopes :
Description : Deletes a rule of the specified priority.
▼ ▲ compute.networkFirewallPolicies.patch
Scopes :
Description : Patches the specified policy with the data included in the request.
Parameters :
firewallPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the firewall policy to update.
Location : path
project
Required : Yes
Type : string
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])?))
requestId
Type : string
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).
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method : PATCH
Parameter Order :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
▼ ▲ compute.networkFirewallPolicies.delete
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes :
Parameters :
firewallPolicy
Description : Name of the firewall policy to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
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
Type : string
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])?))
Description : Project ID for this request.
Description : Deletes the specified policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.networkFirewallPolicies.patchRule
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameters :
firewallPolicy
Description : Name of the firewall policy to update.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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).
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.
Location : path
Type : string
priority
Description : The priority of the rule to patch.
Location : query
Format : int32
Type : integer
HTTP Method : POST
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order :
Description : Patches a rule of the specified priority.
Scopes :
▼ ▲ compute.networkFirewallPolicies.getRule
Parameter Order :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Description : Gets a rule of the specified priority.
Parameters :
firewallPolicy
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the firewall policy to which the queried rule belongs.
project
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])?))
Location : path
Required : Yes
priority
Description : The priority of the rule to get from the firewall policy.
Type : integer
Format : int32
Location : query
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Scopes :
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.cloneRules
Parameters :
sourceFirewallPolicy
Location : query
Type : string
Description : The firewall policy from which to copy rules.
project
Description : Project ID for this request.
Location : path
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
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).
firewallPolicy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Required : Yes
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Parameter Order :
Scopes :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
HTTP Method : POST
Description : Copies rules to the specified firewall policy.
▼ ▲ compute.networkFirewallPolicies.addAssociation
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Parameters :
replaceExistingAssociation
Location : query
Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Type : boolean
project
Type : string
Description : Project ID for this request.
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])?))
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).
firewallPolicy
Type : string
Description : Name of the firewall policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Scopes :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Parameter Order :
Description : Inserts an association for the specified firewall policy.
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Parameters :
project
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Description : Name or id of the resource for this request.
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Scopes :
Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Flat Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Flat Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Parameter Order :
Scopes :
Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
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
optionsRequestedPolicyVersion
Location : query
Type : integer
Format : int32
Description : Requested IAM Policy version.
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
▼ ▲ compute.networkFirewallPolicies.addRule
Description : Inserts a rule into a firewall policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Parameter Order :
Scopes :
Parameters :
firewallPolicy
Type : string
Description : Name of the firewall policy to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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).
minPriority
Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location : query
Type : integer
Format : int32
maxPriority
Type : integer
Description : When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
Location : query
Format : int32
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.list
HTTP Method : GET
Path : projects/{project}/global/firewallPolicies
Description : Lists all the policies that have been configured for the specified project.
Parameters :
project
Required : Yes
Type : string
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])?))
filter
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) ```
Type : string
maxResults
Format : uint32
Default : 500
Type : integer
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`)
Location : query
Minimum : 0
returnPartialSuccess
Location : query
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type : boolean
orderBy
Type : string
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
pageToken
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.
Location : query
Flat Path : projects/{project}/global/firewallPolicies
Parameter Order : project
Scopes :
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Parameter Order :
Scopes :
Description : Removes an association for the specified firewall policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameters :
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
firewallPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Location : path
Required : Yes
name
Location : query
Description : Name for the attachment that will be removed.
Type : string
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
HTTP Method : POST
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation