All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.pubsub.Pubsub.Projects.Snapshots.html Maven / Gradle / Ivy

There is a newer version: v1-rev20240730-2.0.0
Show newest version






Pubsub.Projects.Snapshots (Cloud Pub/Sub API v1-rev20240918-2.0.0)












com.google.api.services.pubsub

Class Pubsub.Projects.Snapshots

  • Enclosing class:
    Pubsub.Projects


    public class Pubsub.Projects.Snapshots
    extends Object
    The "snapshots" collection of methods.
    • Constructor Detail

      • Snapshots

        public Snapshots()
    • Method Detail

      • create

        public Pubsub.Projects.Snapshots.Create create(String name,
                                                       CreateSnapshotRequest content)
                                                throws IOException
        Creates a snapshot from the requested subscription. 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. 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. Create a request for the method "snapshots.create". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        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](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project}/snapshots/{snap}`.
        content - the CreateSnapshotRequest
        Returns:
        the request
        Throws:
        IOException
      • delete

        public Pubsub.Projects.Snapshots.Delete delete(String snapshot)
                                                throws IOException
        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. Create a request for the method "snapshots.delete". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        snapshot - Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.
        Returns:
        the request
        Throws:
        IOException
      • get

        public Pubsub.Projects.Snapshots.Get get(String snapshot)
                                          throws IOException
        Gets the configuration details of a 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. Create a request for the method "snapshots.get". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        snapshot - Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`.
        Returns:
        the request
        Throws:
        IOException
      • getIamPolicy

        public Pubsub.Projects.Snapshots.GetIamPolicy getIamPolicy(String resource)
                                                            throws IOException
        Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "snapshots.getIamPolicy". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
        Returns:
        the request
        Throws:
        IOException
      • list

        public Pubsub.Projects.Snapshots.List list(String project)
                                            throws IOException
        Lists the existing snapshots. 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. Create a request for the method "snapshots.list". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        project - Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`.
        Returns:
        the request
        Throws:
        IOException
      • patch

        public Pubsub.Projects.Snapshots.Patch patch(String name,
                                                     UpdateSnapshotRequest content)
                                              throws IOException
        Updates an existing snapshot by updating the fields specified in the update mask. 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. Create a request for the method "snapshots.patch". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        name - Optional. The name of the snapshot.
        content - the UpdateSnapshotRequest
        Returns:
        the request
        Throws:
        IOException
      • setIamPolicy

        public Pubsub.Projects.Snapshots.SetIamPolicy setIamPolicy(String resource,
                                                                   SetIamPolicyRequest content)
                                                            throws IOException
        Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "snapshots.setIamPolicy". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
        content - the SetIamPolicyRequest
        Returns:
        the request
        Throws:
        IOException
      • testIamPermissions

        public Pubsub.Projects.Snapshots.TestIamPermissions testIamPermissions(String resource,
                                                                               TestIamPermissionsRequest content)
                                                                        throws IOException
        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. Create a request for the method "snapshots.testIamPermissions". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
        Parameters:
        resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
        content - the TestIamPermissionsRequest
        Returns:
        the request
        Throws:
        IOException

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy