Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class StreamingServiceClient.
Service Description: Streaming service for receiving and sending packets.
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 \ VisionAI \ V1 \ ClientMethods
__construct
Constructor.
options
array| Google\ApiCore\Options\ClientOptions
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface
or Google\ApiCore\CredentialsWrapper
object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\VisionAI\V1\StreamingServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new StreamingServiceClient(['credentials' => $creds]);
https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
↳ logger
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
↳ universeDomain
string
The service domain for the client. Defaults to 'googleapis.com'.
acquireLease
AcquireLease acquires a lease.
The async variant is StreamingServiceClient::acquireLeaseAsync() .
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.
use Google\ApiCore\ApiException;
use Google\Cloud\VisionAI\V1\AcquireLeaseRequest;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\Lease;
/**
* 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 acquire_lease_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new AcquireLeaseRequest();
// Call the API and handle any network failures.
try {
/** @var Lease $response */
$response = $streamingServiceClient->acquireLease($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
receiveEvents
Receive events given the stream name.
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\ReceiveEventsRequest;
use Google\Cloud\VisionAI\V1\ReceiveEventsResponse;
/**
* 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 receive_events_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new ReceiveEventsRequest();
// Call the API and handle any network failures.
try {
/** @var BidiStream $stream */
$stream = $streamingServiceClient->receiveEvents();
$stream->writeAll([$request,]);
/** @var ReceiveEventsResponse $element */
foreach ($stream->closeWriteAndReadAll() as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
receivePackets
Receive packets from the series.
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\ReceivePacketsRequest;
use Google\Cloud\VisionAI\V1\ReceivePacketsResponse;
/**
* 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 receive_packets_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new ReceivePacketsRequest();
// Call the API and handle any network failures.
try {
/** @var BidiStream $stream */
$stream = $streamingServiceClient->receivePackets();
$stream->writeAll([$request,]);
/** @var ReceivePacketsResponse $element */
foreach ($stream->closeWriteAndReadAll() as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
releaseLease
RleaseLease releases a lease.
The async variant is StreamingServiceClient::releaseLeaseAsync() .
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.
use Google\ApiCore\ApiException;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\ReleaseLeaseRequest;
use Google\Cloud\VisionAI\V1\ReleaseLeaseResponse;
/**
* 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 release_lease_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new ReleaseLeaseRequest();
// Call the API and handle any network failures.
try {
/** @var ReleaseLeaseResponse $response */
$response = $streamingServiceClient->releaseLease($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
renewLease
RenewLease renews a lease.
The async variant is StreamingServiceClient::renewLeaseAsync() .
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.
use Google\ApiCore\ApiException;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\Lease;
use Google\Cloud\VisionAI\V1\RenewLeaseRequest;
/**
* 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 renew_lease_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new RenewLeaseRequest();
// Call the API and handle any network failures.
try {
/** @var Lease $response */
$response = $streamingServiceClient->renewLease($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
sendPackets
Send packets to the series.
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
use Google\Cloud\VisionAI\V1\SendPacketsRequest;
use Google\Cloud\VisionAI\V1\SendPacketsResponse;
/**
* 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 send_packets_sample(): void
{
// Create a client.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new SendPacketsRequest();
// Call the API and handle any network failures.
try {
/** @var BidiStream $stream */
$stream = $streamingServiceClient->sendPackets();
$stream->writeAll([$request,]);
/** @var SendPacketsResponse $element */
foreach ($stream->closeWriteAndReadAll() as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getLocation
Gets information about a location.
The async variant is StreamingServiceClient::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.
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
/**
* 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.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $streamingServiceClient->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 StreamingServiceClient::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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\VisionAI\V1\Client\StreamingServiceClient;
/**
* 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.
$streamingServiceClient = new StreamingServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $streamingServiceClient->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());
}
}
acquireLeaseAsync
releaseLeaseAsync
renewLeaseAsync
getLocationAsync
listLocationsAsync
static::seriesName
Formats a string containing the fully-qualified path to represent a series resource.
project
string
location
string
cluster
string
series
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
- series: projects/{project}/locations/{location}/clusters/{cluster}/series/{series}
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
