Google Cloud Run V2 Client - Class InstancesClient (1.12.2)

Reference documentation and code samples for the Google Cloud Run V2 Client class InstancesClient.

Service Description: The Cloud Run Instances API allows you to manage Cloud Run Instances.

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 \ Run \ V2 \ 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\Run\V2\InstancesClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new InstancesClient(['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'.

createInstance

Creates an Instance.

The async variant is InstancesClient::createInstanceAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\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 
< Google\Cloud\Run\V2\Instance 
>

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\Container;
use Google\Cloud\Run\V2\CreateInstanceRequest;
use Google\Cloud\Run\V2\Instance;
use Google\Rpc\Status;

/**
 * @param string $formattedParent         Please see {@see InstancesClient::locationName()} for help formatting this field.
 * @param string $instanceContainersImage Name of the container image in Dockerhub, Google Artifact
 *                                        Registry, or Google Container Registry. If the host is not provided,
 *                                        Dockerhub is assumed.
 * @param string $instanceId              The unique identifier for the Instance. It must begin with
 *                                        letter, and cannot end with hyphen; must contain fewer than 50 characters.
 *                                        The name of the instance becomes {parent}/instances/{instance_id}.
 */
function create_instance_sample(
    string $formattedParent,
    string $instanceContainersImage,
    string $instanceId
): void {
    // Create a client.
    $instancesClient = new InstancesClient();

    // Prepare the request message.
    $container = (new Container())
        ->setImage($instanceContainersImage);
    $instanceContainers = [$container,];
    $instance = (new Instance())
        ->setContainers($instanceContainers);
    $request = (new CreateInstanceRequest())
        ->setParent($formattedParent)
        ->setInstance($instance)
        ->setInstanceId($instanceId);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $instancesClient->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 = InstancesClient::locationName('[PROJECT]', '[LOCATION]');
    $instanceContainersImage = '[IMAGE]';
    $instanceId = '[INSTANCE_ID]';

    create_instance_sample($formattedParent, $instanceContainersImage, $instanceId);
}

deleteInstance

Deletes a Instance

The async variant is InstancesClient::deleteInstanceAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\DeleteInstanceRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse 
< Google\Cloud\Run\V2\Instance 
>

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\DeleteInstanceRequest;
use Google\Cloud\Run\V2\Instance;
use Google\Rpc\Status;

/**
 * @param string $formattedName Please see {@see InstancesClient::instanceName()} for help formatting this field.
 */
function delete_instance_sample(string $formattedName): void
{
    // Create a client.
    $instancesClient = new InstancesClient();

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

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

    delete_instance_sample($formattedName);
}

getInstance

Gets a Instance

The async variant is InstancesClient::getInstanceAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\GetInstanceRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\Run\V2\Instance

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\GetInstanceRequest;
use Google\Cloud\Run\V2\Instance;

/**
 * @param string $formattedName Please see {@see InstancesClient::instanceName()} for help formatting this field.
 */
function get_instance_sample(string $formattedName): void
{
    // Create a client.
    $instancesClient = new InstancesClient();

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

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

    get_instance_sample($formattedName);
}

listInstances

Lists Instances. Results are sorted by creation time, descending.

The async variant is InstancesClient::listInstancesAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\ListInstancesRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\Instance;
use Google\Cloud\Run\V2\ListInstancesRequest;

/**
 * @param string $formattedParent The location and project to list resources on.
 *                                Format: projects/{project}/locations/{location}, where {project} can be
 *                                project id or number. Please see
 *                                {@see InstancesClient::locationName()} for help formatting this field.
 */
function list_instances_sample(string $formattedParent): void
{
    // Create a client.
    $instancesClient = new InstancesClient();

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

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

        /** @var Instance $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 = InstancesClient::locationName('[PROJECT]', '[LOCATION]');

    list_instances_sample($formattedParent);
}

startInstance

Starts an Instance.

The async variant is InstancesClient::startInstanceAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\StartInstanceRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse 
< Google\Cloud\Run\V2\Instance 
>

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\Instance;
use Google\Cloud\Run\V2\StartInstanceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Instance to stop.
 *                              Format:
 *                              `projects/{project}/locations/{location}/instances/{instance}`,
 *                              where `{project}` can be project id or number. Please see
 *                              {@see InstancesClient::instanceName()} for help formatting this field.
 */
function start_instance_sample(string $formattedName): void
{
    // Create a client.
    $instancesClient = new InstancesClient();

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

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

    start_instance_sample($formattedName);
}

stopInstance

Stops an Instance.

The async variant is InstancesClient::stopInstanceAsync() .

Parameters

Name

Description

request

 Google\Cloud\Run\V2\StopInstanceRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\ApiCore\OperationResponse 
< Google\Cloud\Run\V2\Instance 
>

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\InstancesClient;
use Google\Cloud\Run\V2\Instance;
use Google\Cloud\Run\V2\StopInstanceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Instance to stop.
 *                              Format:
 *                              `projects/{project}/locations/{location}/instances/{instance}`,
 *                              where `{project}` can be project id or number. Please see
 *                              {@see InstancesClient::instanceName()} for help formatting this field.
 */
function stop_instance_sample(string $formattedName): void
{
    // Create a client.
    $instancesClient = new InstancesClient();

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

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

    stop_instance_sample($formattedName);
}

createInstanceAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\CreateInstanceRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\OperationResponse 
>

deleteInstanceAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\DeleteInstanceRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\OperationResponse 
>

getInstanceAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\GetInstanceRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Run\V2\Instance 
>

listInstancesAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\ListInstancesRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\PagedListResponse 
>

startInstanceAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\StartInstanceRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\OperationResponse 
>

stopInstanceAsync

Parameters

Name

Description

request

 Google\Cloud\Run\V2\StopInstanceRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\OperationResponse 
>

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

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

Parameters

Name

Description

project

string

location

string

connector

string

Returns

Type

Description

string

The formatted connector resource.

static::cryptoKeyName

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

Parameters

Name

Description

project

string

location

string

keyRing

string

cryptoKey

string

Returns

Type

Description

string

The formatted crypto_key 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::locationPolicyName

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

Parameter

Name

Description

location

string

Returns

Type

Description

string

The formatted location_policy resource.

static::policyName

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

Parameter

Name

Description

project

string

Returns

Type

Description

string

The formatted policy resource.

static::projectPolicyName

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

Parameter

Name

Description

project

string

Returns

Type

Description

string

The formatted project_policy resource.

static::secretName

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

Parameters

Name

Description

project

string

secret

string

Returns

Type

Description

string

The formatted secret resource.

static::secretVersionName

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

Parameters

Name

Description

project

string

secret

string

version

string

Returns

Type

Description

string

The formatted secret_version 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

connector: projects/{project}/locations/{location}/connectors/{connector}
cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
instance: projects/{project}/locations/{location}/instances/{instance}
location: projects/{project}/locations/{location}
locationPolicy: locations/{location}/policy
policy: projects/{project}/policy
projectPolicy: projects/{project}/policy
secret: projects/{project}/secrets/{secret}
secretVersion: projects/{project}/secrets/{secret}/versions/{version}

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.

Google Cloud Run V2 Client - Class InstancesClient (1.12.2) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createInstance

deleteInstance

getInstance

listInstances

startInstance

stopInstance

createInstanceAsync

deleteInstanceAsync

getInstanceAsync

listInstancesAsync

startInstanceAsync

stopInstanceAsync

getOperationsClient

resumeOperation

static::connectorName

static::cryptoKeyName

static::instanceName

static::locationName

static::locationPolicyName

static::policyName

static::projectPolicyName

static::secretName

static::secretVersionName

static::parseName

Google Cloud Run V2 Client - Class InstancesClient (1.12.2)