Google Cloud Memorystore V1beta Client - Class MemorystoreClient (0.1.0)

Reference documentation and code samples for the Google Cloud Memorystore V1beta Client class MemorystoreClient.

Service Description: Service describing handlers for resources

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 \ Memorystore \ V1beta \ 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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createInstance

Creates a new Instance in a given project and location.

The async variant is MemorystoreClient::createInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\CreateInstanceRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\CreateInstanceRequest;
use Google\Cloud\Memorystore\V1beta\Instance;
use Google\Cloud\Memorystore\V1beta\PscAutoConnection;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                            The parent resource where this instance will be created.
 *                                                           Format: projects/{project}/locations/{location}
 *                                                           Please see {@see MemorystoreClient::locationName()} for help formatting this field.
 * @param string $instanceId                                 The ID to use for the instance, which will become the final
 *                                                           component of the instance's resource name.
 *
 *                                                           This value is subject to the following restrictions:
 *
 *                                                           * Must be 4-63 characters in length
 *                                                           * Must begin with a letter or digit
 *                                                           * Must contain only lowercase letters, digits, and hyphens
 *                                                           * Must not end with a hyphen
 *                                                           * Must be unique within a location
 * @param string $instancePscAutoConnectionsProjectId        The consumer project_id where PSC connections are established.
 *                                                           This should be the same project_id that the instance is being created in.
 * @param string $formattedInstancePscAutoConnectionsNetwork The network where the PSC endpoints are created, in the form of
 *                                                           projects/{project_id}/global/networks/{network_id}. Please see
 *                                                           {@see MemorystoreClient::networkName()} for help formatting this field.
 */
function create_instance_sample(
    string $formattedParent,
    string $instanceId,
    string $instancePscAutoConnectionsProjectId,
    string $formattedInstancePscAutoConnectionsNetwork
): void {
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

    // Prepare the request message.
    $pscAutoConnection = (new PscAutoConnection())
        ->setProjectId($instancePscAutoConnectionsProjectId)
        ->setNetwork($formattedInstancePscAutoConnectionsNetwork);
    $instancePscAutoConnections = [$pscAutoConnection,];
    $instance = (new Instance())
        ->setPscAutoConnections($instancePscAutoConnections);
    $request = (new CreateInstanceRequest())
        ->setParent($formattedParent)
        ->setInstanceId($instanceId)
        ->setInstance($instance);

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

        if ($response->operationSucceeded()) {
            /** @var Instance $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 = MemorystoreClient::locationName('[PROJECT]', '[LOCATION]');
    $instanceId = '[INSTANCE_ID]';
    $instancePscAutoConnectionsProjectId = '[PROJECT_ID]';
    $formattedInstancePscAutoConnectionsNetwork = MemorystoreClient::networkName(
        '[PROJECT]',
        '[NETWORK]'
    );

    create_instance_sample(
        $formattedParent,
        $instanceId,
        $instancePscAutoConnectionsProjectId,
        $formattedInstancePscAutoConnectionsNetwork
    );
}

deleteInstance

Deletes a single Instance.

The async variant is MemorystoreClient::deleteInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\DeleteInstanceRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\DeleteInstanceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the instance to delete.
 *                              Format: projects/{project}/locations/{location}/instances/{instance}
 *                              Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
 */
function delete_instance_sample(string $formattedName): void
{
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $memorystoreClient->deleteInstance($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 = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    delete_instance_sample($formattedName);
}

getCertificateAuthority

Gets details about the certificate authority for an Instance.

The async variant is MemorystoreClient::getCertificateAuthorityAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\GetCertificateAuthorityRequest` 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\Memorystore\V1beta\CertificateAuthority`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1beta\CertificateAuthority;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\GetCertificateAuthorityRequest;

/**
 * @param string $formattedName The name of the certificate authority.
 *                              Format:
 *                              projects/{project}/locations/{location}/instances/{instance}/certificateAuthority
 *                              Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
 */
function get_certificate_authority_sample(string $formattedName): void
{
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CertificateAuthority $response */
        $response = $memorystoreClient->getCertificateAuthority($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 = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    get_certificate_authority_sample($formattedName);
}

getInstance

Gets details of a single Instance.

The async variant is MemorystoreClient::getInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\GetInstanceRequest` 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\Memorystore\V1beta\Instance`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\GetInstanceRequest;
use Google\Cloud\Memorystore\V1beta\Instance;

/**
 * @param string $formattedName The name of the instance to retrieve.
 *                              Format: projects/{project}/locations/{location}/instances/{instance}
 *                              Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
 */
function get_instance_sample(string $formattedName): void
{
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Instance $response */
        $response = $memorystoreClient->getInstance($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 = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    get_instance_sample($formattedName);
}

listInstances

Lists Instances in a given project and location.

The async variant is MemorystoreClient::listInstancesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\ListInstancesRequest` 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\Memorystore\V1beta\ListInstancesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\ListInstancesRequest;
use Google\Cloud\Memorystore\V1beta\ListInstancesResponse;

/**
 * @param string $formattedParent The parent to list instances from.
 *                                Format: projects/{project}/locations/{location}
 *                                Please see {@see MemorystoreClient::locationName()} for help formatting this field.
 */
function list_instances_sample(string $formattedParent): void
{
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ListInstancesResponse $response */
        $response = $memorystoreClient->listInstances($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
{
    $formattedParent = MemorystoreClient::locationName('[PROJECT]', '[LOCATION]');

    list_instances_sample($formattedParent);
}

updateInstance

Updates the parameters of a single Instance.

The async variant is MemorystoreClient::updateInstanceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\UpdateInstanceRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1beta\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1beta\Instance;
use Google\Cloud\Memorystore\V1beta\PscAutoConnection;
use Google\Cloud\Memorystore\V1beta\UpdateInstanceRequest;
use Google\Rpc\Status;

/**
 * @param string $instancePscAutoConnectionsProjectId        The consumer project_id where PSC connections are established.
 *                                                           This should be the same project_id that the instance is being created in.
 * @param string $formattedInstancePscAutoConnectionsNetwork The network where the PSC endpoints are created, in the form of
 *                                                           projects/{project_id}/global/networks/{network_id}. Please see
 *                                                           {@see MemorystoreClient::networkName()} for help formatting this field.
 */
function update_instance_sample(
    string $instancePscAutoConnectionsProjectId,
    string $formattedInstancePscAutoConnectionsNetwork
): void {
    // Create a client.
    $memorystoreClient = new MemorystoreClient();

    // Prepare the request message.
    $pscAutoConnection = (new PscAutoConnection())
        ->setProjectId($instancePscAutoConnectionsProjectId)
        ->setNetwork($formattedInstancePscAutoConnectionsNetwork);
    $instancePscAutoConnections = [$pscAutoConnection,];
    $instance = (new Instance())
        ->setPscAutoConnections($instancePscAutoConnections);
    $request = (new UpdateInstanceRequest())
        ->setInstance($instance);

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

        if ($response->operationSucceeded()) {
            /** @var Instance $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
{
    $instancePscAutoConnectionsProjectId = '[PROJECT_ID]';
    $formattedInstancePscAutoConnectionsNetwork = MemorystoreClient::networkName(
        '[PROJECT]',
        '[NETWORK]'
    );

    update_instance_sample(
        $instancePscAutoConnectionsProjectId,
        $formattedInstancePscAutoConnectionsNetwork
    );
}

getLocation

Gets information about a location.

The async variant is MemorystoreClient::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\Memorystore\V1beta\Client\MemorystoreClient;

/**
 * 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.
    $memorystoreClient = new MemorystoreClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $memorystoreClient->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.

The async variant is MemorystoreClient::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\Memorystore\V1beta\Client\MemorystoreClient;

/**
 * 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.
    $memorystoreClient = new MemorystoreClient();

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

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

        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());
    }
}

createInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\CreateInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deleteInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\DeleteInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getCertificateAuthorityAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\GetCertificateAuthorityRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1beta\CertificateAuthority>`

getInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\GetInstanceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1beta\Instance>`

listInstancesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\ListInstancesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1beta\ListInstancesResponse>`

updateInstanceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Memorystore\V1beta\UpdateInstanceRequest`
`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>`

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::forwardingRuleName

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

Parameters
Name	Description
`project`	`string`
`region`	`string`
`forwardingRule`	`string`

Returns
Type	Description
`string`	The formatted forwarding_rule resource.

static::instanceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted instance 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::serviceAttachmentName

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

Parameters
Name	Description
`project`	`string`
`region`	`string`
`serviceAttachment`	`string`

Returns
Type	Description
`string`	The formatted service_attachment 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

forwardingRule: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
instance: projects/{project}/locations/{location}/instances/{instance}
location: projects/{project}/locations/{location}
network: projects/{project}/global/networks/{network}
serviceAttachment: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}

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.