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
Methods
__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.
Generated from protobuf field .google.pubsub.v1.Snapshot snapshot = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\Snapshot|null | |
hasSnapshot
clearSnapshot
setSnapshot
Required. The updated snapshot object.
Generated from protobuf field .google.pubsub.v1.Snapshot snapshot = 1 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |