Google Cloud Dataflow V1beta3 Client - Class SnapshotsV1Beta3Client (0.6.5)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class SnapshotsV1Beta3Client.

Service Description: Provides methods to manage snapshots of Google Cloud Dataflow jobs.

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

Namespace

Google \ Cloud \ Dataflow \ V1beta3 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

deleteSnapshot

Deletes a snapshot.

The async variant is SnapshotsV1Beta3Client::deleteSnapshotAsync() .

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\DeleteSnapshotRequest

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\Dataflow\V1beta3\DeleteSnapshotResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\SnapshotsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\DeleteSnapshotRequest;
use Google\Cloud\Dataflow\V1beta3\DeleteSnapshotResponse;

/**
 * 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 delete_snapshot_sample(): void
{
    // Create a client.
    $snapshotsV1Beta3Client = new SnapshotsV1Beta3Client();

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

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

getSnapshot

Gets information about a snapshot.

The async variant is SnapshotsV1Beta3Client::getSnapshotAsync() .

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\GetSnapshotRequest

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\Dataflow\V1beta3\Snapshot
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\SnapshotsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\GetSnapshotRequest;
use Google\Cloud\Dataflow\V1beta3\Snapshot;

/**
 * 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_snapshot_sample(): void
{
    // Create a client.
    $snapshotsV1Beta3Client = new SnapshotsV1Beta3Client();

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

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

listSnapshots

Lists snapshots.

The async variant is SnapshotsV1Beta3Client::listSnapshotsAsync() .

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\ListSnapshotsRequest

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\Dataflow\V1beta3\ListSnapshotsResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\SnapshotsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\ListSnapshotsRequest;
use Google\Cloud\Dataflow\V1beta3\ListSnapshotsResponse;

/**
 * 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_snapshots_sample(): void
{
    // Create a client.
    $snapshotsV1Beta3Client = new SnapshotsV1Beta3Client();

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

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

deleteSnapshotAsync

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\DeleteSnapshotRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataflow\V1beta3\DeleteSnapshotResponse>

getSnapshotAsync

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\GetSnapshotRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataflow\V1beta3\Snapshot>

listSnapshotsAsync

Parameters
Name Description
request Google\Cloud\Dataflow\V1beta3\ListSnapshotsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataflow\V1beta3\ListSnapshotsResponse>