com.google.cloud.pubsub.v1

Class TopicAdminClient

java.lang.Object

com.google.cloud.pubsub.v1.TopicAdminClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
public class TopicAdminClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The service that an application uses to manipulate topics, and to send messages to a topic.

To publish messages to a topic, see the Publisher 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 (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName name = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.createTopic(name);
 }
 
 

Note: close() needs to be called on the topicAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TopicAdminSettings to create(). For example:

To customize credentials:

 
 TopicAdminSettings topicAdminSettings =
     TopicAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TopicAdminClient topicAdminClient =
     TopicAdminClient.create(topicAdminSettings);
 
 

To customize the endpoint:

 
 TopicAdminSettings topicAdminSettings =
     TopicAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 TopicAdminClient topicAdminClient =
     TopicAdminClient.create(topicAdminSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopicAdminClient.ListTopicsFixedSizeCollection
static class	TopicAdminClient.ListTopicsPage
static class	TopicAdminClient.ListTopicsPagedResponse
static class	TopicAdminClient.ListTopicSubscriptionsFixedSizeCollection
static class	TopicAdminClient.ListTopicSubscriptionsPage
static class	TopicAdminClient.ListTopicSubscriptionsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TopicAdminClient(PublisherStub stub)
protected	TopicAdminClient(TopicAdminSettings settings) Constructs an instance of TopicAdminClient, using the given settings.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TopicAdminClient	create() Constructs an instance of TopicAdminClient with default settings.
static TopicAdminClient	create(PublisherStub stub) Constructs an instance of TopicAdminClient, using the given stub for making calls.
static TopicAdminClient	create(TopicAdminSettings settings) Constructs an instance of TopicAdminClient, using the given settings.
Topic	createTopic(ProjectTopicName name) Deprecated. Use createTopic(TopicName) instead.
Topic	createTopic(String name) Creates the given topic with the given name.
Topic	createTopic(Topic request) Creates the given topic with the given name.
Topic	createTopic(TopicName name) Creates the given topic with the given name.
com.google.api.gax.rpc.UnaryCallable<Topic,Topic>	createTopicCallable() Creates the given topic with the given name.
void	deleteTopic(DeleteTopicRequest request) Deletes the topic with the given name.
void	deleteTopic(ProjectTopicName topic) Deprecated. Use deleteTopic(TopicName) instead.
void	deleteTopic(String topic) Deletes the topic with the given name.
void	deleteTopic(TopicName topic) Deletes the topic with the given name.
com.google.api.gax.rpc.UnaryCallable<DeleteTopicRequest,com.google.protobuf.Empty>	deleteTopicCallable() Deletes the topic with the given name.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
com.google.iam.v1.Policy	getIamPolicy(String resource) Deprecated. Use getIamPolicy(GetIamPolicyRequest) instead.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the access control policy for a resource.
TopicAdminSettings	getSettings()
PublisherStub	getStub()
Topic	getTopic(GetTopicRequest request) Gets the configuration of a topic.
Topic	getTopic(ProjectTopicName topic) Deprecated. Use getTopic(TopicName) instead.
Topic	getTopic(String topic) Gets the configuration of a topic.
Topic	getTopic(TopicName topic) Gets the configuration of a topic.
com.google.api.gax.rpc.UnaryCallable<GetTopicRequest,Topic>	getTopicCallable() Gets the configuration of a topic.
boolean	isShutdown()
boolean	isTerminated()
TopicAdminClient.ListTopicsPagedResponse	listTopics(ListTopicsRequest request) Lists matching topics.
TopicAdminClient.ListTopicsPagedResponse	listTopics(ProjectName project) Lists matching topics.
TopicAdminClient.ListTopicsPagedResponse	listTopics(String project) Lists matching topics.
com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,ListTopicsResponse>	listTopicsCallable() Lists matching topics.
com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,TopicAdminClient.ListTopicsPagedResponse>	listTopicsPagedCallable() Lists matching topics.
TopicAdminClient.ListTopicSubscriptionsPagedResponse	listTopicSubscriptions(ListTopicSubscriptionsRequest request) Lists the names of the subscriptions on this topic.
TopicAdminClient.ListTopicSubscriptionsPagedResponse	listTopicSubscriptions(ProjectTopicName topic) Deprecated. Use listTopicSubscriptions(TopicName) instead.
TopicAdminClient.ListTopicSubscriptionsPagedResponse	listTopicSubscriptions(String topic) Lists the names of the subscriptions on this topic.
TopicAdminClient.ListTopicSubscriptionsPagedResponse	listTopicSubscriptions(TopicName topic) Lists the names of the subscriptions on this topic.
com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse>	listTopicSubscriptionsCallable() Lists the names of the subscriptions on this topic.
com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,TopicAdminClient.ListTopicSubscriptionsPagedResponse>	listTopicSubscriptionsPagedCallable() Lists the names of the subscriptions on this topic.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on the specified resource.
com.google.iam.v1.Policy	setIamPolicy(String resource, com.google.iam.v1.Policy policy) Deprecated. Use setIamPolicy(SetIamPolicyRequest) instead.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(String resource, List<String> permissions) Deprecated. Use testIamPermissions(TestIamPermissionsRequest) instead.
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns permissions that a caller has on the specified resource.
Topic	updateTopic(UpdateTopicRequest request) Updates an existing topic.
com.google.api.gax.rpc.UnaryCallable<UpdateTopicRequest,Topic>	updateTopicCallable() Updates an existing topic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopicAdminClient

protected TopicAdminClient(TopicAdminSettings settings)
                    throws IOException

Constructs an instance of TopicAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

TopicAdminClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TopicAdminClient(PublisherStub stub)

Method Detail

create

public static final TopicAdminClient create()
                                     throws IOException

Constructs an instance of TopicAdminClient with default settings.

Throws:

IOException

create

public static final TopicAdminClient create(TopicAdminSettings settings)
                                     throws IOException

Constructs an instance of TopicAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final TopicAdminClient create(PublisherStub stub)

Constructs an instance of TopicAdminClient, using the given stub for making calls. This is for advanced usage - prefer to use TopicAdminSettings}.

getSettings

public final TopicAdminSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public PublisherStub getStub()

createTopic

public final Topic createTopic(TopicName name)

Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName name = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.createTopic(name);
 }
 

Parameters:

name - Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTopic

public final Topic createTopic(String name)

Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName name = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.createTopic(name.toString());
 }
 

Parameters:

name - Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTopic

public final Topic createTopic(ProjectTopicName name)

Deprecated. Use createTopic(TopicName) instead.

Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectTopicName name = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.createTopic(name);
 }
 

Parameters:

name - Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTopic

public final Topic createTopic(Topic request)

Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName name = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic request = Topic.newBuilder()
     .setName(name.toString())
     .build();
   Topic response = topicAdminClient.createTopic(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTopicCallable

public final com.google.api.gax.rpc.UnaryCallable<Topic,Topic> createTopicCallable()

Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName name = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic request = Topic.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Topic> future = topicAdminClient.createTopicCallable().futureCall(request);
   // Do something
   Topic response = future.get();
 }
 

updateTopic

public final Topic updateTopic(UpdateTopicRequest request)

Updates an existing topic. Note that certain properties of a topic are not modifiable.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   Topic topic = Topic.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateTopicRequest request = UpdateTopicRequest.newBuilder()
     .setTopic(topic)
     .setUpdateMask(updateMask)
     .build();
   Topic response = topicAdminClient.updateTopic(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTopicCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTopicRequest,Topic> updateTopicCallable()

Updates an existing topic. Note that certain properties of a topic are not modifiable.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   Topic topic = Topic.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateTopicRequest request = UpdateTopicRequest.newBuilder()
     .setTopic(topic)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Topic> future = topicAdminClient.updateTopicCallable().futureCall(request);
   // Do something
   Topic response = future.get();
 }
 

getTopic

public final Topic getTopic(TopicName topic)

Gets the configuration of a topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.getTopic(topic);
 }
 

Parameters:

topic - Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTopic

public final Topic getTopic(String topic)

Gets the configuration of a topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.getTopic(topic.toString());
 }
 

Parameters:

topic - Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTopic

public final Topic getTopic(ProjectTopicName topic)

Deprecated. Use getTopic(TopicName) instead.

Gets the configuration of a topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
   Topic response = topicAdminClient.getTopic(topic);
 }
 

Parameters:

topic - Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTopic

public final Topic getTopic(GetTopicRequest request)

Gets the configuration of a topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   GetTopicRequest request = GetTopicRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   Topic response = topicAdminClient.getTopic(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTopicCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTopicRequest,Topic> getTopicCallable()

Gets the configuration of a topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   GetTopicRequest request = GetTopicRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   ApiFuture<Topic> future = topicAdminClient.getTopicCallable().futureCall(request);
   // Do something
   Topic response = future.get();
 }
 

listTopics

public final TopicAdminClient.ListTopicsPagedResponse listTopics(ProjectName project)

Lists matching topics.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Topic element : topicAdminClient.listTopics(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Required. The name of the project in which to list topics. Format is `projects/{project-id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopics

public final TopicAdminClient.ListTopicsPagedResponse listTopics(String project)

Lists matching topics.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Topic element : topicAdminClient.listTopics(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Required. The name of the project in which to list topics. Format is `projects/{project-id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopics

public final TopicAdminClient.ListTopicsPagedResponse listTopics(ListTopicsRequest request)

Lists matching topics.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ListTopicsRequest request = ListTopicsRequest.newBuilder()
     .setProject(project.toString())
     .build();
   for (Topic element : topicAdminClient.listTopics(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopicsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,TopicAdminClient.ListTopicsPagedResponse> listTopicsPagedCallable()

Lists matching topics.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ListTopicsRequest request = ListTopicsRequest.newBuilder()
     .setProject(project.toString())
     .build();
   ApiFuture<ListTopicsPagedResponse> future = topicAdminClient.listTopicsPagedCallable().futureCall(request);
   // Do something
   for (Topic element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTopicsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,ListTopicsResponse> listTopicsCallable()

Lists matching topics.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ListTopicsRequest request = ListTopicsRequest.newBuilder()
     .setProject(project.toString())
     .build();
   while (true) {
     ListTopicsResponse response = topicAdminClient.listTopicsCallable().call(request);
     for (Topic element : response.getTopicsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listTopicSubscriptions

public final TopicAdminClient.ListTopicSubscriptionsPagedResponse listTopicSubscriptions(TopicName topic)

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   for (ProjectSubscriptionName element : topicAdminClient.listTopicSubscriptions(topic).iterateAllAsProjectSubscriptionName()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

topic - Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopicSubscriptions

public final TopicAdminClient.ListTopicSubscriptionsPagedResponse listTopicSubscriptions(String topic)

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   for (ProjectSubscriptionName element : topicAdminClient.listTopicSubscriptions(topic.toString()).iterateAllAsProjectSubscriptionName()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

topic - Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopicSubscriptions

public final TopicAdminClient.ListTopicSubscriptionsPagedResponse listTopicSubscriptions(ProjectTopicName topic)

Deprecated. Use listTopicSubscriptions(TopicName) instead.

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
   for (ProjectSubscriptionName element : topicAdminClient.listTopicSubscriptions(topic).iterateAllAsProjectSubscriptionName()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

topic - Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopicSubscriptions

public final TopicAdminClient.ListTopicSubscriptionsPagedResponse listTopicSubscriptions(ListTopicSubscriptionsRequest request)

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   ListTopicSubscriptionsRequest request = ListTopicSubscriptionsRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   for (ProjectSubscriptionName element : topicAdminClient.listTopicSubscriptions(request).iterateAllAsProjectSubscriptionName()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTopicSubscriptionsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,TopicAdminClient.ListTopicSubscriptionsPagedResponse> listTopicSubscriptionsPagedCallable()

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   ListTopicSubscriptionsRequest request = ListTopicSubscriptionsRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   ApiFuture<ListTopicSubscriptionsPagedResponse> future = topicAdminClient.listTopicSubscriptionsPagedCallable().futureCall(request);
   // Do something
   for (ProjectSubscriptionName element : future.get().iterateAllAsProjectSubscriptionName()) {
     // doThingsWith(element);
   }
 }
 

listTopicSubscriptionsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse> listTopicSubscriptionsCallable()

Lists the names of the subscriptions on this topic.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   ListTopicSubscriptionsRequest request = ListTopicSubscriptionsRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   while (true) {
     ListTopicSubscriptionsResponse response = topicAdminClient.listTopicSubscriptionsCallable().call(request);
     for (ProjectSubscriptionName element : ProjectSubscriptionName.parseList(response.getSubscriptionsList())) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteTopic

public final void deleteTopic(TopicName topic)

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   topicAdminClient.deleteTopic(topic);
 }
 

Parameters:

topic - Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTopic

public final void deleteTopic(String topic)

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   topicAdminClient.deleteTopic(topic.toString());
 }
 

Parameters:

topic - Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTopic

public final void deleteTopic(ProjectTopicName topic)

Deprecated. Use deleteTopic(TopicName) instead.

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");
   topicAdminClient.deleteTopic(topic);
 }
 

Parameters:

topic - Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTopic

public final void deleteTopic(DeleteTopicRequest request)

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   DeleteTopicRequest request = DeleteTopicRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   topicAdminClient.deleteTopic(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTopicCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTopicRequest,com.google.protobuf.Empty> deleteTopicCallable()

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");
   DeleteTopicRequest request = DeleteTopicRequest.newBuilder()
     .setTopic(topic.toString())
     .build();
   ApiFuture<Void> future = topicAdminClient.deleteTopicCallable().futureCall(request);
   // Do something
   future.get();
 }
 

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   Policy policy = Policy.newBuilder().build();
   SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
     .setResource(resource.toString())
     .setPolicy(policy)
     .build();
   Policy response = topicAdminClient.setIamPolicy(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(String resource,
                                                   com.google.iam.v1.Policy policy)

Deprecated. Use setIamPolicy(SetIamPolicyRequest) instead.

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   String formattedResource = ProjectTopicName.format("[PROJECT]", "[TOPIC]");
   Policy policy = Policy.newBuilder().build();
   Policy response = topicAdminClient.setIamPolicy(formattedResource, policy);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   Policy policy = Policy.newBuilder().build();
   SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
     .setResource(resource.toString())
     .setPolicy(policy)
     .build();
   ApiFuture<Policy> future = topicAdminClient.setIamPolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

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

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
     .setResource(resource.toString())
     .build();
   Policy response = topicAdminClient.getIamPolicy(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(String resource)

Deprecated. Use getIamPolicy(GetIamPolicyRequest) instead.

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 (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   String formattedResource = ProjectTopicName.format("[PROJECT]", "[TOPIC]");
   Policy response = topicAdminClient.getIamPolicy(formattedResource);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

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

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
     .setResource(resource.toString())
     .build();
   ApiFuture<Policy> future = topicAdminClient.getIamPolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
     .setResource(resource.toString())
     .addAllPermissions(permissions)
     .build();
   TestIamPermissionsResponse response = topicAdminClient.testIamPermissions(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource,
                                                                             List<String> permissions)

Deprecated. Use testIamPermissions(TestIamPermissionsRequest) instead.

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 (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   String formattedResource = ProjectTopicName.format("[PROJECT]", "[TOPIC]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response = topicAdminClient.testIamPermissions(formattedResource, permissions);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Sample code:

 try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
   ResourceName resource = ProjectName.of("[PROJECT]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
     .setResource(resource.toString())
     .addAllPermissions(permissions)
     .build();
   ApiFuture<TestIamPermissionsResponse> future = topicAdminClient.testIamPermissionsCallable().futureCall(request);
   // Do something
   TestIamPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException