CreateSnapshotRequest
class CreateSnapshotRequest extends Message
Request for the CreateSnapshot method.
Protobuf type Google\Pubsub\V1\CreateSnapshotRequest
Methods
No description
Optional user-provided name for this snapshot.
Optional user-provided name for this snapshot.
The subscription whose backlog the snapshot retains.
The subscription whose backlog the snapshot retains.
Details
at line 43
__construct()
at line 58
string
getName()
Optional user-provided name for this snapshot.
If the name is not provided in the request, the server will assign a random
name for this snapshot on the same project as the subscription.
Note that for REST API requests, you must specify a name.
Format is projects/{project}/snapshots/{snap}.
Generated from protobuf field string name = 1;
at line 73
setName(string $var)
Optional user-provided name for this snapshot.
If the name is not provided in the request, the server will assign a random
name for this snapshot on the same project as the subscription.
Note that for REST API requests, you must specify a name.
Format is projects/{project}/snapshots/{snap}.
Generated from protobuf field string name = 1;
at line 93
string
getSubscription()
The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of the
CreateSnapshot request; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format is projects/{project}/subscriptions/{sub}.
Generated from protobuf field string subscription = 2;
at line 112
setSubscription(string $var)
The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of the
CreateSnapshot request; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format is projects/{project}/subscriptions/{sub}.
Generated from protobuf field string subscription = 2;