SubscriptionAdminClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.pubsub.v1.SubscriptionAdminClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
public class SubscriptionAdminClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the `Pull` method or by establishing a bi-directional stream using the `StreamingPull` method.
To retrieve messages from a subscription, see the Subscriber class.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
   ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
   ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
   PushConfig pushConfig = PushConfig.newBuilder().build();
   int ackDeadlineSeconds = 0;
   Subscription response = subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);
 }
 
 
```
Note: close() needs to be called on the subscriptionAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SubscriptionAdminSettings to create(). For example:
To customize credentials:
```
 
 SubscriptionAdminSettings subscriptionAdminSettings =
     SubscriptionAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SubscriptionAdminClient subscriptionAdminClient =
     SubscriptionAdminClient.create(subscriptionAdminSettings);
 
 
```
To customize the endpoint:
```
 
 SubscriptionAdminSettings subscriptionAdminSettings =
     SubscriptionAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 SubscriptionAdminClient subscriptionAdminClient =
     SubscriptionAdminClient.create(subscriptionAdminSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubscriptionAdminClient.ListSnapshotsFixedSizeCollection`
`static class`	`SubscriptionAdminClient.ListSnapshotsPage`
`static class`	`SubscriptionAdminClient.ListSnapshotsPagedResponse`
`static class`	`SubscriptionAdminClient.ListSubscriptionsFixedSizeCollection`
`static class`	`SubscriptionAdminClient.ListSubscriptionsPage`
`static class`	`SubscriptionAdminClient.ListSubscriptionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SubscriptionAdminClient(SubscriberStub stub)`
`protected`	`SubscriptionAdminClient(SubscriptionAdminSettings settings)` Constructs an instance of SubscriptionAdminClient, using the given settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SubscriptionAdminClient`	`create()` Constructs an instance of SubscriptionAdminClient with default settings.
`static SubscriptionAdminClient`	`create(SubscriberStub stub)` Constructs an instance of SubscriptionAdminClient, using the given stub for making calls.
`static SubscriptionAdminClient`	`create(SubscriptionAdminSettings settings)` Constructs an instance of SubscriptionAdminClient, using the given settings.
`Snapshot`	`createSnapshot(CreateSnapshotRequest request)` Creates a snapshot from the requested subscription.
`Snapshot`	`createSnapshot(ProjectSnapshotName name, ProjectSubscriptionName subscription)` Creates a snapshot from the requested subscription.
`Snapshot`	`createSnapshot(String name, String subscription)` Creates a snapshot from the requested subscription.
`com.google.api.gax.rpc.UnaryCallable<CreateSnapshotRequest,Snapshot>`	`createSnapshotCallable()` Creates a snapshot from the requested subscription.
`Subscription`	`createSubscription(ProjectSubscriptionName name, ProjectTopicName topic, PushConfig pushConfig, int ackDeadlineSeconds)` Creates a subscription to a given topic.
`Subscription`	`createSubscription(String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds)` Creates a subscription to a given topic.
`Subscription`	`createSubscription(Subscription request)` Creates a subscription to a given topic.
`com.google.api.gax.rpc.UnaryCallable<Subscription,Subscription>`	`createSubscriptionCallable()` Creates a subscription to a given topic.
`void`	`deleteSnapshot(DeleteSnapshotRequest request)` Removes an existing snapshot.
`void`	`deleteSnapshot(ProjectSnapshotName snapshot)` Removes an existing snapshot.
`void`	`deleteSnapshot(String snapshot)` Removes an existing snapshot.
`com.google.api.gax.rpc.UnaryCallable<DeleteSnapshotRequest,Empty>`	`deleteSnapshotCallable()` Removes an existing snapshot.
`void`	`deleteSubscription(DeleteSubscriptionRequest request)` Deletes an existing subscription.
`void`	`deleteSubscription(ProjectSubscriptionName subscription)` Deletes an existing subscription.
`void`	`deleteSubscription(String subscription)` Deletes an existing subscription.
`com.google.api.gax.rpc.UnaryCallable<DeleteSubscriptionRequest,Empty>`	`deleteSubscriptionCallable()` Deletes an existing subscription.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`SubscriptionAdminSettings`	`getSettings()`
`SubscriberStub`	`getStub()`
`Subscription`	`getSubscription(GetSubscriptionRequest request)` Gets the configuration details of a subscription.
`Subscription`	`getSubscription(ProjectSubscriptionName subscription)` Gets the configuration details of a subscription.
`Subscription`	`getSubscription(String subscription)` Gets the configuration details of a subscription.
`com.google.api.gax.rpc.UnaryCallable<GetSubscriptionRequest,Subscription>`	`getSubscriptionCallable()` Gets the configuration details of a subscription.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SubscriptionAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(ListSnapshotsRequest request)` Lists the existing snapshots.
`SubscriptionAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(ProjectName project)` Lists the existing snapshots.
`SubscriptionAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(String project)` Lists the existing snapshots.
`com.google.api.gax.rpc.UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse>`	`listSnapshotsCallable()` Lists the existing snapshots.
`com.google.api.gax.rpc.UnaryCallable<ListSnapshotsRequest,SubscriptionAdminClient.ListSnapshotsPagedResponse>`	`listSnapshotsPagedCallable()` Lists the existing snapshots.
`SubscriptionAdminClient.ListSubscriptionsPagedResponse`	`listSubscriptions(ListSubscriptionsRequest request)` Lists matching subscriptions.
`SubscriptionAdminClient.ListSubscriptionsPagedResponse`	`listSubscriptions(ProjectName project)` Lists matching subscriptions.
`SubscriptionAdminClient.ListSubscriptionsPagedResponse`	`listSubscriptions(String project)` Lists matching subscriptions.
`com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse>`	`listSubscriptionsCallable()` Lists matching subscriptions.
`com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,SubscriptionAdminClient.ListSubscriptionsPagedResponse>`	`listSubscriptionsPagedCallable()` Lists matching subscriptions.
`void`	`modifyPushConfig(ModifyPushConfigRequest request)` Modifies the `PushConfig` for a specified subscription.
`void`	`modifyPushConfig(ProjectSubscriptionName subscription, PushConfig pushConfig)` Modifies the `PushConfig` for a specified subscription.
`void`	`modifyPushConfig(String subscription, PushConfig pushConfig)` Modifies the `PushConfig` for a specified subscription.
`com.google.api.gax.rpc.UnaryCallable<ModifyPushConfigRequest,Empty>`	`modifyPushConfigCallable()` Modifies the `PushConfig` for a specified subscription.
`SeekResponse`	`seek(SeekRequest request)` Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
`com.google.api.gax.rpc.UnaryCallable<SeekRequest,SeekResponse>`	`seekCallable()` Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource, com.google.iam.v1.Policy policy)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns permissions that a caller has on the specified resource.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`Snapshot`	`updateSnapshot(UpdateSnapshotRequest request)` Updates an existing snapshot.
`com.google.api.gax.rpc.UnaryCallable<UpdateSnapshotRequest,Snapshot>`	`updateSnapshotCallable()` Updates an existing snapshot.
`Subscription`	`updateSubscription(UpdateSubscriptionRequest request)` Updates an existing subscription.
`com.google.api.gax.rpc.UnaryCallable<UpdateSubscriptionRequest,Subscription>`	`updateSubscriptionCallable()` Updates an existing subscription.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - SubscriptionAdminClient
```
protected SubscriptionAdminClient(SubscriptionAdminSettings settings)
 throws IOException
```
 Constructs an instance of SubscriptionAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
 
 Throws:
 
 IOException
 - SubscriptionAdminClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SubscriptionAdminClient(SubscriberStub stub)
```
- Method Detail
 - create
```
public static final SubscriptionAdminClient create()
 throws IOException
```
 Constructs an instance of SubscriptionAdminClient with default settings.
 
 Throws:
 
 IOException
 - create
```
public static final SubscriptionAdminClient create(SubscriptionAdminSettings settings)
 throws IOException
```
 Constructs an instance of SubscriptionAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
 
 Throws:
 
 IOException
 - create
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final SubscriptionAdminClient create(SubscriberStub stub)
```
 Constructs an instance of SubscriptionAdminClient, using the given stub for making calls. This is for advanced usage - prefer to use SubscriptionAdminSettings}.
 - getSettings
```
public final SubscriptionAdminSettings getSettings()
```
 - getStub
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SubscriberStub getStub()
```
 - createSubscription
```
public final Subscription createSubscription(ProjectSubscriptionName name,
 ProjectTopicName topic,
 PushConfig pushConfig,
 int ackDeadlineSeconds)
```
 Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 int ackDeadlineSeconds = 0;
 Subscription response = subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);
 }
 
```
 Parameters:
 
 name - The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`
 
 topic - The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.
 
 pushConfig - If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
 
 ackDeadlineSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSubscription
```
public final Subscription createSubscription(String name,
 String topic,
 PushConfig pushConfig,
 int ackDeadlineSeconds)
```
 Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 int ackDeadlineSeconds = 0;
 Subscription response = subscriptionAdminClient.createSubscription(name.toString(), topic.toString(), pushConfig, ackDeadlineSeconds);
 }
 
```
 Parameters:
 
 name - The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`
 
 topic - The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.
 
 pushConfig - If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
 
 ackDeadlineSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSubscription
```
public final Subscription createSubscription(Subscription request)
```
 Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 TopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
 Subscription request = Subscription.newBuilder()
 .setName(name.toString())
 .setTopic(topic.toString())
 .build();
 Subscription response = subscriptionAdminClient.createSubscription(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSubscriptionCallable
```
public final com.google.api.gax.rpc.UnaryCallable<Subscription,Subscription> createSubscriptionCallable()
```
 Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 TopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
 Subscription request = Subscription.newBuilder()
 .setName(name.toString())
 .setTopic(topic.toString())
 .build();
 ApiFuture<Subscription> future = subscriptionAdminClient.createSubscriptionCallable().futureCall(request);
 // Do something
 Subscription response = future.get();
 }
 
```
 - getSubscription
```
public final Subscription getSubscription(ProjectSubscriptionName subscription)
```
 Gets the configuration details of a subscription.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 Subscription response = subscriptionAdminClient.getSubscription(subscription);
 }
 
```
 Parameters:
 
 subscription - The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - getSubscription
```
public final Subscription getSubscription(String subscription)
```
 Gets the configuration details of a subscription.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 Subscription response = subscriptionAdminClient.getSubscription(subscription.toString());
 }
 
```
 Parameters:
 
 subscription - The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - getSubscription
```
public final Subscription getSubscription(GetSubscriptionRequest request)
```
 Gets the configuration details of a subscription.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 GetSubscriptionRequest request = GetSubscriptionRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 Subscription response = subscriptionAdminClient.getSubscription(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - getSubscriptionCallable
```
public final com.google.api.gax.rpc.UnaryCallable<GetSubscriptionRequest,Subscription> getSubscriptionCallable()
```
 Gets the configuration details of a subscription.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 GetSubscriptionRequest request = GetSubscriptionRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 ApiFuture<Subscription> future = subscriptionAdminClient.getSubscriptionCallable().futureCall(request);
 // Do something
 Subscription response = future.get();
 }
 
```
 - updateSubscription
```
public final Subscription updateSubscription(UpdateSubscriptionRequest request)
```
 Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 int ackDeadlineSeconds = 42;
 Subscription subscription = Subscription.newBuilder()
 .setAckDeadlineSeconds(ackDeadlineSeconds)
 .build();
 String pathsElement = "ack_deadline_seconds";
 List<String> paths = Arrays.asList(pathsElement);
 FieldMask updateMask = FieldMask.newBuilder()
 .addAllPaths(paths)
 .build();
 UpdateSubscriptionRequest request = UpdateSubscriptionRequest.newBuilder()
 .setSubscription(subscription)
 .setUpdateMask(updateMask)
 .build();
 Subscription response = subscriptionAdminClient.updateSubscription(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - updateSubscriptionCallable
```
public final com.google.api.gax.rpc.UnaryCallable<UpdateSubscriptionRequest,Subscription> updateSubscriptionCallable()
```
 Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 int ackDeadlineSeconds = 42;
 Subscription subscription = Subscription.newBuilder()
 .setAckDeadlineSeconds(ackDeadlineSeconds)
 .build();
 String pathsElement = "ack_deadline_seconds";
 List<String> paths = Arrays.asList(pathsElement);
 FieldMask updateMask = FieldMask.newBuilder()
 .addAllPaths(paths)
 .build();
 UpdateSubscriptionRequest request = UpdateSubscriptionRequest.newBuilder()
 .setSubscription(subscription)
 .setUpdateMask(updateMask)
 .build();
 ApiFuture<Subscription> future = subscriptionAdminClient.updateSubscriptionCallable().futureCall(request);
 // Do something
 Subscription response = future.get();
 }
 
```
 - listSubscriptions
```
public final SubscriptionAdminClient.ListSubscriptionsPagedResponse listSubscriptions(ProjectName project)
```
 Lists matching subscriptions.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 for (Subscription element : subscriptionAdminClient.listSubscriptions(project).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 project - The name of the project in which to list subscriptions. Format is `projects/{project-id}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSubscriptions
```
public final SubscriptionAdminClient.ListSubscriptionsPagedResponse listSubscriptions(String project)
```
 Lists matching subscriptions.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 for (Subscription element : subscriptionAdminClient.listSubscriptions(project.toString()).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 project - The name of the project in which to list subscriptions. Format is `projects/{project-id}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSubscriptions
```
public final SubscriptionAdminClient.ListSubscriptionsPagedResponse listSubscriptions(ListSubscriptionsRequest request)
```
 Lists matching subscriptions.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSubscriptionsRequest request = ListSubscriptionsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 for (Subscription element : subscriptionAdminClient.listSubscriptions(request).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSubscriptionsPagedCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,SubscriptionAdminClient.ListSubscriptionsPagedResponse> listSubscriptionsPagedCallable()
```
 Lists matching subscriptions.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSubscriptionsRequest request = ListSubscriptionsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 ApiFuture<ListSubscriptionsPagedResponse> future = subscriptionAdminClient.listSubscriptionsPagedCallable().futureCall(request);
 // Do something
 for (Subscription element : future.get().iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 - listSubscriptionsCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse> listSubscriptionsCallable()
```
 Lists matching subscriptions.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSubscriptionsRequest request = ListSubscriptionsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 while (true) {
 ListSubscriptionsResponse response = subscriptionAdminClient.listSubscriptionsCallable().call(request);
 for (Subscription element : response.getSubscriptionsList()) {
 // doThingsWith(element);
 }
 String nextPageToken = response.getNextPageToken();
 if (!Strings.isNullOrEmpty(nextPageToken)) {
 request = request.toBuilder().setPageToken(nextPageToken).build();
 } else {
 break;
 }
 }
 }
 
```
 - deleteSubscription
```
public final void deleteSubscription(ProjectSubscriptionName subscription)
```
 Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 subscriptionAdminClient.deleteSubscription(subscription);
 }
 
```
 Parameters:
 
 subscription - The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSubscription
```
public final void deleteSubscription(String subscription)
```
 Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 subscriptionAdminClient.deleteSubscription(subscription.toString());
 }
 
```
 Parameters:
 
 subscription - The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSubscription
```
public final void deleteSubscription(DeleteSubscriptionRequest request)
```
 Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 DeleteSubscriptionRequest request = DeleteSubscriptionRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 subscriptionAdminClient.deleteSubscription(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSubscriptionCallable
```
public final com.google.api.gax.rpc.UnaryCallable<DeleteSubscriptionRequest,Empty> deleteSubscriptionCallable()
```
 Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 DeleteSubscriptionRequest request = DeleteSubscriptionRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 ApiFuture<Void> future = subscriptionAdminClient.deleteSubscriptionCallable().futureCall(request);
 // Do something
 future.get();
 }
 
```
 - modifyPushConfig
```
public final void modifyPushConfig(ProjectSubscriptionName subscription,
 PushConfig pushConfig)
```
 Modifies the `PushConfig` for a specified subscription.
 This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 subscriptionAdminClient.modifyPushConfig(subscription, pushConfig);
 }
 
```
 Parameters:
 
 subscription - The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
 
 pushConfig - The push configuration for future deliveries.
 An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - modifyPushConfig
```
public final void modifyPushConfig(String subscription,
 PushConfig pushConfig)
```
 Modifies the `PushConfig` for a specified subscription.
 This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 subscriptionAdminClient.modifyPushConfig(subscription.toString(), pushConfig);
 }
 
```
 Parameters:
 
 subscription - The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
 
 pushConfig - The push configuration for future deliveries.
 An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - modifyPushConfig
```
public final void modifyPushConfig(ModifyPushConfigRequest request)
```
 Modifies the `PushConfig` for a specified subscription.
 This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 ModifyPushConfigRequest request = ModifyPushConfigRequest.newBuilder()
 .setSubscription(subscription.toString())
 .setPushConfig(pushConfig)
 .build();
 subscriptionAdminClient.modifyPushConfig(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - modifyPushConfigCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ModifyPushConfigRequest,Empty> modifyPushConfigCallable()
```
 Modifies the `PushConfig` for a specified subscription.
 This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 PushConfig pushConfig = PushConfig.newBuilder().build();
 ModifyPushConfigRequest request = ModifyPushConfigRequest.newBuilder()
 .setSubscription(subscription.toString())
 .setPushConfig(pushConfig)
 .build();
 ApiFuture<Void> future = subscriptionAdminClient.modifyPushConfigCallable().futureCall(request);
 // Do something
 future.get();
 }
 
```
 - listSnapshots
```
public final SubscriptionAdminClient.ListSnapshotsPagedResponse listSnapshots(ProjectName project)
```
 Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 for (Snapshot element : subscriptionAdminClient.listSnapshots(project).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 project - The name of the project in which to list snapshots. Format is `projects/{project-id}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSnapshots
```
public final SubscriptionAdminClient.ListSnapshotsPagedResponse listSnapshots(String project)
```
 Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 for (Snapshot element : subscriptionAdminClient.listSnapshots(project.toString()).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 project - The name of the project in which to list snapshots. Format is `projects/{project-id}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSnapshots
```
public final SubscriptionAdminClient.ListSnapshotsPagedResponse listSnapshots(ListSnapshotsRequest request)
```
 Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 for (Snapshot element : subscriptionAdminClient.listSnapshots(request).iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - listSnapshotsPagedCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ListSnapshotsRequest,SubscriptionAdminClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()
```
 Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 ApiFuture<ListSnapshotsPagedResponse> future = subscriptionAdminClient.listSnapshotsPagedCallable().futureCall(request);
 // Do something
 for (Snapshot element : future.get().iterateAll()) {
 // doThingsWith(element);
 }
 }
 
```
 - listSnapshotsCallable
```
public final com.google.api.gax.rpc.UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse> listSnapshotsCallable()
```
 Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectName project = ProjectName.of("[PROJECT]");
 ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
 .setProject(project.toString())
 .build();
 while (true) {
 ListSnapshotsResponse response = subscriptionAdminClient.listSnapshotsCallable().call(request);
 for (Snapshot element : response.getSnapshotsList()) {
 // doThingsWith(element);
 }
 String nextPageToken = response.getNextPageToken();
 if (!Strings.isNullOrEmpty(nextPageToken)) {
 request = request.toBuilder().setPageToken(nextPageToken).build();
 } else {
 break;
 }
 }
 }
 
```
 - createSnapshot
```
public final Snapshot createSnapshot(ProjectSnapshotName name,
 ProjectSubscriptionName subscription)
```
 Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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/admin#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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName name = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 Snapshot response = subscriptionAdminClient.createSnapshot(name, subscription);
 }
 
```
 Parameters:
 
 name - 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. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
 
 subscription - 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}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSnapshot
```
public final Snapshot createSnapshot(String name,
 String subscription)
```
 Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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/admin#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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName name = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 Snapshot response = subscriptionAdminClient.createSnapshot(name.toString(), subscription.toString());
 }
 
```
 Parameters:
 
 name - 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. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
 
 subscription - 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}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSnapshot
```
public final Snapshot createSnapshot(CreateSnapshotRequest request)
```
 Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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/admin#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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName name = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 CreateSnapshotRequest request = CreateSnapshotRequest.newBuilder()
 .setName(name.toString())
 .setSubscription(subscription.toString())
 .build();
 Snapshot response = subscriptionAdminClient.createSnapshot(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - createSnapshotCallable
```
public final com.google.api.gax.rpc.UnaryCallable<CreateSnapshotRequest,Snapshot> createSnapshotCallable()
```
 Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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/admin#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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName name = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 CreateSnapshotRequest request = CreateSnapshotRequest.newBuilder()
 .setName(name.toString())
 .setSubscription(subscription.toString())
 .build();
 ApiFuture<Snapshot> future = subscriptionAdminClient.createSnapshotCallable().futureCall(request);
 // Do something
 Snapshot response = future.get();
 }
 
```
 - updateSnapshot
```
public final Snapshot updateSnapshot(UpdateSnapshotRequest request)
```
 Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 long seconds = 123456L;
 Timestamp expireTime = Timestamp.newBuilder()
 .setSeconds(seconds)
 .build();
 Snapshot snapshot = Snapshot.newBuilder()
 .setExpireTime(expireTime)
 .build();
 String pathsElement = "expire_time";
 List<String> paths = Arrays.asList(pathsElement);
 FieldMask updateMask = FieldMask.newBuilder()
 .addAllPaths(paths)
 .build();
 UpdateSnapshotRequest request = UpdateSnapshotRequest.newBuilder()
 .setSnapshot(snapshot)
 .setUpdateMask(updateMask)
 .build();
 Snapshot response = subscriptionAdminClient.updateSnapshot(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - updateSnapshotCallable
```
public final com.google.api.gax.rpc.UnaryCallable<UpdateSnapshotRequest,Snapshot> updateSnapshotCallable()
```
 Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 long seconds = 123456L;
 Timestamp expireTime = Timestamp.newBuilder()
 .setSeconds(seconds)
 .build();
 Snapshot snapshot = Snapshot.newBuilder()
 .setExpireTime(expireTime)
 .build();
 String pathsElement = "expire_time";
 List<String> paths = Arrays.asList(pathsElement);
 FieldMask updateMask = FieldMask.newBuilder()
 .addAllPaths(paths)
 .build();
 UpdateSnapshotRequest request = UpdateSnapshotRequest.newBuilder()
 .setSnapshot(snapshot)
 .setUpdateMask(updateMask)
 .build();
 ApiFuture<Snapshot> future = subscriptionAdminClient.updateSnapshotCallable().futureCall(request);
 // Do something
 Snapshot response = future.get();
 }
 
```
 - deleteSnapshot
```
public final void deleteSnapshot(ProjectSnapshotName snapshot)
```
 Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName snapshot = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 subscriptionAdminClient.deleteSnapshot(snapshot);
 }
 
```
 Parameters:
 
 snapshot - The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSnapshot
```
public final void deleteSnapshot(String snapshot)
```
 Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName snapshot = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 subscriptionAdminClient.deleteSnapshot(snapshot.toString());
 }
 
```
 Parameters:
 
 snapshot - The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSnapshot
```
public final void deleteSnapshot(DeleteSnapshotRequest request)
```
 Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName snapshot = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder()
 .setSnapshot(snapshot.toString())
 .build();
 subscriptionAdminClient.deleteSnapshot(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - deleteSnapshotCallable
```
public final com.google.api.gax.rpc.UnaryCallable<DeleteSnapshotRequest,Empty> deleteSnapshotCallable()
```
 Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSnapshotName snapshot = ProjectSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
 DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder()
 .setSnapshot(snapshot.toString())
 .build();
 ApiFuture<Void> future = subscriptionAdminClient.deleteSnapshotCallable().futureCall(request);
 // Do something
 future.get();
 }
 
```
 - seek
```
public final SeekResponse seek(SeekRequest request)
```
 Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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. Note that both the subscription and the snapshot must be on the same topic.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 SeekRequest request = SeekRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 SeekResponse response = subscriptionAdminClient.seek(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - seekCallable
```
public final com.google.api.gax.rpc.UnaryCallable<SeekRequest,SeekResponse> seekCallable()
```
 Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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. Note that both the subscription and the snapshot must be on the same topic.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
 SeekRequest request = SeekRequest.newBuilder()
 .setSubscription(subscription.toString())
 .build();
 ApiFuture<SeekResponse> future = subscriptionAdminClient.seekCallable().futureCall(request);
 // Do something
 SeekResponse response = future.get();
 }
 
```
 - setIamPolicy
```
public final com.google.iam.v1.Policy setIamPolicy(String resource,
 com.google.iam.v1.Policy policy)
```
 Sets the access control policy on the specified resource. Replaces any existing policy.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 Policy policy = Policy.newBuilder().build();
 Policy response = subscriptionAdminClient.setIamPolicy(formattedResource, policy);
 }
 
```
 Parameters:
 
 resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
 
 policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - setIamPolicy
```
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
```
 Sets the access control policy on the specified resource. Replaces any existing policy.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 Policy policy = Policy.newBuilder().build();
 SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
 .setResource(formattedResource)
 .setPolicy(policy)
 .build();
 Policy response = subscriptionAdminClient.setIamPolicy(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - setIamPolicyCallable
```
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
```
 Sets the access control policy on the specified resource. Replaces any existing policy.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 Policy policy = Policy.newBuilder().build();
 SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
 .setResource(formattedResource)
 .setPolicy(policy)
 .build();
 ApiFuture<Policy> future = subscriptionAdminClient.setIamPolicyCallable().futureCall(request);
 // Do something
 Policy response = future.get();
 }
 
```
 - getIamPolicy
```
public final com.google.iam.v1.Policy getIamPolicy(String resource)
```
 Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 Policy response = subscriptionAdminClient.getIamPolicy(formattedResource);
 }
 
```
 Parameters:
 
 resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - getIamPolicy
```
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
```
 Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
 .setResource(formattedResource)
 .build();
 Policy response = subscriptionAdminClient.getIamPolicy(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - getIamPolicyCallable
```
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
```
 Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
 .setResource(formattedResource)
 .build();
 ApiFuture<Policy> future = subscriptionAdminClient.getIamPolicyCallable().futureCall(request);
 // Do something
 Policy response = future.get();
 }
 
```
 - testIamPermissions
```
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource,
 List<String> permissions)
```
 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 List<String> permissions = new ArrayList<>();
 TestIamPermissionsResponse response = subscriptionAdminClient.testIamPermissions(formattedResource, permissions);
 }
 
```
 Parameters:
 
 resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
 
 permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - testIamPermissions
```
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
```
 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 List<String> permissions = new ArrayList<>();
 TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
 .setResource(formattedResource)
 .addAllPermissions(permissions)
 .build();
 TestIamPermissionsResponse response = subscriptionAdminClient.testIamPermissions(request);
 }
 
```
 Parameters:
 
 request - The request object containing all of the parameters for the API call.
 
 Throws:
 
 com.google.api.gax.rpc.ApiException - if the remote call fails
 - testIamPermissionsCallable
```
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
```
 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.
 Sample code:
```
 try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
 String formattedResource = ProjectSubscriptionName.format("[PROJECT]", "[SUBSCRIPTION]");
 List<String> permissions = new ArrayList<>();
 TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
 .setResource(formattedResource)
 .addAllPermissions(permissions)
 .build();
 ApiFuture<TestIamPermissionsResponse> future = subscriptionAdminClient.testIamPermissionsCallable().futureCall(request);
 // Do something
 TestIamPermissionsResponse response = future.get();
 }
 
```
 - close
```
public final void close()
```
 Specified by:
 
 close in interface AutoCloseable
 - shutdown
```
public void shutdown()
```
 Specified by:
 
 shutdown in interface com.google.api.gax.core.BackgroundResource
 - isShutdown
```
public boolean isShutdown()
```
 Specified by:
 
 isShutdown in interface com.google.api.gax.core.BackgroundResource
 - isTerminated
```
public boolean isTerminated()
```
 Specified by:
 
 isTerminated in interface com.google.api.gax.core.BackgroundResource
 - shutdownNow
```
public void shutdownNow()
```
 Specified by:
 
 shutdownNow in interface com.google.api.gax.core.BackgroundResource
 - awaitTermination
```
public boolean awaitTermination(long duration,
 TimeUnit unit)
 throws InterruptedException
```
 Specified by:
 
 awaitTermination in interface com.google.api.gax.core.BackgroundResource
 
 Throws:
 
 InterruptedException

Class SubscriptionAdminClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubscriptionAdminClient

SubscriptionAdminClient

Method Detail

create

create

create

getSettings

getStub

createSubscription

createSubscription

createSubscription

createSubscriptionCallable

getSubscription

getSubscription

getSubscription

getSubscriptionCallable

updateSubscription

updateSubscriptionCallable

listSubscriptions

listSubscriptions

listSubscriptions

listSubscriptionsPagedCallable

listSubscriptionsCallable

deleteSubscription

deleteSubscription

deleteSubscription

deleteSubscriptionCallable

modifyPushConfig

modifyPushConfig

modifyPushConfig

modifyPushConfigCallable

listSnapshots

listSnapshots

listSnapshots

listSnapshotsPagedCallable

listSnapshotsCallable

createSnapshot

createSnapshot

createSnapshot

createSnapshotCallable

updateSnapshot

updateSnapshotCallable

deleteSnapshot

deleteSnapshot

deleteSnapshot

deleteSnapshotCallable

seek

seekCallable

setIamPolicy

setIamPolicy

setIamPolicyCallable

getIamPolicy

getIamPolicy

getIamPolicyCallable

testIamPermissions

testIamPermissions

testIamPermissionsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination