Method: projects.locations.clusters.streams.getThumbnail

Gets the thumbnail (image snapshot) of a single Stream.

HTTP request

POST https://{endpoint}/v1alpha1/{stream=projects/*/locations/*/clusters/*/streams/*}:getThumbnail

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
stream

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "gcsObjectName": string,
  "event": string,
  "requestId": string
}
Fields
gcsObjectName

string

Required. The name of the Google Cloud Storage 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.
requestId

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).

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.