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

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. Sample code to get started:

$firewallClient = new FirewallClient();
try {
    $response = $firewallClient->batchUpdateIngressRules();
} finally {
    $firewallClient->close();
}

This service has a new (beta) implementation. See Google\Cloud\AppEngine\V1\Client\FirewallClient to use the new surface.

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.

↳ ingressRules FirewallRule[]

A list of FirewallRules to replace the existing set.

↳ 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
TypeDescription
Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\BatchUpdateIngressRulesResponse;
use Google\Cloud\AppEngine\V1\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();

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateIngressRulesResponse $response */
        $response = $firewallClient->batchUpdateIngressRules();
        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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ parent string

Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.

↳ rule FirewallRule

A FirewallRule containing the new resource. The user may optionally provide a position at which the new rule will be placed. The positions define a sequential list starting at 1. If a rule already exists at the given position, rules greater than the provided position will be moved forward by one. If no position is provided, the server will place the rule as the second to last rule in the sequence before the required default allow-all or deny-all rule.

↳ 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
TypeDescription
Google\Cloud\AppEngine\V1\FirewallRule
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\FirewallClient;
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();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallRule $response */
        $response = $firewallClient->createIngressRule();
        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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.

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

    // Call the API and handle any network failures.
    try {
        $firewallClient->deleteIngressRule();
        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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.

↳ 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
TypeDescription
Google\Cloud\AppEngine\V1\FirewallRule
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\FirewallClient;
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 get_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

    // Call the API and handle any network failures.
    try {
        /** @var FirewallRule $response */
        $response = $firewallClient->getIngressRule();
        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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ parent string

Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ 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.

↳ matchingAddress string

A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AppEngine\V1\FirewallClient;
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 list_ingress_rules_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

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

        /** @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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.

↳ rule FirewallRule

A FirewallRule containing the updated resource

↳ updateMask FieldMask

Standard field mask for the set of fields to be updated.

↳ 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
TypeDescription
Google\Cloud\AppEngine\V1\FirewallRule
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\FirewallClient;
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 update_ingress_rule_sample(): void
{
    // Create a client.
    $firewallClient = new FirewallClient();

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

Constants

SERVICE_NAME

Value: 'google.appengine.v1.Firewall'

The name of the service.

SERVICE_ADDRESS

Value: 'appengine.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.