Google Cloud Appengine Admin V1 Client - Class FirewallClient (1.3.0)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class FirewallClient.

Service Description: Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.

Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ AppEngine \ V1 \ Client

Methods

__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. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. 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 = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods 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.

batchUpdateIngressRules

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::batchUpdateIngressRulesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesRequest` A request to house fields associated with the call.
`callOptions`	`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\AppEngine\V1\BatchUpdateIngressRulesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesRequest;
use Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesResponse;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;

/**
 * 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 batch_update_ingress_rules_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new BatchUpdateIngressRulesRequest();

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

createIngressRule

Creates a firewall rule for the application.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::createIngressRuleAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\CreateIngressRuleRequest` A request to house fields associated with the call.
`callOptions`	`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\AppEngine\V1\FirewallRule`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;
use Google\Cloud\AppEngine\V1\CreateIngressRuleRequest;
use Google\Cloud\AppEngine\V1\FirewallRule;

/**
 * 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 create_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new CreateIngressRuleRequest();

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

deleteIngressRule

Deletes the specified firewall rule.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::deleteIngressRuleAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\DeleteIngressRuleRequest` A request to house fields associated with the call.
`callOptions`	`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;
use Google\Cloud\AppEngine\V1\DeleteIngressRuleRequest;

/**
 * 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 delete_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new DeleteIngressRuleRequest();

    // Call the API and handle any network failures.
    try {
        $firewallClient->deleteIngressRule($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getIngressRule

Gets the specified firewall rule.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::getIngressRuleAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\GetIngressRuleRequest` A request to house fields associated with the call.
`callOptions`	`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\AppEngine\V1\FirewallRule`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;
use Google\Cloud\AppEngine\V1\FirewallRule;
use Google\Cloud\AppEngine\V1\GetIngressRuleRequest;

/**
 * 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 get_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new GetIngressRuleRequest();

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

listIngressRules

Lists the firewall rules of an application.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::listIngressRulesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\ListIngressRulesRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;
use Google\Cloud\AppEngine\V1\FirewallRule;
use Google\Cloud\AppEngine\V1\ListIngressRulesRequest;

/**
 * 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_ingress_rules_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new ListIngressRulesRequest();

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

        /** @var FirewallRule $element */
        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());
    }
}

updateIngressRule

Updates the specified firewall rule.

The async variant is Google\Cloud\AppEngine\V1\Client\FirewallClient::updateIngressRuleAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\UpdateIngressRuleRequest` A request to house fields associated with the call.
`callOptions`	`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\AppEngine\V1\FirewallRule`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\FirewallClient;
use Google\Cloud\AppEngine\V1\FirewallRule;
use Google\Cloud\AppEngine\V1\UpdateIngressRuleRequest;

/**
 * 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 update_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Prepare the request message.
    $request = new UpdateIngressRuleRequest();

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

batchUpdateIngressRulesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createIngressRuleAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\CreateIngressRuleRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteIngressRuleAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\DeleteIngressRuleRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIngressRuleAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\GetIngressRuleRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listIngressRulesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\ListIngressRulesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateIngressRuleAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\UpdateIngressRuleRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`