Compute V1 Client - Class SecurityPoliciesClient (1.10.1)

Version 1.10.1

• 1.19.0 (latest)
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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 Compute V1 Client class SecurityPoliciesClient.

Service Description: The SecurityPolicies API.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Compute \ 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. At the moment, supports only rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

addRule

Inserts a rule into a security policy.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::addRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddRuleSecurityPolicyRequest 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\OperationResponse

aggregatedList

Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::aggregatedListAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListSecurityPoliciesRequest 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

delete

Deletes the specified policy.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::deleteAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteSecurityPolicyRequest 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\OperationResponse

get

List all of the ordered rules present in a single specified policy.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::getAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetSecurityPolicyRequest 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\Compute\V1\SecurityPolicy

getRule

Gets a rule at the specified priority.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::getRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetRuleSecurityPolicyRequest 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\Compute\V1\SecurityPolicyRule

insert

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

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::insertAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertSecurityPolicyRequest 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\OperationResponse

list

List all the policies that have been configured for the specified project.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::listAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListSecurityPoliciesRequest 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

listPreconfiguredExpressionSets

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::listPreconfiguredExpressionSetsAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListPreconfiguredExpressionSetsSecurityPoliciesRequest 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\Compute\V1\SecurityPoliciesListPreconfiguredExpressionSetsResponse

patch

Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::patchAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchSecurityPolicyRequest 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\OperationResponse

patchRule

Patches a rule at the specified priority.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::patchRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchRuleSecurityPolicyRequest 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\OperationResponse

removeRule

Deletes a rule at the specified priority.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::removeRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\RemoveRuleSecurityPolicyRequest 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\OperationResponse

setLabels

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::setLabelsAsync() .

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetLabelsSecurityPolicyRequest 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\OperationResponse

addRuleAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AddRuleSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

aggregatedListAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\AggregatedListSecurityPoliciesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\DeleteSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getRuleAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\GetRuleSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\InsertSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListSecurityPoliciesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listPreconfiguredExpressionSetsAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\ListPreconfiguredExpressionSetsSecurityPoliciesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

patchAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

patchRuleAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\PatchRuleSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

removeRuleAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\RemoveRuleSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLabelsAsync

Parameters
Name	Description
request	Google\Cloud\Compute\V1\SetLabelsSecurityPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

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

Returns
Type	Description
Google\Cloud\Compute\V1\GlobalOperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse