Cloud Pub/Sub v1 API - Class CreateSnapshotRequest (3.18.0)

public sealed class CreateSnapshotRequest : IMessage<CreateSnapshotRequest>, IEquatable<CreateSnapshotRequest>, IDeepCloneable<CreateSnapshotRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class CreateSnapshotRequest.

Request for the CreateSnapshot method.

Inheritance

object > CreateSnapshotRequest

Implements

IMessage CreateSnapshotRequest, IEquatable CreateSnapshotRequest, IDeepCloneable CreateSnapshotRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

CreateSnapshotRequest()

public CreateSnapshotRequest()

CreateSnapshotRequest(CreateSnapshotRequest)

public CreateSnapshotRequest(CreateSnapshotRequest other)

Parameter
Name	Description
`other`	`CreateSnapshotRequest`

Properties

Labels

public MapField<string, string> Labels { get; }

Optional. See Creating and managing labels.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

SnapshotName

public SnapshotName SnapshotName { get; set; }

SnapshotName-typed view over the Name resource name property.

Property Value
Type	Description
`SnapshotName`

Subscription

public string Subscription { get; set; }

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

Property Value
Type	Description
`string`

SubscriptionAsSubscriptionName

public SubscriptionName SubscriptionAsSubscriptionName { get; set; }

SubscriptionName-typed view over the Subscription resource name property.

Property Value
Type	Description
`SubscriptionName`