Cloud PubSub V1 Client - Class UpdateSnapshotRequest (2.3.0)
Stay organized with collections
Save and categorize content based on your preferences.
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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\Snapshot|null |
|
hasSnapshot
clearSnapshot
setSnapshot
Required. The updated snapshot object.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\PubSub\V1\Snapshot
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateMask
Required. Indicates which fields in the provided snapshot to update.
Must be specified and non-empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
Required. Indicates which fields in the provided snapshot to update.
Must be specified and non-empty.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\UpdateSnapshotRequest |
|