Google Cloud Datastream V1 Client - Class DatastreamClient (2.0.1)

Version latest

• 2.0.1 (latest)
• 2.0.0
• 1.5.5
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.5

Reference documentation and code samples for the Google Cloud Datastream V1 Client class DatastreamClient.

Service Description: Datastream service

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 \ Datastream \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. 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.

createConnectionProfile

Use this method to create a connection profile in a project and location.

The async variant is DatastreamClient::createConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateConnectionProfileRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ConnectionProfile;
use Google\Cloud\Datastream\V1\CreateConnectionProfileRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent              The parent that owns the collection of ConnectionProfiles. Please see
 *                                             {@see DatastreamClient::locationName()} for help formatting this field.
 * @param string $connectionProfileId          The connection profile identifier.
 * @param string $connectionProfileDisplayName Display name.
 */
function create_connection_profile_sample(
    string $formattedParent,
    string $connectionProfileId,
    string $connectionProfileDisplayName
): void {
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $connectionProfile = (new ConnectionProfile())
        ->setDisplayName($connectionProfileDisplayName);
    $request = (new CreateConnectionProfileRequest())
        ->setParent($formattedParent)
        ->setConnectionProfileId($connectionProfileId)
        ->setConnectionProfile($connectionProfile);

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

        if ($response->operationSucceeded()) {
            /** @var ConnectionProfile $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 = DatastreamClient::locationName('[PROJECT]', '[LOCATION]');
    $connectionProfileId = '[CONNECTION_PROFILE_ID]';
    $connectionProfileDisplayName = '[DISPLAY_NAME]';

    create_connection_profile_sample(
        $formattedParent,
        $connectionProfileId,
        $connectionProfileDisplayName
    );
}

createPrivateConnection

Use this method to create a private connectivity configuration.

The async variant is DatastreamClient::createPrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreatePrivateConnectionRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\CreatePrivateConnectionRequest;
use Google\Cloud\Datastream\V1\PrivateConnection;
use Google\Rpc\Status;

/**
 * @param string $formattedParent              The parent that owns the collection of PrivateConnections. Please see
 *                                             {@see DatastreamClient::locationName()} for help formatting this field.
 * @param string $privateConnectionId          The private connectivity identifier.
 * @param string $privateConnectionDisplayName Display name.
 */
function create_private_connection_sample(
    string $formattedParent,
    string $privateConnectionId,
    string $privateConnectionDisplayName
): void {
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $privateConnection = (new PrivateConnection())
        ->setDisplayName($privateConnectionDisplayName);
    $request = (new CreatePrivateConnectionRequest())
        ->setParent($formattedParent)
        ->setPrivateConnectionId($privateConnectionId)
        ->setPrivateConnection($privateConnection);

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

        if ($response->operationSucceeded()) {
            /** @var PrivateConnection $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 = DatastreamClient::locationName('[PROJECT]', '[LOCATION]');
    $privateConnectionId = '[PRIVATE_CONNECTION_ID]';
    $privateConnectionDisplayName = '[DISPLAY_NAME]';

    create_private_connection_sample(
        $formattedParent,
        $privateConnectionId,
        $privateConnectionDisplayName
    );
}

createRoute

Use this method to create a route for a private connectivity configuration in a project and location.

The async variant is DatastreamClient::createRouteAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateRouteRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\CreateRouteRequest;
use Google\Cloud\Datastream\V1\Route;
use Google\Rpc\Status;

/**
 * @param string $formattedParent         The parent that owns the collection of Routes. Please see
 *                                        {@see DatastreamClient::privateConnectionName()} for help formatting this field.
 * @param string $routeId                 The Route identifier.
 * @param string $routeDisplayName        Display name.
 * @param string $routeDestinationAddress Destination address for connection
 */
function create_route_sample(
    string $formattedParent,
    string $routeId,
    string $routeDisplayName,
    string $routeDestinationAddress
): void {
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $route = (new Route())
        ->setDisplayName($routeDisplayName)
        ->setDestinationAddress($routeDestinationAddress);
    $request = (new CreateRouteRequest())
        ->setParent($formattedParent)
        ->setRouteId($routeId)
        ->setRoute($route);

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

        if ($response->operationSucceeded()) {
            /** @var Route $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 = DatastreamClient::privateConnectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]'
    );
    $routeId = '[ROUTE_ID]';
    $routeDisplayName = '[DISPLAY_NAME]';
    $routeDestinationAddress = '[DESTINATION_ADDRESS]';

    create_route_sample($formattedParent, $routeId, $routeDisplayName, $routeDestinationAddress);
}

createStream

Use this method to create a stream.

The async variant is DatastreamClient::createStreamAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateStreamRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\CreateStreamRequest;
use Google\Cloud\Datastream\V1\DestinationConfig;
use Google\Cloud\Datastream\V1\SourceConfig;
use Google\Cloud\Datastream\V1\Stream;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                              The parent that owns the collection of streams. Please see
 *                                                                             {@see DatastreamClient::locationName()} for help formatting this field.
 * @param string $streamId                                                     The stream identifier.
 * @param string $streamDisplayName                                            Display name.
 * @param string $formattedStreamSourceConfigSourceConnectionProfile           Source connection profile resoource.
 *                                                                             Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
 *                                                                             Please see {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 * @param string $formattedStreamDestinationConfigDestinationConnectionProfile Destination connection profile resource.
 *                                                                             Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
 *                                                                             Please see {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 */
function create_stream_sample(
    string $formattedParent,
    string $streamId,
    string $streamDisplayName,
    string $formattedStreamSourceConfigSourceConnectionProfile,
    string $formattedStreamDestinationConfigDestinationConnectionProfile
): void {
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $streamSourceConfig = (new SourceConfig())
        ->setSourceConnectionProfile($formattedStreamSourceConfigSourceConnectionProfile);
    $streamDestinationConfig = (new DestinationConfig())
        ->setDestinationConnectionProfile($formattedStreamDestinationConfigDestinationConnectionProfile);
    $stream = (new Stream())
        ->setDisplayName($streamDisplayName)
        ->setSourceConfig($streamSourceConfig)
        ->setDestinationConfig($streamDestinationConfig);
    $request = (new CreateStreamRequest())
        ->setParent($formattedParent)
        ->setStreamId($streamId)
        ->setStream($stream);

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

        if ($response->operationSucceeded()) {
            /** @var Stream $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 = DatastreamClient::locationName('[PROJECT]', '[LOCATION]');
    $streamId = '[STREAM_ID]';
    $streamDisplayName = '[DISPLAY_NAME]';
    $formattedStreamSourceConfigSourceConnectionProfile = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );
    $formattedStreamDestinationConfigDestinationConnectionProfile = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );

    create_stream_sample(
        $formattedParent,
        $streamId,
        $streamDisplayName,
        $formattedStreamSourceConfigSourceConnectionProfile,
        $formattedStreamDestinationConfigDestinationConnectionProfile
    );
}

deleteConnectionProfile

Use this method to delete a connection profile.

The async variant is DatastreamClient::deleteConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteConnectionProfileRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DeleteConnectionProfileRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the connection profile resource to delete. Please see
 *                              {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 */
function delete_connection_profile_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datastreamClient->deleteConnectionProfile($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 = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );

    delete_connection_profile_sample($formattedName);
}

deletePrivateConnection

Use this method to delete a private connectivity configuration.

The async variant is DatastreamClient::deletePrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeletePrivateConnectionRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DeletePrivateConnectionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the private connectivity configuration to delete. Please see
 *                              {@see DatastreamClient::privateConnectionName()} for help formatting this field.
 */
function delete_private_connection_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datastreamClient->deletePrivateConnection($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 = DatastreamClient::privateConnectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]'
    );

    delete_private_connection_sample($formattedName);
}

deleteRoute

Use this method to delete a route.

The async variant is DatastreamClient::deleteRouteAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteRouteRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DeleteRouteRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Route resource to delete. Please see
 *                              {@see DatastreamClient::routeName()} for help formatting this field.
 */
function delete_route_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datastreamClient->deleteRoute($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 = DatastreamClient::routeName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]',
        '[ROUTE]'
    );

    delete_route_sample($formattedName);
}

deleteStream

Use this method to delete a stream.

The async variant is DatastreamClient::deleteStreamAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteStreamRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DeleteStreamRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the stream resource to delete. Please see
 *                              {@see DatastreamClient::streamName()} for help formatting this field.
 */
function delete_stream_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datastreamClient->deleteStream($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 = DatastreamClient::streamName('[PROJECT]', '[LOCATION]', '[STREAM]');

    delete_stream_sample($formattedName);
}

discoverConnectionProfile

Use this method to discover a connection profile.

The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

The async variant is DatastreamClient::discoverConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DiscoverConnectionProfileRequest 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\Datastream\V1\DiscoverConnectionProfileResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DiscoverConnectionProfileRequest;
use Google\Cloud\Datastream\V1\DiscoverConnectionProfileResponse;

/**
 * @param string $formattedParent The parent resource of the connection profile type. Must be in
 *                                the format `projects/*/locations/*`. Please see
 *                                {@see DatastreamClient::locationName()} for help formatting this field.
 */
function discover_connection_profile_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

    discover_connection_profile_sample($formattedParent);
}

fetchStaticIps

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

The async variant is DatastreamClient::fetchStaticIpsAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\FetchStaticIpsRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\FetchStaticIpsRequest;

/**
 * @param string $formattedName The resource name for the location for which static IPs should be
 *                              returned. Must be in the format `projects/*/locations/*`. Please see
 *                              {@see DatastreamClient::locationName()} for help formatting this field.
 */
function fetch_static_ips_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

        /** @var string $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element);
        }
    } 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 = DatastreamClient::locationName('[PROJECT]', '[LOCATION]');

    fetch_static_ips_sample($formattedName);
}

getConnectionProfile

Use this method to get details about a connection profile.

The async variant is DatastreamClient::getConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetConnectionProfileRequest 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\Datastream\V1\ConnectionProfile

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ConnectionProfile;
use Google\Cloud\Datastream\V1\GetConnectionProfileRequest;

/**
 * @param string $formattedName The name of the connection profile resource to get. Please see
 *                              {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 */
function get_connection_profile_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ConnectionProfile $response */
        $response = $datastreamClient->getConnectionProfile($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 = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );

    get_connection_profile_sample($formattedName);
}

getPrivateConnection

Use this method to get details about a private connectivity configuration.

The async variant is DatastreamClient::getPrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetPrivateConnectionRequest 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\Datastream\V1\PrivateConnection

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\GetPrivateConnectionRequest;
use Google\Cloud\Datastream\V1\PrivateConnection;

/**
 * @param string $formattedName The name of the  private connectivity configuration to get. Please see
 *                              {@see DatastreamClient::privateConnectionName()} for help formatting this field.
 */
function get_private_connection_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PrivateConnection $response */
        $response = $datastreamClient->getPrivateConnection($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 = DatastreamClient::privateConnectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]'
    );

    get_private_connection_sample($formattedName);
}

getRoute

Use this method to get details about a route.

The async variant is DatastreamClient::getRouteAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetRouteRequest 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\Datastream\V1\Route

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\GetRouteRequest;
use Google\Cloud\Datastream\V1\Route;

/**
 * @param string $formattedName The name of the Route resource to get. Please see
 *                              {@see DatastreamClient::routeName()} for help formatting this field.
 */
function get_route_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Route $response */
        $response = $datastreamClient->getRoute($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 = DatastreamClient::routeName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]',
        '[ROUTE]'
    );

    get_route_sample($formattedName);
}

getStream

Use this method to get details about a stream.

The async variant is DatastreamClient::getStreamAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetStreamRequest 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\Datastream\V1\Stream

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\GetStreamRequest;
use Google\Cloud\Datastream\V1\Stream;

/**
 * @param string $formattedName The name of the stream resource to get. Please see
 *                              {@see DatastreamClient::streamName()} for help formatting this field.
 */
function get_stream_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Stream $response */
        $response = $datastreamClient->getStream($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 = DatastreamClient::streamName('[PROJECT]', '[LOCATION]', '[STREAM]');

    get_stream_sample($formattedName);
}

getStreamObject

Use this method to get details about a stream object.

The async variant is DatastreamClient::getStreamObjectAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetStreamObjectRequest 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\Datastream\V1\StreamObject

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\GetStreamObjectRequest;
use Google\Cloud\Datastream\V1\StreamObject;

/**
 * @param string $formattedName The name of the stream object resource to get. Please see
 *                              {@see DatastreamClient::streamObjectName()} for help formatting this field.
 */
function get_stream_object_sample(string $formattedName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var StreamObject $response */
        $response = $datastreamClient->getStreamObject($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 = DatastreamClient::streamObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[STREAM]',
        '[OBJECT]'
    );

    get_stream_object_sample($formattedName);
}

listConnectionProfiles

Use this method to list connection profiles created in a project and location.

The async variant is DatastreamClient::listConnectionProfilesAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListConnectionProfilesRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ConnectionProfile;
use Google\Cloud\Datastream\V1\ListConnectionProfilesRequest;

/**
 * @param string $formattedParent The parent that owns the collection of connection profiles. Please see
 *                                {@see DatastreamClient::locationName()} for help formatting this field.
 */
function list_connection_profiles_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

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

    list_connection_profiles_sample($formattedParent);
}

listPrivateConnections

Use this method to list private connectivity configurations in a project and location.

The async variant is DatastreamClient::listPrivateConnectionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListPrivateConnectionsRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ListPrivateConnectionsRequest;
use Google\Cloud\Datastream\V1\PrivateConnection;

/**
 * @param string $formattedParent The parent that owns the collection of private connectivity
 *                                configurations. Please see
 *                                {@see DatastreamClient::locationName()} for help formatting this field.
 */
function list_private_connections_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

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

    list_private_connections_sample($formattedParent);
}

listRoutes

Use this method to list routes created for a private connectivity configuration in a project and location.

The async variant is DatastreamClient::listRoutesAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListRoutesRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ListRoutesRequest;
use Google\Cloud\Datastream\V1\Route;

/**
 * @param string $formattedParent The parent that owns the collection of Routess. Please see
 *                                {@see DatastreamClient::privateConnectionName()} for help formatting this field.
 */
function list_routes_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

        /** @var Route $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 = DatastreamClient::privateConnectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[PRIVATE_CONNECTION]'
    );

    list_routes_sample($formattedParent);
}

listStreamObjects

Use this method to list the objects of a specific stream.

The async variant is DatastreamClient::listStreamObjectsAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListStreamObjectsRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ListStreamObjectsRequest;
use Google\Cloud\Datastream\V1\StreamObject;

/**
 * @param string $formattedParent The parent stream that owns the collection of objects. Please see
 *                                {@see DatastreamClient::streamName()} for help formatting this field.
 */
function list_stream_objects_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

        /** @var StreamObject $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 = DatastreamClient::streamName('[PROJECT]', '[LOCATION]', '[STREAM]');

    list_stream_objects_sample($formattedParent);
}

listStreams

Use this method to list streams in a project and location.

The async variant is DatastreamClient::listStreamsAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListStreamsRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ListStreamsRequest;
use Google\Cloud\Datastream\V1\Stream;

/**
 * @param string $formattedParent The parent that owns the collection of streams. Please see
 *                                {@see DatastreamClient::locationName()} for help formatting this field.
 */
function list_streams_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

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

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

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

    list_streams_sample($formattedParent);
}

lookupStreamObject

Use this method to look up a stream object by its source object identifier.

The async variant is DatastreamClient::lookupStreamObjectAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\LookupStreamObjectRequest 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\Datastream\V1\StreamObject

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\LookupStreamObjectRequest;
use Google\Cloud\Datastream\V1\SourceObjectIdentifier;
use Google\Cloud\Datastream\V1\StreamObject;

/**
 * @param string $formattedParent The parent stream that owns the collection of objects. Please see
 *                                {@see DatastreamClient::streamName()} for help formatting this field.
 */
function lookup_stream_object_sample(string $formattedParent): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $sourceObjectIdentifier = new SourceObjectIdentifier();
    $request = (new LookupStreamObjectRequest())
        ->setParent($formattedParent)
        ->setSourceObjectIdentifier($sourceObjectIdentifier);

    // Call the API and handle any network failures.
    try {
        /** @var StreamObject $response */
        $response = $datastreamClient->lookupStreamObject($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 = DatastreamClient::streamName('[PROJECT]', '[LOCATION]', '[STREAM]');

    lookup_stream_object_sample($formattedParent);
}

startBackfillJob

Use this method to start a backfill job for the specified stream object.

The async variant is DatastreamClient::startBackfillJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\StartBackfillJobRequest 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\Datastream\V1\StartBackfillJobResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\StartBackfillJobRequest;
use Google\Cloud\Datastream\V1\StartBackfillJobResponse;

/**
 * @param string $formattedObject The name of the stream object resource to start a backfill job
 *                                for. Please see
 *                                {@see DatastreamClient::streamObjectName()} for help formatting this field.
 */
function start_backfill_job_sample(string $formattedObject): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $request = (new StartBackfillJobRequest())
        ->setObject($formattedObject);

    // Call the API and handle any network failures.
    try {
        /** @var StartBackfillJobResponse $response */
        $response = $datastreamClient->startBackfillJob($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
{
    $formattedObject = DatastreamClient::streamObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[STREAM]',
        '[OBJECT]'
    );

    start_backfill_job_sample($formattedObject);
}

stopBackfillJob

Use this method to stop a backfill job for the specified stream object.

The async variant is DatastreamClient::stopBackfillJobAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\StopBackfillJobRequest 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\Datastream\V1\StopBackfillJobResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\StopBackfillJobRequest;
use Google\Cloud\Datastream\V1\StopBackfillJobResponse;

/**
 * @param string $formattedObject The name of the stream object resource to stop the backfill job
 *                                for. Please see
 *                                {@see DatastreamClient::streamObjectName()} for help formatting this field.
 */
function stop_backfill_job_sample(string $formattedObject): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $request = (new StopBackfillJobRequest())
        ->setObject($formattedObject);

    // Call the API and handle any network failures.
    try {
        /** @var StopBackfillJobResponse $response */
        $response = $datastreamClient->stopBackfillJob($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
{
    $formattedObject = DatastreamClient::streamObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[STREAM]',
        '[OBJECT]'
    );

    stop_backfill_job_sample($formattedObject);
}

updateConnectionProfile

Use this method to update the parameters of a connection profile.

The async variant is DatastreamClient::updateConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\UpdateConnectionProfileRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\ConnectionProfile;
use Google\Cloud\Datastream\V1\UpdateConnectionProfileRequest;
use Google\Rpc\Status;

/**
 * @param string $connectionProfileDisplayName Display name.
 */
function update_connection_profile_sample(string $connectionProfileDisplayName): void
{
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $connectionProfile = (new ConnectionProfile())
        ->setDisplayName($connectionProfileDisplayName);
    $request = (new UpdateConnectionProfileRequest())
        ->setConnectionProfile($connectionProfile);

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

        if ($response->operationSucceeded()) {
            /** @var ConnectionProfile $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
{
    $connectionProfileDisplayName = '[DISPLAY_NAME]';

    update_connection_profile_sample($connectionProfileDisplayName);
}

updateStream

Use this method to update the configuration of a stream.

The async variant is DatastreamClient::updateStreamAsync() .

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\UpdateStreamRequest 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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Datastream\V1\DestinationConfig;
use Google\Cloud\Datastream\V1\SourceConfig;
use Google\Cloud\Datastream\V1\Stream;
use Google\Cloud\Datastream\V1\UpdateStreamRequest;
use Google\Rpc\Status;

/**
 * @param string $streamDisplayName                                            Display name.
 * @param string $formattedStreamSourceConfigSourceConnectionProfile           Source connection profile resoource.
 *                                                                             Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
 *                                                                             Please see {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 * @param string $formattedStreamDestinationConfigDestinationConnectionProfile Destination connection profile resource.
 *                                                                             Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
 *                                                                             Please see {@see DatastreamClient::connectionProfileName()} for help formatting this field.
 */
function update_stream_sample(
    string $streamDisplayName,
    string $formattedStreamSourceConfigSourceConnectionProfile,
    string $formattedStreamDestinationConfigDestinationConnectionProfile
): void {
    // Create a client.
    $datastreamClient = new DatastreamClient();

    // Prepare the request message.
    $streamSourceConfig = (new SourceConfig())
        ->setSourceConnectionProfile($formattedStreamSourceConfigSourceConnectionProfile);
    $streamDestinationConfig = (new DestinationConfig())
        ->setDestinationConnectionProfile($formattedStreamDestinationConfigDestinationConnectionProfile);
    $stream = (new Stream())
        ->setDisplayName($streamDisplayName)
        ->setSourceConfig($streamSourceConfig)
        ->setDestinationConfig($streamDestinationConfig);
    $request = (new UpdateStreamRequest())
        ->setStream($stream);

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

        if ($response->operationSucceeded()) {
            /** @var Stream $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
{
    $streamDisplayName = '[DISPLAY_NAME]';
    $formattedStreamSourceConfigSourceConnectionProfile = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );
    $formattedStreamDestinationConfigDestinationConnectionProfile = DatastreamClient::connectionProfileName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONNECTION_PROFILE]'
    );

    update_stream_sample(
        $streamDisplayName,
        $formattedStreamSourceConfigSourceConnectionProfile,
        $formattedStreamDestinationConfigDestinationConnectionProfile
    );
}

getLocation

Gets information about a location.

The async variant is DatastreamClient::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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $datastreamClient->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 DatastreamClient::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\Datastream\V1\Client\DatastreamClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $datastreamClient->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());
    }
}

createConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateConnectionProfileRequest
optionalArgs	array

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

createPrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreatePrivateConnectionRequest
optionalArgs	array

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

createRouteAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateRouteRequest
optionalArgs	array

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

createStreamAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\CreateStreamRequest
optionalArgs	array

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

deleteConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteConnectionProfileRequest
optionalArgs	array

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

deletePrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeletePrivateConnectionRequest
optionalArgs	array

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

deleteRouteAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteRouteRequest
optionalArgs	array

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

deleteStreamAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DeleteStreamRequest
optionalArgs	array

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

discoverConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\DiscoverConnectionProfileRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\DiscoverConnectionProfileResponse>

fetchStaticIpsAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\FetchStaticIpsRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetConnectionProfileRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\ConnectionProfile>

getPrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetPrivateConnectionRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\PrivateConnection>

getRouteAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetRouteRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\Route>

getStreamAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetStreamRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\Stream>

getStreamObjectAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\GetStreamObjectRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\StreamObject>

listConnectionProfilesAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListConnectionProfilesRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listPrivateConnectionsAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListPrivateConnectionsRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listRoutesAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListRoutesRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listStreamObjectsAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListStreamObjectsRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listStreamsAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\ListStreamsRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

lookupStreamObjectAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\LookupStreamObjectRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\StreamObject>

startBackfillJobAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\StartBackfillJobRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\StartBackfillJobResponse>

stopBackfillJobAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\StopBackfillJobRequest
optionalArgs	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Datastream\V1\StopBackfillJobResponse>

updateConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\UpdateConnectionProfileRequest
optionalArgs	array

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

updateStreamAsync

Parameters
Name	Description
request	Google\Cloud\Datastream\V1\UpdateStreamRequest
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::connectionProfileName

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

Parameters
Name	Description
project	string
location	string
connectionProfile	string

Returns
Type	Description
string	The formatted connection_profile 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::networksName

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

Parameters
Name	Description
project	string
network	string

Returns
Type	Description
string	The formatted networks resource.

static::privateConnectionName

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

Parameters
Name	Description
project	string
location	string
privateConnection	string

Returns
Type	Description
string	The formatted private_connection resource.

static::routeName

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

Parameters
Name	Description
project	string
location	string
privateConnection	string
route	string

Returns
Type	Description
string	The formatted route resource.

static::streamName

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

Parameters
Name	Description
project	string
location	string
stream	string

Returns
Type	Description
string	The formatted stream resource.

static::streamObjectName

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

Parameters
Name	Description
project	string
location	string
stream	string
object	string

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

• connectionProfile: projects/{project}/locations/{location}/connectionProfiles/{connection_profile}
• location: projects/{project}/locations/{location}
• networks: projects/{project}/global/networks/{network}
• privateConnection: projects/{project}/locations/{location}/privateConnections/{private_connection}
• route: projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}
• stream: projects/{project}/locations/{location}/streams/{stream}
• streamObject: projects/{project}/locations/{location}/streams/{stream}/objects/{object}

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.