Class ProjectsResource.SnapshotsResource

The "snapshots" collection of methods.

Inheritance

object

ProjectsResource.SnapshotsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Pubsub.v1

Assembly: Google.Apis.Pubsub.v1.dll

Syntax

public class ProjectsResource.SnapshotsResource

Constructors

SnapshotsResource(IClientService)

Constructs a new resource.

Declaration

public SnapshotsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(CreateSnapshotRequest, string)

Creates a snapshot from the requested subscription. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. 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, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Declaration

public virtual ProjectsResource.SnapshotsResource.CreateRequest Create(CreateSnapshotRequest body, string name)

Parameters

Type	Name	Description
CreateSnapshotRequest	body	The body of the request.
string	name	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
ProjectsResource.SnapshotsResource.CreateRequest

Delete(string)

Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Declaration

public virtual ProjectsResource.SnapshotsResource.DeleteRequest Delete(string snapshot)

Parameters

Type	Name	Description
string	snapshot	Required. The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

Returns

Type	Description
ProjectsResource.SnapshotsResource.DeleteRequest

Get(string)

Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Declaration

public virtual ProjectsResource.SnapshotsResource.GetRequest Get(string snapshot)

Parameters

Type	Name	Description
string	snapshot	Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

Returns

Type	Description
ProjectsResource.SnapshotsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.SnapshotsResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SnapshotsResource.GetIamPolicyRequest

List(string)

Lists the existing snapshots. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Declaration

public virtual ProjectsResource.SnapshotsResource.ListRequest List(string project)

Parameters

Type	Name	Description
string	project	Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

Returns

Type	Description
ProjectsResource.SnapshotsResource.ListRequest

Patch(UpdateSnapshotRequest, string)

Updates an existing snapshot by updating the fields specified in the update mask. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Declaration

public virtual ProjectsResource.SnapshotsResource.PatchRequest Patch(UpdateSnapshotRequest body, string name)

Parameters

Type	Name	Description
UpdateSnapshotRequest	body	The body of the request.
string	name	Optional. The name of the snapshot.

Returns

Type	Description
ProjectsResource.SnapshotsResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.SnapshotsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SnapshotsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.SnapshotsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SnapshotsResource.TestIamPermissionsRequest