Google Cloud Vision Ai V1 Client - Class GetStreamThumbnailRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class GetStreamThumbnailRequest.

Message for getting the thumbnail of a Stream.

Generated from protobuf message google.cloud.visionai.v1.GetStreamThumbnailRequest

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ stream
string

Required. The name of the stream for to get the thumbnail from.

↳ gcs_object_name
string

Required. The name of the GCS object to store the thumbnail image.

↳ event
string

Optional. The name of the event. If unspecified, the thumbnail will be retrieved from the latest event.

↳ request_id
string

Optional. An optional request ID to identify the requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getStream

Required. The name of the stream for to get the thumbnail from.

Returns
Type
Description
string

setStream

Required. The name of the stream for to get the thumbnail from.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGcsObjectName

Required. The name of the GCS object to store the thumbnail image.

Returns
Type
Description
string

setGcsObjectName

Required. The name of the GCS object to store the thumbnail image.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEvent

Optional. The name of the event. If unspecified, the thumbnail will be retrieved from the latest event.

Returns
Type
Description
string

setEvent

Optional. The name of the event. If unspecified, the thumbnail will be retrieved from the latest event.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRequestId

Optional. An optional request ID to identify the requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type
Description
string

setRequestId

Optional. An optional request ID to identify the requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameters
Name
Description
stream
string

Required. The name of the stream for to get the thumbnail from.

gcsObjectName
string

Required. The name of the GCS object to store the thumbnail image.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: