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

Version 1.2.2

• 2.0.1 (latest)
• 2.0.0
• 1.3.5
• 1.2.2
• 1.1.1
• 1.0.6

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\AppEngine\V1\FirewallClient for the stable implementation

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

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

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.

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

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

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

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