Reference documentation and code samples for the Google Cloud Datastream V1 Client class DatastreamClient.
Service Description: Datastream service
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Datastream \ V1 \ ClientMethods
__construct
Constructor.
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 Google\Cloud\Datastream\V1\Client\BaseClient\self::createConnectionProfileAsync() .
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.
createPrivateConnection
Use this method to create a private connectivity configuration.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::createPrivateConnectionAsync() .
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.
createRoute
Use this method to create a route for a private connectivity configuration in a project and location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::createRouteAsync() .
request
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.
createStream
Use this method to create a stream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::createStreamAsync() .
request
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.
deleteConnectionProfile
Use this method to delete a connection profile.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::deleteConnectionProfileAsync() .
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.
deletePrivateConnection
Use this method to delete a private connectivity configuration.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::deletePrivateConnectionAsync() .
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.
deleteRoute
Use this method to delete a route.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::deleteRouteAsync() .
request
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.
deleteStream
Use this method to delete a stream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::deleteStreamAsync() .
request
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.
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 Google\Cloud\Datastream\V1\Client\BaseClient\self::discoverConnectionProfileAsync() .
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.
fetchStaticIps
The FetchStaticIps API call exposes the static IP addresses used by Datastream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::fetchStaticIpsAsync() .
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.
getConnectionProfile
Use this method to get details about a connection profile.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getConnectionProfileAsync() .
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.
getPrivateConnection
Use this method to get details about a private connectivity configuration.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getPrivateConnectionAsync() .
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.
getRoute
Use this method to get details about a route.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getRouteAsync() .
request
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.
getStream
Use this method to get details about a stream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getStreamAsync() .
request
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.
getStreamObject
Use this method to get details about a stream object.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getStreamObjectAsync() .
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.
listConnectionProfiles
Use this method to list connection profiles created in a project and location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listConnectionProfilesAsync() .
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.
listPrivateConnections
Use this method to list private connectivity configurations in a project and location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listPrivateConnectionsAsync() .
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.
listRoutes
Use this method to list routes created for a private connectivity configuration in a project and location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listRoutesAsync() .
request
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.
listStreamObjects
Use this method to list the objects of a specific stream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listStreamObjectsAsync() .
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.
listStreams
Use this method to list streams in a project and location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listStreamsAsync() .
request
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.
lookupStreamObject
Use this method to look up a stream object by its source object identifier.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::lookupStreamObjectAsync() .
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.
startBackfillJob
Use this method to start a backfill job for the specified stream object.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::startBackfillJobAsync() .
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.
stopBackfillJob
Use this method to stop a backfill job for the specified stream object.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::stopBackfillJobAsync() .
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.
updateConnectionProfile
Use this method to update the parameters of a connection profile.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::updateConnectionProfileAsync() .
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.
updateStream
Use this method to update the configuration of a stream.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::updateStreamAsync() .
request
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Datastream\V1\Client\BaseClient\self::listLocationsAsync() .
request
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.
createConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createPrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createRouteAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createStreamAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deletePrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteRouteAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteStreamAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
discoverConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
fetchStaticIpsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getPrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getRouteAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getStreamAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getStreamObjectAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listConnectionProfilesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listPrivateConnectionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listRoutesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listStreamObjectsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listStreamsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
lookupStreamObjectAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
startBackfillJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
stopBackfillJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateStreamAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::connectionProfileName
Formats a string containing the fully-qualified path to represent a connection_profile resource.
project
string
location
string
connectionProfile
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::networksName
Formats a string containing the fully-qualified path to represent a networks resource.
project
string
network
string
string
static::privateConnectionName
Formats a string containing the fully-qualified path to represent a private_connection resource.
project
string
location
string
privateConnection
string
string
static::routeName
Formats a string containing the fully-qualified path to represent a route resource.
project
string
location
string
privateConnection
string
route
string
string
static::streamName
Formats a string containing the fully-qualified path to represent a stream resource.
project
string
location
string
stream
string
string
static::streamObjectName
Formats a string containing the fully-qualified path to represent a stream_object resource.
project
string
location
string
stream
string
object
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
