com.google.cloud.pubsub.v1.SubscriptionAdminClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-pubsub Show documentation
Show all versions of google-cloud-pubsub Show documentation
Java idiomatic client for Google Cloud Pub/Sub
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.pubsub.v1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.BidiStreamingCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.pubsub.v1.stub.SubscriberStub;
import com.google.cloud.pubsub.v1.stub.SubscriberStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import com.google.pubsub.v1.AcknowledgeRequest;
import com.google.pubsub.v1.CreateSnapshotRequest;
import com.google.pubsub.v1.DeleteSnapshotRequest;
import com.google.pubsub.v1.DeleteSubscriptionRequest;
import com.google.pubsub.v1.GetSubscriptionRequest;
import com.google.pubsub.v1.ListSnapshotsRequest;
import com.google.pubsub.v1.ListSnapshotsResponse;
import com.google.pubsub.v1.ListSubscriptionsRequest;
import com.google.pubsub.v1.ListSubscriptionsResponse;
import com.google.pubsub.v1.ModifyAckDeadlineRequest;
import com.google.pubsub.v1.ModifyPushConfigRequest;
import com.google.pubsub.v1.ProjectName;
import com.google.pubsub.v1.ProjectSnapshotName;
import com.google.pubsub.v1.ProjectSubscriptionName;
import com.google.pubsub.v1.ProjectTopicName;
import com.google.pubsub.v1.PullRequest;
import com.google.pubsub.v1.PullResponse;
import com.google.pubsub.v1.PushConfig;
import com.google.pubsub.v1.SeekRequest;
import com.google.pubsub.v1.SeekResponse;
import com.google.pubsub.v1.Snapshot;
import com.google.pubsub.v1.StreamingPullRequest;
import com.google.pubsub.v1.StreamingPullResponse;
import com.google.pubsub.v1.Subscription;
import com.google.pubsub.v1.UpdateSnapshotRequest;
import com.google.pubsub.v1.UpdateSubscriptionRequest;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* 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:
*
*
* - 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.
*
- 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.
*
- 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);
*
*
*/
@Generated("by gapic-generator")
public class SubscriptionAdminClient implements BackgroundResource {
private final SubscriptionAdminSettings settings;
private final SubscriberStub stub;
/** Constructs an instance of SubscriptionAdminClient with default settings. */
public static final SubscriptionAdminClient create() throws IOException {
return create(SubscriptionAdminSettings.newBuilder().build());
}
/**
* 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.
*/
public static final SubscriptionAdminClient create(SubscriptionAdminSettings settings)
throws IOException {
return new SubscriptionAdminClient(settings);
}
/**
* Constructs an instance of SubscriptionAdminClient, using the given stub for making calls. This
* is for advanced usage - prefer to use SubscriptionAdminSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final SubscriptionAdminClient create(SubscriberStub stub) {
return new SubscriptionAdminClient(stub);
}
/**
* 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.
*/
protected SubscriptionAdminClient(SubscriptionAdminSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SubscriberStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected SubscriptionAdminClient(SubscriberStub stub) {
this.settings = null;
this.stub = stub;
}
public final SubscriptionAdminSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public SubscriberStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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"`
* @param 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.
* @param 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.
* @param 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
* <i>outstanding</i>. 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
*/
public final Subscription createSubscription(
ProjectSubscriptionName name,
ProjectTopicName topic,
PushConfig pushConfig,
int ackDeadlineSeconds) {
Subscription request =
Subscription.newBuilder()
.setName(name == null ? null : name.toString())
.setTopic(topic == null ? null : topic.toString())
.setPushConfig(pushConfig)
.setAckDeadlineSeconds(ackDeadlineSeconds)
.build();
return createSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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"`
* @param 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.
* @param 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.
* @param 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
* <i>outstanding</i>. 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
*/
public final Subscription createSubscription(
String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) {
Subscription request =
Subscription.newBuilder()
.setName(name)
.setTopic(topic)
.setPushConfig(pushConfig)
.setAckDeadlineSeconds(ackDeadlineSeconds)
.build();
return createSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Subscription createSubscription(Subscription request) {
return createSubscriptionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable createSubscriptionCallable() {
return stub.createSubscriptionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Subscription getSubscription(ProjectSubscriptionName subscription) {
GetSubscriptionRequest request =
GetSubscriptionRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.build();
return getSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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());
* }
*
*
* @param 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
*/
public final Subscription getSubscription(String subscription) {
GetSubscriptionRequest request =
GetSubscriptionRequest.newBuilder().setSubscription(subscription).build();
return getSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Subscription getSubscription(GetSubscriptionRequest request) {
return getSubscriptionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable getSubscriptionCallable() {
return stub.getSubscriptionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Subscription updateSubscription(UpdateSubscriptionRequest request) {
return updateSubscriptionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable updateSubscriptionCallable() {
return stub.updateSubscriptionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists matching subscriptions.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectName project = ProjectName.of("[PROJECT]");
* for (Subscription element : subscriptionAdminClient.listSubscriptions(project).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param 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
*/
public final ListSubscriptionsPagedResponse listSubscriptions(ProjectName project) {
ListSubscriptionsRequest request =
ListSubscriptionsRequest.newBuilder()
.setProject(project == null ? null : project.toString())
.build();
return listSubscriptions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListSubscriptionsPagedResponse listSubscriptions(String project) {
ListSubscriptionsRequest request =
ListSubscriptionsRequest.newBuilder().setProject(project).build();
return listSubscriptions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListSubscriptionsPagedResponse listSubscriptions(ListSubscriptionsRequest request) {
return listSubscriptionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*/
public final UnaryCallable
listSubscriptionsPagedCallable() {
return stub.listSubscriptionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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;
* }
* }
* }
*
*/
public final UnaryCallable
listSubscriptionsCallable() {
return stub.listSubscriptionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param subscription The subscription to delete. Format is
* `projects/{project}/subscriptions/{sub}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSubscription(ProjectSubscriptionName subscription) {
DeleteSubscriptionRequest request =
DeleteSubscriptionRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.build();
deleteSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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());
* }
*
*
* @param subscription The subscription to delete. Format is
* `projects/{project}/subscriptions/{sub}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSubscription(String subscription) {
DeleteSubscriptionRequest request =
DeleteSubscriptionRequest.newBuilder().setSubscription(subscription).build();
deleteSubscription(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final void deleteSubscription(DeleteSubscriptionRequest request) {
deleteSubscriptionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable deleteSubscriptionCallable() {
return stub.deleteSubscriptionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the ack deadline for a specific message. This method is useful to indicate that more
* time is needed to process a message by the subscriber, or to make the message available for
* redelivery if the processing was interrupted. Note that this does not modify the
* subscription-level `ackDeadlineSeconds` used for subsequent messages.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* int ackDeadlineSeconds = 0;
* subscriptionAdminClient.modifyAckDeadline(subscription, ackIds, ackDeadlineSeconds);
* }
*
*
* @param subscription The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ackIds List of acknowledgment IDs.
* @param ackDeadlineSeconds The new ack deadline with respect to the time this request was sent
* to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10
* seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make
* the message available for delivery to another subscriber client. This typically results in
* an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline
* you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10
* minutes).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final void modifyAckDeadline(
ProjectSubscriptionName subscription, List ackIds, int ackDeadlineSeconds) {
ModifyAckDeadlineRequest request =
ModifyAckDeadlineRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.addAllAckIds(ackIds)
.setAckDeadlineSeconds(ackDeadlineSeconds)
.build();
modifyAckDeadline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the ack deadline for a specific message. This method is useful to indicate that more
* time is needed to process a message by the subscriber, or to make the message available for
* redelivery if the processing was interrupted. Note that this does not modify the
* subscription-level `ackDeadlineSeconds` used for subsequent messages.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* int ackDeadlineSeconds = 0;
* subscriptionAdminClient.modifyAckDeadline(subscription.toString(), ackIds, ackDeadlineSeconds);
* }
*
*
* @param subscription The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ackIds List of acknowledgment IDs.
* @param ackDeadlineSeconds The new ack deadline with respect to the time this request was sent
* to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10
* seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make
* the message available for delivery to another subscriber client. This typically results in
* an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline
* you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10
* minutes).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final void modifyAckDeadline(
String subscription, List ackIds, int ackDeadlineSeconds) {
ModifyAckDeadlineRequest request =
ModifyAckDeadlineRequest.newBuilder()
.setSubscription(subscription)
.addAllAckIds(ackIds)
.setAckDeadlineSeconds(ackDeadlineSeconds)
.build();
modifyAckDeadline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the ack deadline for a specific message. This method is useful to indicate that more
* time is needed to process a message by the subscriber, or to make the message available for
* redelivery if the processing was interrupted. Note that this does not modify the
* subscription-level `ackDeadlineSeconds` used for subsequent messages.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* int ackDeadlineSeconds = 0;
* ModifyAckDeadlineRequest request = ModifyAckDeadlineRequest.newBuilder()
* .setSubscription(subscription.toString())
* .addAllAckIds(ackIds)
* .setAckDeadlineSeconds(ackDeadlineSeconds)
* .build();
* subscriptionAdminClient.modifyAckDeadline(request);
* }
*
*
* @param 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
*/
/* package-private */ final void modifyAckDeadline(ModifyAckDeadlineRequest request) {
modifyAckDeadlineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the ack deadline for a specific message. This method is useful to indicate that more
* time is needed to process a message by the subscriber, or to make the message available for
* redelivery if the processing was interrupted. Note that this does not modify the
* subscription-level `ackDeadlineSeconds` used for subsequent messages.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* int ackDeadlineSeconds = 0;
* ModifyAckDeadlineRequest request = ModifyAckDeadlineRequest.newBuilder()
* .setSubscription(subscription.toString())
* .addAllAckIds(ackIds)
* .setAckDeadlineSeconds(ackDeadlineSeconds)
* .build();
* ApiFuture<Void> future = subscriptionAdminClient.modifyAckDeadlineCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
/* package-private */ final UnaryCallable
modifyAckDeadlineCallable() {
return stub.modifyAckDeadlineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The
* Pub/Sub system can remove the relevant messages from the subscription.
*
* Acknowledging a message whose ack deadline has expired may succeed, but such a message may
* be redelivered later. Acknowledging a message more than once will not result in an error.
*
*
Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* subscriptionAdminClient.acknowledge(subscription, ackIds);
* }
*
*
* @param subscription The subscription whose message is being acknowledged. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ackIds The acknowledgment ID for the messages being acknowledged that was returned by
* the Pub/Sub system in the `Pull` response. Must not be empty.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final void acknowledge(
ProjectSubscriptionName subscription, List ackIds) {
AcknowledgeRequest request =
AcknowledgeRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.addAllAckIds(ackIds)
.build();
acknowledge(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The
* Pub/Sub system can remove the relevant messages from the subscription.
*
* Acknowledging a message whose ack deadline has expired may succeed, but such a message may
* be redelivered later. Acknowledging a message more than once will not result in an error.
*
*
Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* subscriptionAdminClient.acknowledge(subscription.toString(), ackIds);
* }
*
*
* @param subscription The subscription whose message is being acknowledged. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ackIds The acknowledgment ID for the messages being acknowledged that was returned by
* the Pub/Sub system in the `Pull` response. Must not be empty.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final void acknowledge(String subscription, List ackIds) {
AcknowledgeRequest request =
AcknowledgeRequest.newBuilder().setSubscription(subscription).addAllAckIds(ackIds).build();
acknowledge(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The
* Pub/Sub system can remove the relevant messages from the subscription.
*
* Acknowledging a message whose ack deadline has expired may succeed, but such a message may
* be redelivered later. Acknowledging a message more than once will not result in an error.
*
*
Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* AcknowledgeRequest request = AcknowledgeRequest.newBuilder()
* .setSubscription(subscription.toString())
* .addAllAckIds(ackIds)
* .build();
* subscriptionAdminClient.acknowledge(request);
* }
*
*
* @param 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
*/
/* package-private */ final void acknowledge(AcknowledgeRequest request) {
acknowledgeCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The
* Pub/Sub system can remove the relevant messages from the subscription.
*
* Acknowledging a message whose ack deadline has expired may succeed, but such a message may
* be redelivered later. Acknowledging a message more than once will not result in an error.
*
*
Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* List<String> ackIds = new ArrayList<>();
* AcknowledgeRequest request = AcknowledgeRequest.newBuilder()
* .setSubscription(subscription.toString())
* .addAllAckIds(ackIds)
* .build();
* ApiFuture<Void> future = subscriptionAdminClient.acknowledgeCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
/* package-private */ final UnaryCallable acknowledgeCallable() {
return stub.acknowledgeCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many
* concurrent pull requests pending for the given subscription.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* boolean returnImmediately = false;
* int maxMessages = 0;
* PullResponse response = subscriptionAdminClient.pull(subscription, returnImmediately, maxMessages);
* }
*
*
* @param subscription The subscription from which messages should be pulled. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param returnImmediately If this field set to true, the system will respond immediately even if
* it there are no messages available to return in the `Pull` response. Otherwise, the system
* may wait (for a bounded amount of time) until at least one message is available, rather
* than returning no messages.
* @param maxMessages The maximum number of messages returned for this request. The Pub/Sub system
* may return fewer than the number specified.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final PullResponse pull(
ProjectSubscriptionName subscription, boolean returnImmediately, int maxMessages) {
PullRequest request =
PullRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.setReturnImmediately(returnImmediately)
.setMaxMessages(maxMessages)
.build();
return pull(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many
* concurrent pull requests pending for the given subscription.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* boolean returnImmediately = false;
* int maxMessages = 0;
* PullResponse response = subscriptionAdminClient.pull(subscription.toString(), returnImmediately, maxMessages);
* }
*
*
* @param subscription The subscription from which messages should be pulled. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param returnImmediately If this field set to true, the system will respond immediately even if
* it there are no messages available to return in the `Pull` response. Otherwise, the system
* may wait (for a bounded amount of time) until at least one message is available, rather
* than returning no messages.
* @param maxMessages The maximum number of messages returned for this request. The Pub/Sub system
* may return fewer than the number specified.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final PullResponse pull(
String subscription, boolean returnImmediately, int maxMessages) {
PullRequest request =
PullRequest.newBuilder()
.setSubscription(subscription)
.setReturnImmediately(returnImmediately)
.setMaxMessages(maxMessages)
.build();
return pull(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many
* concurrent pull requests pending for the given subscription.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* int maxMessages = 0;
* PullRequest request = PullRequest.newBuilder()
* .setSubscription(subscription.toString())
* .setMaxMessages(maxMessages)
* .build();
* PullResponse response = subscriptionAdminClient.pull(request);
* }
*
*
* @param 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
*/
/* package-private */ final PullResponse pull(PullRequest request) {
return pullCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many
* concurrent pull requests pending for the given subscription.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* int maxMessages = 0;
* PullRequest request = PullRequest.newBuilder()
* .setSubscription(subscription.toString())
* .setMaxMessages(maxMessages)
* .build();
* ApiFuture<PullResponse> future = subscriptionAdminClient.pullCallable().futureCall(request);
* // Do something
* PullResponse response = future.get();
* }
*
*/
/* package-private */ final UnaryCallable pullCallable() {
return stub.pullCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Establishes a stream with the server, which sends messages down to the client. The client
* streams acknowledgements and ack deadline modifications back to the server. The server will
* close the stream and return the status on any error. The server may close the stream with
* status `UNAVAILABLE` to reassign server-side resources, in which case, the client should
* re-establish the stream. Flow control can be achieved by configuring the underlying RPC
* channel.
*
* Sample code:
*
*
* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
* BidiStream<StreamingPullRequest, StreamingPullResponse> bidiStream =
* subscriptionAdminClient.streamingPullCallable().call();
*
* ProjectSubscriptionName subscription = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");
* int streamAckDeadlineSeconds = 0;
* StreamingPullRequest request = StreamingPullRequest.newBuilder()
* .setSubscription(subscription.toString())
* .setStreamAckDeadlineSeconds(streamAckDeadlineSeconds)
* .build();
* bidiStream.send(request);
* for (StreamingPullResponse response : bidiStream) {
* // Do something when receive a response
* }
* }
*
*/
/* package-private */ final BidiStreamingCallable
streamingPullCallable() {
return stub.streamingPullCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param subscription The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param 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
*/
public final void modifyPushConfig(ProjectSubscriptionName subscription, PushConfig pushConfig) {
ModifyPushConfigRequest request =
ModifyPushConfigRequest.newBuilder()
.setSubscription(subscription == null ? null : subscription.toString())
.setPushConfig(pushConfig)
.build();
modifyPushConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param subscription The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param 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
*/
public final void modifyPushConfig(String subscription, PushConfig pushConfig) {
ModifyPushConfigRequest request =
ModifyPushConfigRequest.newBuilder()
.setSubscription(subscription)
.setPushConfig(pushConfig)
.build();
modifyPushConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final void modifyPushConfig(ModifyPushConfigRequest request) {
modifyPushConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable modifyPushConfigCallable() {
return stub.modifyPushConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListSnapshotsPagedResponse listSnapshots(ProjectName project) {
ListSnapshotsRequest request =
ListSnapshotsRequest.newBuilder()
.setProject(project == null ? null : project.toString())
.build();
return listSnapshots(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListSnapshotsPagedResponse listSnapshots(String project) {
ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder().setProject(project).build();
return listSnapshots(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListSnapshotsPagedResponse listSnapshots(ListSnapshotsRequest request) {
return listSnapshotsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*/
public final UnaryCallable
listSnapshotsPagedCallable() {
return stub.listSnapshotsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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;
* }
* }
* }
*
*/
public final UnaryCallable listSnapshotsCallable() {
return stub.listSnapshotsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.
* <br><br>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);
* }
*
*
* @param 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}`.
* @param 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
*/
public final Snapshot createSnapshot(
ProjectSnapshotName name, ProjectSubscriptionName subscription) {
CreateSnapshotRequest request =
CreateSnapshotRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setSubscription(subscription == null ? null : subscription.toString())
.build();
return createSnapshot(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.
* <br><br>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());
* }
*
*
* @param 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}`.
* @param 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
*/
public final Snapshot createSnapshot(String name, String subscription) {
CreateSnapshotRequest request =
CreateSnapshotRequest.newBuilder().setName(name).setSubscription(subscription).build();
return createSnapshot(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.
* <br><br>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);
* }
*
*
* @param 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
*/
public final Snapshot createSnapshot(CreateSnapshotRequest request) {
return createSnapshotCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.
* <br><br>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();
* }
*
*/
public final UnaryCallable createSnapshotCallable() {
return stub.createSnapshotCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Snapshot updateSnapshot(UpdateSnapshotRequest request) {
return updateSnapshotCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable updateSnapshotCallable() {
return stub.updateSnapshotCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.<br><br> 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);
* }
*
*
* @param 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
*/
public final void deleteSnapshot(ProjectSnapshotName snapshot) {
DeleteSnapshotRequest request =
DeleteSnapshotRequest.newBuilder()
.setSnapshot(snapshot == null ? null : snapshot.toString())
.build();
deleteSnapshot(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.<br><br> 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());
* }
*
*
* @param 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
*/
public final void deleteSnapshot(String snapshot) {
DeleteSnapshotRequest request =
DeleteSnapshotRequest.newBuilder().setSnapshot(snapshot).build();
deleteSnapshot(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.<br><br> 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);
* }
*
*
* @param 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
*/
public final void deleteSnapshot(DeleteSnapshotRequest request) {
deleteSnapshotCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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.<br><br> 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();
* }
*
*/
public final UnaryCallable deleteSnapshotCallable() {
return stub.deleteSnapshotCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final SeekResponse seek(SeekRequest request) {
return seekCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable seekCallable() {
return stub.seekCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param 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
*/
public final Policy setIamPolicy(String resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param 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
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource)
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListSubscriptionsPagedResponse
extends AbstractPagedListResponse<
ListSubscriptionsRequest,
ListSubscriptionsResponse,
Subscription,
ListSubscriptionsPage,
ListSubscriptionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSubscriptionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListSubscriptionsPagedResponse apply(ListSubscriptionsPage input) {
return new ListSubscriptionsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListSubscriptionsPagedResponse(ListSubscriptionsPage page) {
super(page, ListSubscriptionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSubscriptionsPage
extends AbstractPage<
ListSubscriptionsRequest,
ListSubscriptionsResponse,
Subscription,
ListSubscriptionsPage> {
private ListSubscriptionsPage(
PageContext context,
ListSubscriptionsResponse response) {
super(context, response);
}
private static ListSubscriptionsPage createEmptyPage() {
return new ListSubscriptionsPage(null, null);
}
@Override
protected ListSubscriptionsPage createPage(
PageContext context,
ListSubscriptionsResponse response) {
return new ListSubscriptionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSubscriptionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSubscriptionsRequest,
ListSubscriptionsResponse,
Subscription,
ListSubscriptionsPage,
ListSubscriptionsFixedSizeCollection> {
private ListSubscriptionsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSubscriptionsFixedSizeCollection createEmptyCollection() {
return new ListSubscriptionsFixedSizeCollection(null, 0);
}
@Override
protected ListSubscriptionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSubscriptionsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListSnapshotsPagedResponse
extends AbstractPagedListResponse<
ListSnapshotsRequest,
ListSnapshotsResponse,
Snapshot,
ListSnapshotsPage,
ListSnapshotsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSnapshotsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListSnapshotsPagedResponse apply(ListSnapshotsPage input) {
return new ListSnapshotsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListSnapshotsPagedResponse(ListSnapshotsPage page) {
super(page, ListSnapshotsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSnapshotsPage
extends AbstractPage<
ListSnapshotsRequest, ListSnapshotsResponse, Snapshot, ListSnapshotsPage> {
private ListSnapshotsPage(
PageContext context,
ListSnapshotsResponse response) {
super(context, response);
}
private static ListSnapshotsPage createEmptyPage() {
return new ListSnapshotsPage(null, null);
}
@Override
protected ListSnapshotsPage createPage(
PageContext context,
ListSnapshotsResponse response) {
return new ListSnapshotsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSnapshotsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSnapshotsRequest,
ListSnapshotsResponse,
Snapshot,
ListSnapshotsPage,
ListSnapshotsFixedSizeCollection> {
private ListSnapshotsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSnapshotsFixedSizeCollection createEmptyCollection() {
return new ListSnapshotsFixedSizeCollection(null, 0);
}
@Override
protected ListSnapshotsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSnapshotsFixedSizeCollection(pages, collectionSize);
}
}
}