Cloud PubSub V1 Client - Class GetSnapshotRequest (2.6.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class GetSnapshotRequest.

Request for the GetSnapshot method.

Generated from protobuf message google.pubsub.v1.GetSnapshotRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ snapshot string

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

getSnapshot

Required. The name of the snapshot to get.

Format is projects/{project}/snapshots/{snap}.

Returns
Type Description
string

setSnapshot

Required. The name of the snapshot to get.

Format is projects/{project}/snapshots/{snap}.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
snapshot string

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}. Please see Google\Cloud\PubSub\V1\SubscriberClient::snapshotName() for help formatting this field.
Returns
Type Description
Google\Cloud\PubSub\V1\GetSnapshotRequest