<?php
/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * GENERATED CODE WARNING
 * Generated by gapic-generator-php from the file
 * https://github.com/google/googleapis/blob/master/google/cloud/compute/v1/compute.proto
 * Updates to the above are reflected here through a refresh process.
 */

namespace Google\Cloud\Compute\V1\Gapic;

use Google\ApiCore\ApiException;
use Google\ApiCore\CredentialsWrapper;

use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\RequestParamsHeaderDescriptor;
use Google\ApiCore\RetrySettings;
use Google\ApiCore\Transport\TransportInterface;
use Google\ApiCore\ValidationException;
use Google\Auth\FetchAuthTokenInterface;
use Google\Cloud\Compute\V1\AddAssociationFirewallPolicyRequest;
use Google\Cloud\Compute\V1\AddRuleFirewallPolicyRequest;
use Google\Cloud\Compute\V1\CloneRulesFirewallPolicyRequest;
use Google\Cloud\Compute\V1\DeleteFirewallPolicyRequest;
use Google\Cloud\Compute\V1\FirewallPoliciesListAssociationsResponse;
use Google\Cloud\Compute\V1\FirewallPolicy;
use Google\Cloud\Compute\V1\FirewallPolicyAssociation;
use Google\Cloud\Compute\V1\FirewallPolicyList;
use Google\Cloud\Compute\V1\FirewallPolicyRule;
use Google\Cloud\Compute\V1\GetAssociationFirewallPolicyRequest;
use Google\Cloud\Compute\V1\GetFirewallPolicyRequest;
use Google\Cloud\Compute\V1\GetIamPolicyFirewallPolicyRequest;
use Google\Cloud\Compute\V1\GetRuleFirewallPolicyRequest;
use Google\Cloud\Compute\V1\GlobalOrganizationSetPolicyRequest;
use Google\Cloud\Compute\V1\InsertFirewallPolicyRequest;
use Google\Cloud\Compute\V1\ListAssociationsFirewallPolicyRequest;
use Google\Cloud\Compute\V1\ListFirewallPoliciesRequest;
use Google\Cloud\Compute\V1\MoveFirewallPolicyRequest;
use Google\Cloud\Compute\V1\Operation;
use Google\Cloud\Compute\V1\PatchFirewallPolicyRequest;
use Google\Cloud\Compute\V1\PatchRuleFirewallPolicyRequest;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\RemoveAssociationFirewallPolicyRequest;
use Google\Cloud\Compute\V1\RemoveRuleFirewallPolicyRequest;
use Google\Cloud\Compute\V1\SetIamPolicyFirewallPolicyRequest;
use Google\Cloud\Compute\V1\TestIamPermissionsFirewallPolicyRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

/**
 * 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();
 *     $response = $firewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource);
 * } finally {
 *     $firewallPoliciesClient->close();
 * }
 * ```
 */
class FirewallPoliciesGapicClient
{
    use GapicClientTrait;

    /**
     * The name of the service.
     */
    const SERVICE_NAME = 'google.cloud.compute.v1.FirewallPolicies';

    /**
     * The default address of the service.
     */
    const SERVICE_ADDRESS = 'compute.googleapis.com';

    /**
     * The default port of the service.
     */
    const DEFAULT_SERVICE_PORT = 443;

    /**
     * The name of the code generator, to be included in the agent header.
     */
    const CODEGEN_NAME = 'gapic';

    /**
     * The default scopes required by the service.
     */
    public static $serviceScopes = [
        'https://www.googleapis.com/auth/compute',
        'https://www.googleapis.com/auth/cloud-platform',
    ];

    private static function getClientDefaults()
    {
        return [
            'serviceName' => self::SERVICE_NAME,
            'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
            'clientConfig' => __DIR__ . '/../resources/firewall_policies_client_config.json',
            'descriptorsConfigPath' => __DIR__ . '/../resources/firewall_policies_descriptor_config.php',
            'credentialsConfig' => [
                'defaultScopes' => self::$serviceScopes,
                'useJwtAccessWithScope' => false,
            ],
            'transportConfig' => [
                'rest' => [
                    'restClientConfigPath' => __DIR__ . '/../resources/firewall_policies_rest_client_config.php',
                ],
            ],
        ];
    }

    /**
     * Implements GapicClientTrait::defaultTransport.
     */
    private static function defaultTransport()
    {
        return 'rest';
    }

    /**
     * Implements GapicClientTrait::getSupportedTransports.
     */
    private static function getSupportedTransports()
    {
        return [
            'rest',
        ];
    }

    /**
     * Constructor.
     *
     * @param array $options {
     *     Optional. Options for configuring the service API wrapper.
     *
     *     @type string $serviceAddress
     *           **Deprecated**. This option will be removed in a future major release. Please
     *           utilize the `$apiEndpoint` option instead.
     *     @type string $apiEndpoint
     *           The address of the API remote host. May optionally include the port, formatted
     *           as "<uri>:<port>". Default 'compute.googleapis.com:443'.
     *     @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
     *           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 \Google\Auth\FetchAuthTokenInterface} object or
     *           {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these
     *           objects are provided, any settings in $credentialsConfig will be ignored.
     *     @type array $credentialsConfig
     *           Options used to configure credentials, including auth token caching, for the
     *           client. For a full list of supporting configuration options, see
     *           {@see \Google\ApiCore\CredentialsWrapper::build()} .
     *     @type bool $disableRetries
     *           Determines whether or not retries defined by the client configuration should be
     *           disabled. Defaults to `false`.
     *     @type string|array $clientConfig
     *           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.
     *     @type string|TransportInterface $transport
     *           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 {@see \Google\ApiCore\Transport\TransportInterface} object. Note
     *           that when this object is provided, any settings in $transportConfig, and any
     *           $serviceAddress setting, will be ignored.
     *     @type array $transportConfig
     *           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 \Google\ApiCore\Transport\RestTransport::build()} method for the
     *           supported options.
     *     @type callable $clientCertSource
     *           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.
     * }
     *
     * @throws ValidationException
     */
    public function __construct(array $options = [])
    {
        $clientOptions = $this->buildClientOptions($options);
        $this->setClientOptions($clientOptions);
    }

    /**
     * Inserts an association for the specified firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $firewallPolicyAssociationResource = new FirewallPolicyAssociation();
     *     $response = $firewallPoliciesClient->addAssociation($firewallPolicy, $firewallPolicyAssociationResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string                    $firewallPolicy                    Name of the firewall policy to update.
     * @param FirewallPolicyAssociation $firewallPolicyAssociationResource The body resource for this request
     * @param array                     $optionalArgs                      {
     *     Optional.
     *
     *     @type bool $replaceExistingAssociation
     *           Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function addAssociation($firewallPolicy, $firewallPolicyAssociationResource, array $optionalArgs = [])
    {
        $request = new AddAssociationFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $request->setFirewallPolicyAssociationResource($firewallPolicyAssociationResource);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['replaceExistingAssociation'])) {
            $request->setReplaceExistingAssociation($optionalArgs['replaceExistingAssociation']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('AddAssociation', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Inserts a rule into a firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $firewallPolicyRuleResource = new FirewallPolicyRule();
     *     $response = $firewallPoliciesClient->addRule($firewallPolicy, $firewallPolicyRuleResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string             $firewallPolicy             Name of the firewall policy to update.
     * @param FirewallPolicyRule $firewallPolicyRuleResource The body resource for this request
     * @param array              $optionalArgs               {
     *     Optional.
     *
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function addRule($firewallPolicy, $firewallPolicyRuleResource, array $optionalArgs = [])
    {
        $request = new AddRuleFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $request->setFirewallPolicyRuleResource($firewallPolicyRuleResource);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('AddRule', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Copies rules to the specified firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->cloneRules($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to update.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type string $sourceFirewallPolicy
     *           The firewall policy from which to copy rules.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function cloneRules($firewallPolicy, array $optionalArgs = [])
    {
        $request = new CloneRulesFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        if (isset($optionalArgs['sourceFirewallPolicy'])) {
            $request->setSourceFirewallPolicy($optionalArgs['sourceFirewallPolicy']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('CloneRules', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Deletes the specified policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->delete($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to delete.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function delete($firewallPolicy, array $optionalArgs = [])
    {
        $request = new DeleteFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('Delete', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Returns the specified firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->get($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to get.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\FirewallPolicy
     *
     * @throws ApiException if the remote call fails
     */
    public function get($firewallPolicy, array $optionalArgs = [])
    {
        $request = new GetFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('Get', FirewallPolicy::class, $optionalArgs, $request)->wait();
    }

    /**
     * Gets an association with the specified name.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->getAssociation($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to which the queried rule belongs.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type string $name
     *           The name of the association to get from the firewall policy.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\FirewallPolicyAssociation
     *
     * @throws ApiException if the remote call fails
     */
    public function getAssociation($firewallPolicy, array $optionalArgs = [])
    {
        $request = new GetAssociationFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['name'])) {
            $request->setName($optionalArgs['name']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('GetAssociation', FirewallPolicyAssociation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Gets the access control policy for a resource. May be empty if no such policy or resource exists.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $resource = 'resource';
     *     $response = $firewallPoliciesClient->getIamPolicy($resource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $resource     Name or id of the resource for this request.
     * @param array  $optionalArgs {
     *     Optional.
     *
     *     @type int $optionsRequestedPolicyVersion
     *           Requested IAM Policy version.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Policy
     *
     * @throws ApiException if the remote call fails
     */
    public function getIamPolicy($resource, array $optionalArgs = [])
    {
        $request = new GetIamPolicyFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setResource($resource);
        $requestParamHeaders['resource'] = $resource;
        if (isset($optionalArgs['optionsRequestedPolicyVersion'])) {
            $request->setOptionsRequestedPolicyVersion($optionalArgs['optionsRequestedPolicyVersion']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('GetIamPolicy', Policy::class, $optionalArgs, $request)->wait();
    }

    /**
     * Gets a rule of the specified priority.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->getRule($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to which the queried rule belongs.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type int $priority
     *           The priority of the rule to get from the firewall policy.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\FirewallPolicyRule
     *
     * @throws ApiException if the remote call fails
     */
    public function getRule($firewallPolicy, array $optionalArgs = [])
    {
        $request = new GetRuleFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['priority'])) {
            $request->setPriority($optionalArgs['priority']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('GetRule', FirewallPolicyRule::class, $optionalArgs, $request)->wait();
    }

    /**
     * Creates a new policy in the specified project using the data included in the request.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicyResource = new FirewallPolicy();
     *     $response = $firewallPoliciesClient->insert($firewallPolicyResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param FirewallPolicy $firewallPolicyResource The body resource for this request
     * @param array          $optionalArgs           {
     *     Optional.
     *
     *     @type 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.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function insert($firewallPolicyResource, array $optionalArgs = [])
    {
        $request = new InsertFirewallPolicyRequest();
        $request->setFirewallPolicyResource($firewallPolicyResource);
        if (isset($optionalArgs['parentId'])) {
            $request->setParentId($optionalArgs['parentId']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        return $this->startCall('Insert', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Lists all the policies that have been configured for the specified project.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     // Iterate over pages of elements
     *     $pagedResponse = $firewallPoliciesClient->list();
     *     foreach ($pagedResponse->iteratePages() as $page) {
     *         foreach ($page as $element) {
     *             // doSomethingWith($element);
     *         }
     *     }
     *     // Alternatively:
     *     // Iterate through all elements
     *     $pagedResponse = $firewallPoliciesClient->list();
     *     foreach ($pagedResponse->iterateAllElements() as $element) {
     *         // doSomethingWith($element);
     *     }
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param array $optionalArgs {
     *     Optional.
     *
     *     @type string $filter
     *           A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`.
     *
     *           You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
     *
     *           To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
     *     @type int $maxResults
     *           The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
     *     @type string $orderBy
     *           Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
     *
     *           You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
     *
     *           Currently, only sorting by `name` or `creationTimestamp desc` is supported.
     *     @type string $pageToken
     *           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.
     *     @type string $parentId
     *           Parent ID for this request.
     *     @type bool $returnPartialSuccess
     *           Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\ApiCore\PagedListResponse
     *
     * @throws ApiException if the remote call fails
     */
    public function list(array $optionalArgs = [])
    {
        $request = new ListFirewallPoliciesRequest();
        if (isset($optionalArgs['filter'])) {
            $request->setFilter($optionalArgs['filter']);
        }

        if (isset($optionalArgs['maxResults'])) {
            $request->setMaxResults($optionalArgs['maxResults']);
        }

        if (isset($optionalArgs['orderBy'])) {
            $request->setOrderBy($optionalArgs['orderBy']);
        }

        if (isset($optionalArgs['pageToken'])) {
            $request->setPageToken($optionalArgs['pageToken']);
        }

        if (isset($optionalArgs['parentId'])) {
            $request->setParentId($optionalArgs['parentId']);
        }

        if (isset($optionalArgs['returnPartialSuccess'])) {
            $request->setReturnPartialSuccess($optionalArgs['returnPartialSuccess']);
        }

        return $this->getPagedListResponse('List', $optionalArgs, FirewallPolicyList::class, $request);
    }

    /**
     * Lists associations of a specified target, i.e., organization or folder.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $response = $firewallPoliciesClient->listAssociations();
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param array $optionalArgs {
     *     Optional.
     *
     *     @type string $targetResource
     *           The target resource to list associations. It is an organization, or a folder.
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\FirewallPoliciesListAssociationsResponse
     *
     * @throws ApiException if the remote call fails
     */
    public function listAssociations(array $optionalArgs = [])
    {
        $request = new ListAssociationsFirewallPolicyRequest();
        if (isset($optionalArgs['targetResource'])) {
            $request->setTargetResource($optionalArgs['targetResource']);
        }

        return $this->startCall('ListAssociations', FirewallPoliciesListAssociationsResponse::class, $optionalArgs, $request)->wait();
    }

    /**
     * Moves the specified firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->move($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to update.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type string $parentId
     *           The new parent of the firewall policy.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function move($firewallPolicy, array $optionalArgs = [])
    {
        $request = new MoveFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['parentId'])) {
            $request->setParentId($optionalArgs['parentId']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('Move', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Patches the specified policy with the data included in the request.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $firewallPolicyResource = new FirewallPolicy();
     *     $response = $firewallPoliciesClient->patch($firewallPolicy, $firewallPolicyResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string         $firewallPolicy         Name of the firewall policy to update.
     * @param FirewallPolicy $firewallPolicyResource The body resource for this request
     * @param array          $optionalArgs           {
     *     Optional.
     *
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function patch($firewallPolicy, $firewallPolicyResource, array $optionalArgs = [])
    {
        $request = new PatchFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $request->setFirewallPolicyResource($firewallPolicyResource);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('Patch', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Patches a rule of the specified priority.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $firewallPolicyRuleResource = new FirewallPolicyRule();
     *     $response = $firewallPoliciesClient->patchRule($firewallPolicy, $firewallPolicyRuleResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string             $firewallPolicy             Name of the firewall policy to update.
     * @param FirewallPolicyRule $firewallPolicyRuleResource The body resource for this request
     * @param array              $optionalArgs               {
     *     Optional.
     *
     *     @type int $priority
     *           The priority of the rule to patch.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function patchRule($firewallPolicy, $firewallPolicyRuleResource, array $optionalArgs = [])
    {
        $request = new PatchRuleFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $request->setFirewallPolicyRuleResource($firewallPolicyRuleResource);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['priority'])) {
            $request->setPriority($optionalArgs['priority']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('PatchRule', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Removes an association for the specified firewall policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->removeAssociation($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to update.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type string $name
     *           Name for the attachment that will be removed.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function removeAssociation($firewallPolicy, array $optionalArgs = [])
    {
        $request = new RemoveAssociationFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['name'])) {
            $request->setName($optionalArgs['name']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('RemoveAssociation', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Deletes a rule of the specified priority.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $firewallPolicy = 'firewall_policy';
     *     $response = $firewallPoliciesClient->removeRule($firewallPolicy);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string $firewallPolicy Name of the firewall policy to update.
     * @param array  $optionalArgs   {
     *     Optional.
     *
     *     @type int $priority
     *           The priority of the rule to remove from the firewall policy.
     *     @type string $requestId
     *           An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
     *
     *           For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
     *
     *           The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Operation
     *
     * @throws ApiException if the remote call fails
     */
    public function removeRule($firewallPolicy, array $optionalArgs = [])
    {
        $request = new RemoveRuleFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setFirewallPolicy($firewallPolicy);
        $requestParamHeaders['firewall_policy'] = $firewallPolicy;
        if (isset($optionalArgs['priority'])) {
            $request->setPriority($optionalArgs['priority']);
        }

        if (isset($optionalArgs['requestId'])) {
            $request->setRequestId($optionalArgs['requestId']);
        }

        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('RemoveRule', Operation::class, $optionalArgs, $request)->wait();
    }

    /**
     * Sets the access control policy on the specified resource. Replaces any existing policy.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $globalOrganizationSetPolicyRequestResource = new GlobalOrganizationSetPolicyRequest();
     *     $resource = 'resource';
     *     $response = $firewallPoliciesClient->setIamPolicy($globalOrganizationSetPolicyRequestResource, $resource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param GlobalOrganizationSetPolicyRequest $globalOrganizationSetPolicyRequestResource The body resource for this request
     * @param string                             $resource                                   Name or id of the resource for this request.
     * @param array                              $optionalArgs                               {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\Policy
     *
     * @throws ApiException if the remote call fails
     */
    public function setIamPolicy($globalOrganizationSetPolicyRequestResource, $resource, array $optionalArgs = [])
    {
        $request = new SetIamPolicyFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setGlobalOrganizationSetPolicyRequestResource($globalOrganizationSetPolicyRequestResource);
        $request->setResource($resource);
        $requestParamHeaders['resource'] = $resource;
        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('SetIamPolicy', Policy::class, $optionalArgs, $request)->wait();
    }

    /**
     * Returns permissions that a caller has on the specified resource.
     *
     * Sample code:
     * ```
     * $firewallPoliciesClient = new FirewallPoliciesClient();
     * try {
     *     $resource = 'resource';
     *     $testPermissionsRequestResource = new TestPermissionsRequest();
     *     $response = $firewallPoliciesClient->testIamPermissions($resource, $testPermissionsRequestResource);
     * } finally {
     *     $firewallPoliciesClient->close();
     * }
     * ```
     *
     * @param string                 $resource                       Name or id of the resource for this request.
     * @param TestPermissionsRequest $testPermissionsRequestResource The body resource for this request
     * @param array                  $optionalArgs                   {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a
     *           {@see Google\ApiCore\RetrySettings} object, or an associative array of retry
     *           settings parameters. See the documentation on
     *           {@see Google\ApiCore\RetrySettings} for example usage.
     * }
     *
     * @return \Google\Cloud\Compute\V1\TestPermissionsResponse
     *
     * @throws ApiException if the remote call fails
     */
    public function testIamPermissions($resource, $testPermissionsRequestResource, array $optionalArgs = [])
    {
        $request = new TestIamPermissionsFirewallPolicyRequest();
        $requestParamHeaders = [];
        $request->setResource($resource);
        $request->setTestPermissionsRequestResource($testPermissionsRequestResource);
        $requestParamHeaders['resource'] = $resource;
        $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders);
        $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader();
        return $this->startCall('TestIamPermissions', TestPermissionsResponse::class, $optionalArgs, $request)->wait();
    }
}
