Compute V1 Client - Class FirewallPoliciesClient (1.8.3)

Reference documentation and code samples for the Compute V1 Client class FirewallPoliciesClient.

Service Description: The FirewallPolicies 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:

$firewallPoliciesClient = new FirewallPoliciesClient();
try {
    $firewallPolicy = 'firewall_policy';
    $firewallPolicyAssociationResource = new FirewallPolicyAssociation();
    $operationResponse = $firewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource);
    $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 = $firewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $firewallPoliciesClient->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 {
    $firewallPoliciesClient->close();
}

Methods

getOperationsClient

Return an GlobalOrganizationOperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\Cloud\Compute\V1\GlobalOrganizationOperationsClient`

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 Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper 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 Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ 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 `rest`. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ 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 Google\ApiCore\Transport\RestTransport::build() 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 firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`firewallPolicyAssociationResource`	`Google\Cloud\Compute\V1\FirewallPolicyAssociation` The body resource for this request
`optionalArgs`	`array` Optional.
`↳ replaceExistingAssociation`	`bool` 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.
`↳ 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicyAssociation;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function add_association_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $firewallPolicyAssociationResource = new FirewallPolicyAssociation();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->addAssociation(
            $firewallPolicy,
            $firewallPolicyAssociationResource
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    add_association_sample($firewallPolicy);
}

addRule

Inserts a rule into a firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`firewallPolicyRuleResource`	`Google\Cloud\Compute\V1\FirewallPolicyRule` The body resource for 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicyRule;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function add_rule_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $firewallPolicyRuleResource = new FirewallPolicyRule();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->addRule($firewallPolicy, $firewallPolicyRuleResource);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    add_rule_sample($firewallPolicy);
}

cloneRules

Copies rules to the specified firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function clone_rules_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->cloneRules($firewallPolicy);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    clone_rules_sample($firewallPolicy);
}

delete

Deletes the specified policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to delete.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to delete.
 */
function delete_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->delete($firewallPolicy);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    delete_sample($firewallPolicy);
}

get

Returns the specified firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to get.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\FirewallPolicy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicy;

/**
 * @param string $firewallPolicy Name of the firewall policy to get.
 */
function get_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicy $response */
        $response = $firewallPoliciesClient->get($firewallPolicy);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    get_sample($firewallPolicy);
}

getAssociation

Gets an association with the specified name.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to which the queried rule belongs.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\FirewallPolicyAssociation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicyAssociation;

/**
 * @param string $firewallPolicy Name of the firewall policy to which the queried rule belongs.
 */
function get_association_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicyAssociation $response */
        $response = $firewallPoliciesClient->getAssociation($firewallPolicy);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    get_association_sample($firewallPolicy);
}

getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\Policy;

/**
 * @param string $resource Name or id of the resource for this request.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $firewallPoliciesClient->getIamPolicy($resource);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

getRule

Gets a rule of the specified priority.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to which the queried rule belongs.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\FirewallPolicyRule`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicyRule;

/**
 * @param string $firewallPolicy Name of the firewall policy to which the queried rule belongs.
 */
function get_rule_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicyRule $response */
        $response = $firewallPoliciesClient->getRule($firewallPolicy);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    get_rule_sample($firewallPolicy);
}

insert

Creates a new policy in the specified project using the data included in the request.

Parameters
Name	Description
`firewallPolicyResource`	`Google\Cloud\Compute\V1\FirewallPolicy` The body resource for this request
`parentId`	`string` Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicy;
use Google\Rpc\Status;

/**
 * @param string $parentId Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
 */
function insert_sample(string $parentId): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $firewallPolicyResource = new FirewallPolicy();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->insert($firewallPolicyResource, $parentId);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parentId = '[PARENT_ID]';

    insert_sample($parentId);
}

list

Lists all the policies that have been configured for the specified folder or organization.

Parameters
Name	Description
`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 `=`, `!=`, `>`, `<`, `<=`, `>=` 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)` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
`↳ maxResults`	`int` 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`	`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 `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.
`↳ 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.
`↳ parentId`	`string` Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
`↳ 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_sample(): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $firewallPoliciesClient->list();

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listAssociations

Lists associations of a specified target, i.e., organization or folder.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ targetResource`	`string` The target resource to list associations. It is an organization, or a folder.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\FirewallPoliciesListAssociationsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPoliciesListAssociationsResponse;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_associations_sample(): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPoliciesListAssociationsResponse $response */
        $response = $firewallPoliciesClient->listAssociations();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

move

Moves the specified firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`parentId`	`string` The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 * @param string $parentId       The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
 */
function move_sample(string $firewallPolicy, string $parentId): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->move($firewallPolicy, $parentId);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';
    $parentId = '[PARENT_ID]';

    move_sample($firewallPolicy, $parentId);
}

patch

Patches the specified policy with the data included in the request.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`firewallPolicyResource`	`Google\Cloud\Compute\V1\FirewallPolicy` The body resource for 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicy;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function patch_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $firewallPolicyResource = new FirewallPolicy();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->patch($firewallPolicy, $firewallPolicyResource);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    patch_sample($firewallPolicy);
}

patchRule

Patches a rule of the specified priority.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`firewallPolicyRuleResource`	`Google\Cloud\Compute\V1\FirewallPolicyRule` The body resource for 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\FirewallPolicyRule;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function patch_rule_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $firewallPolicyRuleResource = new FirewallPolicyRule();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->patchRule($firewallPolicy, $firewallPolicyRuleResource);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    patch_rule_sample($firewallPolicy);
}

removeAssociation

Removes an association for the specified firewall policy.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`optionalArgs`	`array` Optional.
`↳ name`	`string` Name for the attachment 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function remove_association_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->removeAssociation($firewallPolicy);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    remove_association_sample($firewallPolicy);
}

removeRule

Deletes a rule of the specified priority.

Parameters
Name	Description
`firewallPolicy`	`string` Name of the firewall policy to update.
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Rpc\Status;

/**
 * @param string $firewallPolicy Name of the firewall policy to update.
 */
function remove_rule_sample(string $firewallPolicy): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallPoliciesClient->removeRule($firewallPolicy);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $firewallPolicy = '[FIREWALL_POLICY]';

    remove_rule_sample($firewallPolicy);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
`globalOrganizationSetPolicyRequestResource`	`Google\Cloud\Compute\V1\GlobalOrganizationSetPolicyRequest` 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\GlobalOrganizationSetPolicyRequest;
use Google\Cloud\Compute\V1\Policy;

/**
 * @param string $resource Name or id of the resource for this request.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $globalOrganizationSetPolicyRequestResource = new GlobalOrganizationSetPolicyRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $firewallPoliciesClient->setIamPolicy(
            $globalOrganizationSetPolicyRequestResource,
            $resource
        );
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\TestPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\FirewallPoliciesClient;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

/**
 * @param string $resource Name or id of the resource for this request.
 */
function test_iam_permissions_sample(string $resource): void
{
    // Create a client.
    $firewallPoliciesClient = new FirewallPoliciesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $testPermissionsRequestResource = new TestPermissionsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $firewallPoliciesClient->testIamPermissions($resource, $testPermissionsRequestResource);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    test_iam_permissions_sample($resource);
}

Constants

SERVICE_NAME

Value: 'google.cloud.compute.v1.FirewallPolicies'

The name of the service.

SERVICE_ADDRESS

Value: 'compute.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.