Reference documentation and code samples for the Compute V1 Client class RegionNetworkFirewallPoliciesClient.
Service Description: The RegionNetworkFirewallPolicies API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$firewallPolicyAssociationResource = new FirewallPolicyAssociation();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'addAssociation');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
Methods
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the {@see} method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
addAssociation
Inserts an association for the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$firewallPolicyAssociationResource = new FirewallPolicyAssociation();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'addAssociation');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
firewallPolicyAssociationResource |
Google\Cloud\Compute\V1\FirewallPolicyAssociation
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ replaceExistingAssociation |
bool
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. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
addRule
Inserts a rule into a network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$firewallPolicyRuleResource = new FirewallPolicyRule();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->addRule($firewallPolicy, $firewallPolicyRuleResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->addRule($firewallPolicy, $firewallPolicyRuleResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'addRule');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
firewallPolicyRuleResource |
Google\Cloud\Compute\V1\FirewallPolicyRule
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ maxPriority |
int
When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority. |
↳ minPriority |
int
When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
cloneRules
Copies rules to the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->cloneRules($firewallPolicy, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->cloneRules($firewallPolicy, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'cloneRules');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
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). |
↳ sourceFirewallPolicy |
string
The firewall policy from which to copy rules. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
delete
Deletes the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->delete($firewallPolicy, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->delete($firewallPolicy, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'delete');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to delete. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
get
Returns the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$response = $regionNetworkFirewallPoliciesClient->get($firewallPolicy, $project, $region);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to get. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\FirewallPolicy | |
getAssociation
Gets an association with the specified name.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$response = $regionNetworkFirewallPoliciesClient->getAssociation($firewallPolicy, $project, $region);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to which the queried association belongs. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ name |
string
The name of the association to get from the firewall policy. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\FirewallPolicyAssociation | |
getEffectiveFirewalls
Returns the effective firewalls on a given network.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$network = 'network';
$project = 'project';
$region = 'region';
$response = $regionNetworkFirewallPoliciesClient->getEffectiveFirewalls($network, $project, $region);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
network |
string
Network reference |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse | |
getIamPolicy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$project = 'project';
$region = 'region';
$resource = 'resource';
$response = $regionNetworkFirewallPoliciesClient->getIamPolicy($project, $region, $resource);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
region |
string
The name of the region for this request. |
resource |
string
Name or id of the resource for this request. |
optionalArgs |
array
Optional. |
↳ optionsRequestedPolicyVersion |
int
Requested IAM Policy version. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Policy | |
getRule
Gets a rule of the specified priority.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$response = $regionNetworkFirewallPoliciesClient->getRule($firewallPolicy, $project, $region);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to which the queried rule belongs. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ priority |
int
The priority of the rule to get from the firewall policy. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\FirewallPolicyRule | |
insert
Creates a new network firewall policy in the specified project and region.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicyResource = new FirewallPolicy();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->insert($firewallPolicyResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->insert($firewallPolicyResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'insert');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicyResource |
Google\Cloud\Compute\V1\FirewallPolicy
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
list
Lists all the network firewall policies that have been configured for the specified project in the given region.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$project = 'project';
$region = 'region';
// Iterate over pages of elements
$pagedResponse = $regionNetworkFirewallPoliciesClient->list($project, $region);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $regionNetworkFirewallPoliciesClient->list($project, $region);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your 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 |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
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 |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
patch
Patches the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$firewallPolicyResource = new FirewallPolicy();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->patch($firewallPolicy, $firewallPolicyResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->patch($firewallPolicy, $firewallPolicyResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'patch');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
firewallPolicyResource |
Google\Cloud\Compute\V1\FirewallPolicy
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
patchRule
Patches a rule of the specified priority.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$firewallPolicyRuleResource = new FirewallPolicyRule();
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->patchRule($firewallPolicy, $firewallPolicyRuleResource, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->patchRule($firewallPolicy, $firewallPolicyRuleResource, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'patchRule');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
firewallPolicyRuleResource |
Google\Cloud\Compute\V1\FirewallPolicyRule
The body resource for this request |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ priority |
int
The priority of the rule to patch. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
removeAssociation
Removes an association for the specified network firewall policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->removeAssociation($firewallPolicy, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->removeAssociation($firewallPolicy, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'removeAssociation');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ name |
string
Name for the association that will be removed. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
removeRule
Deletes a rule of the specified priority.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$firewallPolicy = 'firewall_policy';
$project = 'project';
$region = 'region';
$operationResponse = $regionNetworkFirewallPoliciesClient->removeRule($firewallPolicy, $project, $region);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $regionNetworkFirewallPoliciesClient->removeRule($firewallPolicy, $project, $region);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $regionNetworkFirewallPoliciesClient->resumeOperation($operationName, 'removeRule');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
firewallPolicy |
string
Name of the firewall policy to update. |
project |
string
Project ID for this request. |
region |
string
Name of the region scoping this request. |
optionalArgs |
array
Optional. |
↳ priority |
int
The priority of the rule to remove from the firewall policy. |
↳ requestId |
string
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$project = 'project';
$region = 'region';
$regionSetPolicyRequestResource = new RegionSetPolicyRequest();
$resource = 'resource';
$response = $regionNetworkFirewallPoliciesClient->setIamPolicy($project, $region, $regionSetPolicyRequestResource, $resource);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
region |
string
The name of the region for this request. |
regionSetPolicyRequestResource |
Google\Cloud\Compute\V1\RegionSetPolicyRequest
The body resource for this request |
resource |
string
Name or id of the resource for this request. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Policy | |
testIamPermissions
Returns permissions that a caller has on the specified resource.
Sample code:
$regionNetworkFirewallPoliciesClient = new RegionNetworkFirewallPoliciesClient();
try {
$project = 'project';
$region = 'region';
$resource = 'resource';
$testPermissionsRequestResource = new TestPermissionsRequest();
$response = $regionNetworkFirewallPoliciesClient->testIamPermissions($project, $region, $resource, $testPermissionsRequestResource);
} finally {
$regionNetworkFirewallPoliciesClient->close();
}
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
region |
string
The name of the region for this request. |
resource |
string
Name or id of the resource for this request. |
testPermissionsRequestResource |
Google\Cloud\Compute\V1\TestPermissionsRequest
The body resource for this request |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\TestPermissionsResponse | |
Constants
SERVICE_NAME
Value: 'google.cloud.compute.v1.RegionNetworkFirewallPolicies'The name of the service.
SERVICE_ADDRESS
Value: 'compute.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.