Cloud PubSub V1 Client - Class UpdateSnapshotRequest (1.44.0)

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

Request for the UpdateSnapshot method.

Generated from protobuf message google.pubsub.v1.UpdateSnapshotRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ snapshot Google\Cloud\PubSub\V1\Snapshot

Required. The updated snapshot object.

↳ update_mask Google\Protobuf\FieldMask

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

getSnapshot

Required. The updated snapshot object.

Returns
TypeDescription
Google\Cloud\PubSub\V1\Snapshot|null

hasSnapshot

clearSnapshot

setSnapshot

Required. The updated snapshot object.

Parameter
NameDescription
var Google\Cloud\PubSub\V1\Snapshot
Returns
TypeDescription
$this

getUpdateMask

Required. Indicates which fields in the provided snapshot to update.

Must be specified and non-empty.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Indicates which fields in the provided snapshot to update.

Must be specified and non-empty.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
snapshot Google\Cloud\PubSub\V1\Snapshot

Required. The updated snapshot object.

updateMask Google\Protobuf\FieldMask

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

Returns
TypeDescription
Google\Cloud\PubSub\V1\UpdateSnapshotRequest