Google Cloud Network Security V1 Client - Class FirewallActivationClient (1.3.0)

Reference documentation and code samples for the Google Cloud Network Security V1 Client class FirewallActivationClient.

Service Description: Service for managing Firewall Endpoints and Associations.

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

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ NetworkSecurity \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array|Google\ApiCore\Options\ClientOptions

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 FetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\NetworkSecurity\V1\FirewallActivationClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new FirewallActivationClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

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

↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain string

The service domain for the client. Defaults to 'googleapis.com'.

createFirewallEndpoint

Creates a new FirewallEndpoint in a given organization and location.

The async variant is FirewallActivationClient::createFirewallEndpointAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointRequest

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<Google\Cloud\NetworkSecurity\V1\FirewallEndpoint>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointRequest;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpoint;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    Value for parent. Please see
 *                                   {@see FirewallActivationClient::organizationLocationName()} for help formatting this field.
 * @param string $firewallEndpointId Id of the requesting object.
 *                                   If auto-generating Id server-side, remove this field and
 *                                   firewall_endpoint_id from the method_signature of Create RPC.
 */
function create_firewall_endpoint_sample(
    string $formattedParent,
    string $firewallEndpointId
): void {
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $firewallEndpoint = new FirewallEndpoint();
    $request = (new CreateFirewallEndpointRequest())
        ->setParent($formattedParent)
        ->setFirewallEndpointId($firewallEndpointId)
        ->setFirewallEndpoint($firewallEndpoint);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->createFirewallEndpoint($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var FirewallEndpoint $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedParent = FirewallActivationClient::organizationLocationName(
        '[ORGANIZATION]',
        '[LOCATION]'
    );
    $firewallEndpointId = '[FIREWALL_ENDPOINT_ID]';

    create_firewall_endpoint_sample($formattedParent, $firewallEndpointId);
}

createFirewallEndpointAssociation

Creates a new FirewallEndpointAssociation in a given project and location.

The async variant is FirewallActivationClient::createFirewallEndpointAssociationAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointAssociationRequest

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<Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointAssociationRequest;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                             Value for parent. Please see
 *                                                            {@see FirewallActivationClient::locationName()} for help formatting this field.
 * @param string $firewallEndpointAssociationNetwork          The URL of the network that is being associated.
 * @param string $firewallEndpointAssociationFirewallEndpoint The URL of the FirewallEndpoint that is being associated.
 */
function create_firewall_endpoint_association_sample(
    string $formattedParent,
    string $firewallEndpointAssociationNetwork,
    string $firewallEndpointAssociationFirewallEndpoint
): void {
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $firewallEndpointAssociation = (new FirewallEndpointAssociation())
        ->setNetwork($firewallEndpointAssociationNetwork)
        ->setFirewallEndpoint($firewallEndpointAssociationFirewallEndpoint);
    $request = (new CreateFirewallEndpointAssociationRequest())
        ->setParent($formattedParent)
        ->setFirewallEndpointAssociation($firewallEndpointAssociation);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->createFirewallEndpointAssociation($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var FirewallEndpointAssociation $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedParent = FirewallActivationClient::locationName('[PROJECT]', '[LOCATION]');
    $firewallEndpointAssociationNetwork = '[NETWORK]';
    $firewallEndpointAssociationFirewallEndpoint = '[FIREWALL_ENDPOINT]';

    create_firewall_endpoint_association_sample(
        $formattedParent,
        $firewallEndpointAssociationNetwork,
        $firewallEndpointAssociationFirewallEndpoint
    );
}

deleteFirewallEndpoint

Deletes a single org Endpoint.

The async variant is FirewallActivationClient::deleteFirewallEndpointAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointRequest

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<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see FirewallActivationClient::firewallEndpointName()} for help formatting this field.
 */
function delete_firewall_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new DeleteFirewallEndpointRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->deleteFirewallEndpoint($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedName = FirewallActivationClient::firewallEndpointName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[FIREWALL_ENDPOINT]'
    );

    delete_firewall_endpoint_sample($formattedName);
}

deleteFirewallEndpointAssociation

Deletes a single FirewallEndpointAssociation.

The async variant is FirewallActivationClient::deleteFirewallEndpointAssociationAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointAssociationRequest

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<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointAssociationRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see FirewallActivationClient::firewallEndpointAssociationName()} for help formatting this field.
 */
function delete_firewall_endpoint_association_sample(string $formattedName): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new DeleteFirewallEndpointAssociationRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->deleteFirewallEndpointAssociation($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedName = FirewallActivationClient::firewallEndpointAssociationName(
        '[PROJECT]',
        '[LOCATION]',
        '[FIREWALL_ENDPOINT_ASSOCIATION]'
    );

    delete_firewall_endpoint_association_sample($formattedName);
}

getFirewallEndpoint

Gets details of a single org Endpoint.

The async variant is FirewallActivationClient::getFirewallEndpointAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointRequest

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\NetworkSecurity\V1\FirewallEndpoint
Example
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpoint;
use Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointRequest;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see FirewallActivationClient::firewallEndpointName()} for help formatting this field.
 */
function get_firewall_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new GetFirewallEndpointRequest())
        ->setName($formattedName);

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedName = FirewallActivationClient::firewallEndpointName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[FIREWALL_ENDPOINT]'
    );

    get_firewall_endpoint_sample($formattedName);
}

getFirewallEndpointAssociation

Gets details of a single FirewallEndpointAssociation.

The async variant is FirewallActivationClient::getFirewallEndpointAssociationAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointAssociationRequest

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\NetworkSecurity\V1\FirewallEndpointAssociation
Example
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation;
use Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointAssociationRequest;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see FirewallActivationClient::firewallEndpointAssociationName()} for help formatting this field.
 */
function get_firewall_endpoint_association_sample(string $formattedName): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new GetFirewallEndpointAssociationRequest())
        ->setName($formattedName);

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedName = FirewallActivationClient::firewallEndpointAssociationName(
        '[PROJECT]',
        '[LOCATION]',
        '[FIREWALL_ENDPOINT_ASSOCIATION]'
    );

    get_firewall_endpoint_association_sample($formattedName);
}

listFirewallEndpointAssociations

Lists Associations in a given project and location.

The async variant is FirewallActivationClient::listFirewallEndpointAssociationsAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointAssociationsRequest

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\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation;
use Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointAssociationsRequest;

/**
 * @param string $formattedParent Parent value for ListAssociationsRequest
 *                                Please see {@see FirewallActivationClient::locationName()} for help formatting this field.
 */
function list_firewall_endpoint_associations_sample(string $formattedParent): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new ListFirewallEndpointAssociationsRequest())
        ->setParent($formattedParent);

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

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedParent = FirewallActivationClient::locationName('[PROJECT]', '[LOCATION]');

    list_firewall_endpoint_associations_sample($formattedParent);
}

listFirewallEndpoints

Lists FirewallEndpoints in a given organization and location.

The async variant is FirewallActivationClient::listFirewallEndpointsAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointsRequest

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\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpoint;
use Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointsRequest;

/**
 * @param string $formattedParent Parent value for ListEndpointsRequest
 *                                Please see {@see FirewallActivationClient::organizationLocationName()} for help formatting this field.
 */
function list_firewall_endpoints_sample(string $formattedParent): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new ListFirewallEndpointsRequest())
        ->setParent($formattedParent);

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

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $formattedParent = FirewallActivationClient::organizationLocationName(
        '[ORGANIZATION]',
        '[LOCATION]'
    );

    list_firewall_endpoints_sample($formattedParent);
}

updateFirewallEndpoint

Update a single org Endpoint.

The async variant is FirewallActivationClient::updateFirewallEndpointAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointRequest

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<Google\Cloud\NetworkSecurity\V1\FirewallEndpoint>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpoint;
use Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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_firewall_endpoint_sample(): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $firewallEndpoint = new FirewallEndpoint();
    $request = (new UpdateFirewallEndpointRequest())
        ->setUpdateMask($updateMask)
        ->setFirewallEndpoint($firewallEndpoint);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->updateFirewallEndpoint($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var FirewallEndpoint $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateFirewallEndpointAssociation

Update a single FirewallEndpointAssociation.

The async variant is FirewallActivationClient::updateFirewallEndpointAssociationAsync() .

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointAssociationRequest

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<Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;
use Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation;
use Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointAssociationRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $firewallEndpointAssociationNetwork          The URL of the network that is being associated.
 * @param string $firewallEndpointAssociationFirewallEndpoint The URL of the FirewallEndpoint that is being associated.
 */
function update_firewall_endpoint_association_sample(
    string $firewallEndpointAssociationNetwork,
    string $firewallEndpointAssociationFirewallEndpoint
): void {
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $firewallEndpointAssociation = (new FirewallEndpointAssociation())
        ->setNetwork($firewallEndpointAssociationNetwork)
        ->setFirewallEndpoint($firewallEndpointAssociationFirewallEndpoint);
    $request = (new UpdateFirewallEndpointAssociationRequest())
        ->setUpdateMask($updateMask)
        ->setFirewallEndpointAssociation($firewallEndpointAssociation);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $firewallActivationClient->updateFirewallEndpointAssociation($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var FirewallEndpointAssociation $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $firewallEndpointAssociationNetwork = '[NETWORK]';
    $firewallEndpointAssociationFirewallEndpoint = '[FIREWALL_ENDPOINT]';

    update_firewall_endpoint_association_sample(
        $firewallEndpointAssociationNetwork,
        $firewallEndpointAssociationFirewallEndpoint
    );
}

getLocation

Gets information about a location.

The async variant is FirewallActivationClient::getLocationAsync() .

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest

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\Location\Location
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;

/**
 * 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_location_sample(): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

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

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

listLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field:

Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.

For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

The async variant is FirewallActivationClient::listLocationsAsync() .

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest

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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;

/**
 * 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_locations_sample(): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

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

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

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

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is FirewallActivationClient::getIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is FirewallActivationClient::setIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is FirewallActivationClient::testIamPermissionsAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest

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\Iam\V1\TestIamPermissionsResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkSecurity\V1\Client\FirewallActivationClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $firewallActivationClient = new FirewallActivationClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

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

/**
 * Helper to execute the sample.
 *
 * 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 callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

createFirewallEndpointAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createFirewallEndpointAssociationAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\CreateFirewallEndpointAssociationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteFirewallEndpointAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteFirewallEndpointAssociationAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\DeleteFirewallEndpointAssociationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getFirewallEndpointAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\FirewallEndpoint>

getFirewallEndpointAssociationAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\GetFirewallEndpointAssociationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\FirewallEndpointAssociation>

listFirewallEndpointAssociationsAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointAssociationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listFirewallEndpointsAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\ListFirewallEndpointsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateFirewallEndpointAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateFirewallEndpointAssociationAsync

Parameters
Name Description
request Google\Cloud\NetworkSecurity\V1\UpdateFirewallEndpointAssociationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>

setIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>

testIamPermissionsAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse>

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\OperationsClient

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

static::firewallEndpointName

Formats a string containing the fully-qualified path to represent a firewall_endpoint resource.

Parameters
Name Description
organization string
location string
firewallEndpoint string
Returns
Type Description
string The formatted firewall_endpoint resource.

static::firewallEndpointAssociationName

Formats a string containing the fully-qualified path to represent a firewall_endpoint_association resource.

Parameters
Name Description
project string
location string
firewallEndpointAssociation string
Returns
Type Description
string The formatted firewall_endpoint_association resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted location resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name Description
project string
network string
Returns
Type Description
string The formatted network resource.

static::organizationLocationName

Formats a string containing the fully-qualified path to represent a organization_location resource.

Parameters
Name Description
organization string
location string
Returns
Type Description
string The formatted organization_location resource.

static::organizationLocationFirewallEndpointName

Formats a string containing the fully-qualified path to represent a organization_location_firewall_endpoint resource.

Parameters
Name Description
organization string
location string
firewallEndpoint string
Returns
Type Description
string The formatted organization_location_firewall_endpoint resource.

static::projectLocationFirewallEndpointName

Formats a string containing the fully-qualified path to represent a project_location_firewall_endpoint resource.

Parameters
Name Description
project string
location string
firewallEndpoint string
Returns
Type Description
string The formatted project_location_firewall_endpoint resource.

static::tlsInspectionPolicyName

Formats a string containing the fully-qualified path to represent a tls_inspection_policy resource.

Parameters
Name Description
project string
location string
tlsInspectionPolicy string
Returns
Type Description
string The formatted tls_inspection_policy resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • firewallEndpoint: organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • firewallEndpointAssociation: projects/{project}/locations/{location}/firewallEndpointAssociations/{firewall_endpoint_association}
  • location: projects/{project}/locations/{location}
  • network: projects/{project}/global/networks/{network}
  • organizationLocation: organizations/{organization}/locations/{location}
  • organizationLocationFirewallEndpoint: organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • projectLocationFirewallEndpoint: projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • tlsInspectionPolicy: projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string

template ?string

Optional name of template to match

Returns
Type Description
array An associative array from name component IDs to component values.