Cloud PubSub V1 Client - Class CreateSnapshotRequest (2.8.0)

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

Request for the CreateSnapshot method.

Generated from protobuf message google.pubsub.v1.CreateSnapshotRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. 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. See the resource name rules. Format is projects/{project}/snapshots/{snap}.
↳ subscription string

Required. 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}.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. See Creating and managing labels.

getName

Required. 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. See the resource name rules.

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

Returns
Type Description
string

setName

Required. 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. See the resource name rules.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSubscription

Required. 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}.

Returns
Type Description
string

setSubscription

Required. 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}.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. See Creating and managing labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. See Creating and managing labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. 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. See the resource name rules. Format is projects/{project}/snapshots/{snap}. Please see Google\Cloud\PubSub\V1\SubscriberClient::snapshotName() for help formatting this field.
subscription string

Required. 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}. Please see Google\Cloud\PubSub\V1\SubscriberClient::subscriptionName() for help formatting this field.
Returns
Type Description
Google\Cloud\PubSub\V1\CreateSnapshotRequest