AdminServiceClient (Google Cloud Pub/Sub Lite 1.8.0 API)

java.lang.Object
- com.google.cloud.pubsublite.v1.AdminServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: The service that a client application uses to manage topics and subscriptions, such creating, listing, and deleting topics and subscriptions.

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Topic topic = Topic.newBuilder().build();
   String topicId = "topicId-1139259734";
   Topic response = adminServiceClient.createTopic(parent, topic, topicId);
 }

Note: close() needs to be called on the AdminServiceClient 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 AdminServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AdminServiceSettings adminServiceSettings =
     AdminServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdminServiceClient adminServiceClient = AdminServiceClient.create(adminServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AdminServiceSettings adminServiceSettings =
     AdminServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdminServiceClient adminServiceClient = AdminServiceClient.create(adminServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AdminServiceClient.ListReservationsFixedSizeCollection`
`static class`	`AdminServiceClient.ListReservationsPage`
`static class`	`AdminServiceClient.ListReservationsPagedResponse`
`static class`	`AdminServiceClient.ListReservationTopicsFixedSizeCollection`
`static class`	`AdminServiceClient.ListReservationTopicsPage`
`static class`	`AdminServiceClient.ListReservationTopicsPagedResponse`
`static class`	`AdminServiceClient.ListSubscriptionsFixedSizeCollection`
`static class`	`AdminServiceClient.ListSubscriptionsPage`
`static class`	`AdminServiceClient.ListSubscriptionsPagedResponse`
`static class`	`AdminServiceClient.ListTopicsFixedSizeCollection`
`static class`	`AdminServiceClient.ListTopicsPage`
`static class`	`AdminServiceClient.ListTopicsPagedResponse`
`static class`	`AdminServiceClient.ListTopicSubscriptionsFixedSizeCollection`
`static class`	`AdminServiceClient.ListTopicSubscriptionsPage`
`static class`	`AdminServiceClient.ListTopicSubscriptionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AdminServiceClient(AdminServiceSettings settings)` Constructs an instance of AdminServiceClient, using the given settings.
`protected`	`AdminServiceClient(AdminServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AdminServiceClient`	`create()` Constructs an instance of AdminServiceClient with default settings.
`static AdminServiceClient`	`create(AdminServiceSettings settings)` Constructs an instance of AdminServiceClient, using the given settings.
`static AdminServiceClient`	`create(AdminServiceStub stub)` Constructs an instance of AdminServiceClient, using the given stub for making calls.
`Reservation`	`createReservation(CreateReservationRequest request)` Creates a new reservation.
`Reservation`	`createReservation(LocationName parent, Reservation reservation, String reservationId)` Creates a new reservation.
`Reservation`	`createReservation(String parent, Reservation reservation, String reservationId)` Creates a new reservation.
`com.google.api.gax.rpc.UnaryCallable<CreateReservationRequest,Reservation>`	`createReservationCallable()` Creates a new reservation.
`Subscription`	`createSubscription(CreateSubscriptionRequest request)` Creates a new subscription.
`Subscription`	`createSubscription(LocationName parent, Subscription subscription, String subscriptionId)` Creates a new subscription.
`Subscription`	`createSubscription(String parent, Subscription subscription, String subscriptionId)` Creates a new subscription.
`com.google.api.gax.rpc.UnaryCallable<CreateSubscriptionRequest,Subscription>`	`createSubscriptionCallable()` Creates a new subscription.
`Topic`	`createTopic(CreateTopicRequest request)` Creates a new topic.
`Topic`	`createTopic(LocationName parent, Topic topic, String topicId)` Creates a new topic.
`Topic`	`createTopic(String parent, Topic topic, String topicId)` Creates a new topic.
`com.google.api.gax.rpc.UnaryCallable<CreateTopicRequest,Topic>`	`createTopicCallable()` Creates a new topic.
`void`	`deleteReservation(DeleteReservationRequest request)` Deletes the specified reservation.
`void`	`deleteReservation(ReservationName name)` Deletes the specified reservation.
`void`	`deleteReservation(String name)` Deletes the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<DeleteReservationRequest,com.google.protobuf.Empty>`	`deleteReservationCallable()` Deletes the specified reservation.
`void`	`deleteSubscription(DeleteSubscriptionRequest request)` Deletes the specified subscription.
`void`	`deleteSubscription(String name)` Deletes the specified subscription.
`void`	`deleteSubscription(SubscriptionName name)` Deletes the specified subscription.
`com.google.api.gax.rpc.UnaryCallable<DeleteSubscriptionRequest,com.google.protobuf.Empty>`	`deleteSubscriptionCallable()` Deletes the specified subscription.
`void`	`deleteTopic(DeleteTopicRequest request)` Deletes the specified topic.
`void`	`deleteTopic(String name)` Deletes the specified topic.
`void`	`deleteTopic(TopicName name)` Deletes the specified topic.
`com.google.api.gax.rpc.UnaryCallable<DeleteTopicRequest,com.google.protobuf.Empty>`	`deleteTopicCallable()` Deletes the specified topic.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Reservation`	`getReservation(GetReservationRequest request)` Returns the reservation configuration.
`Reservation`	`getReservation(ReservationName name)` Returns the reservation configuration.
`Reservation`	`getReservation(String name)` Returns the reservation configuration.
`com.google.api.gax.rpc.UnaryCallable<GetReservationRequest,Reservation>`	`getReservationCallable()` Returns the reservation configuration.
`AdminServiceSettings`	`getSettings()`
`AdminServiceStub`	`getStub()`
`Subscription`	`getSubscription(GetSubscriptionRequest request)` Returns the subscription configuration.
`Subscription`	`getSubscription(String name)` Returns the subscription configuration.
`Subscription`	`getSubscription(SubscriptionName name)` Returns the subscription configuration.
`com.google.api.gax.rpc.UnaryCallable<GetSubscriptionRequest,Subscription>`	`getSubscriptionCallable()` Returns the subscription configuration.
`Topic`	`getTopic(GetTopicRequest request)` Returns the topic configuration.
`Topic`	`getTopic(String name)` Returns the topic configuration.
`Topic`	`getTopic(TopicName name)` Returns the topic configuration.
`com.google.api.gax.rpc.UnaryCallable<GetTopicRequest,Topic>`	`getTopicCallable()` Returns the topic configuration.
`TopicPartitions`	`getTopicPartitions(GetTopicPartitionsRequest request)` Returns the partition information for the requested topic.
`TopicPartitions`	`getTopicPartitions(String name)` Returns the partition information for the requested topic.
`TopicPartitions`	`getTopicPartitions(TopicName name)` Returns the partition information for the requested topic.
`com.google.api.gax.rpc.UnaryCallable<GetTopicPartitionsRequest,TopicPartitions>`	`getTopicPartitionsCallable()` Returns the partition information for the requested topic.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AdminServiceClient.ListReservationsPagedResponse`	`listReservations(ListReservationsRequest request)` Returns the list of reservations for the given project.
`AdminServiceClient.ListReservationsPagedResponse`	`listReservations(LocationName parent)` Returns the list of reservations for the given project.
`AdminServiceClient.ListReservationsPagedResponse`	`listReservations(String parent)` Returns the list of reservations for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListReservationsRequest,ListReservationsResponse>`	`listReservationsCallable()` Returns the list of reservations for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListReservationsRequest,AdminServiceClient.ListReservationsPagedResponse>`	`listReservationsPagedCallable()` Returns the list of reservations for the given project.
`AdminServiceClient.ListReservationTopicsPagedResponse`	`listReservationTopics(ListReservationTopicsRequest request)` Lists the topics attached to the specified reservation.
`AdminServiceClient.ListReservationTopicsPagedResponse`	`listReservationTopics(ReservationName name)` Lists the topics attached to the specified reservation.
`AdminServiceClient.ListReservationTopicsPagedResponse`	`listReservationTopics(String name)` Lists the topics attached to the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<ListReservationTopicsRequest,ListReservationTopicsResponse>`	`listReservationTopicsCallable()` Lists the topics attached to the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<ListReservationTopicsRequest,AdminServiceClient.ListReservationTopicsPagedResponse>`	`listReservationTopicsPagedCallable()` Lists the topics attached to the specified reservation.
`AdminServiceClient.ListSubscriptionsPagedResponse`	`listSubscriptions(ListSubscriptionsRequest request)` Returns the list of subscriptions for the given project.
`AdminServiceClient.ListSubscriptionsPagedResponse`	`listSubscriptions(LocationName parent)` Returns the list of subscriptions for the given project.
`AdminServiceClient.ListSubscriptionsPagedResponse`	`listSubscriptions(String parent)` Returns the list of subscriptions for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse>`	`listSubscriptionsCallable()` Returns the list of subscriptions for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,AdminServiceClient.ListSubscriptionsPagedResponse>`	`listSubscriptionsPagedCallable()` Returns the list of subscriptions for the given project.
`AdminServiceClient.ListTopicsPagedResponse`	`listTopics(ListTopicsRequest request)` Returns the list of topics for the given project.
`AdminServiceClient.ListTopicsPagedResponse`	`listTopics(LocationName parent)` Returns the list of topics for the given project.
`AdminServiceClient.ListTopicsPagedResponse`	`listTopics(String parent)` Returns the list of topics for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,ListTopicsResponse>`	`listTopicsCallable()` Returns the list of topics for the given project.
`com.google.api.gax.rpc.UnaryCallable<ListTopicsRequest,AdminServiceClient.ListTopicsPagedResponse>`	`listTopicsPagedCallable()` Returns the list of topics for the given project.
`AdminServiceClient.ListTopicSubscriptionsPagedResponse`	`listTopicSubscriptions(ListTopicSubscriptionsRequest request)` Lists the subscriptions attached to the specified topic.
`AdminServiceClient.ListTopicSubscriptionsPagedResponse`	`listTopicSubscriptions(String name)` Lists the subscriptions attached to the specified topic.
`AdminServiceClient.ListTopicSubscriptionsPagedResponse`	`listTopicSubscriptions(TopicName name)` Lists the subscriptions attached to the specified topic.
`com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse>`	`listTopicSubscriptionsCallable()` Lists the subscriptions attached to the specified topic.
`com.google.api.gax.rpc.UnaryCallable<ListTopicSubscriptionsRequest,AdminServiceClient.ListTopicSubscriptionsPagedResponse>`	`listTopicSubscriptionsPagedCallable()` Lists the subscriptions attached to the specified topic.
`com.google.api.gax.longrunning.OperationFuture<SeekSubscriptionResponse,OperationMetadata>`	`seekSubscriptionAsync(SeekSubscriptionRequest request)` Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog.
`com.google.api.gax.rpc.UnaryCallable<SeekSubscriptionRequest,com.google.longrunning.Operation>`	`seekSubscriptionCallable()` Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog.
`com.google.api.gax.rpc.OperationCallable<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata>`	`seekSubscriptionOperationCallable()` Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Reservation`	`updateReservation(Reservation reservation, com.google.protobuf.FieldMask updateMask)` Updates properties of the specified reservation.
`Reservation`	`updateReservation(UpdateReservationRequest request)` Updates properties of the specified reservation.
`com.google.api.gax.rpc.UnaryCallable<UpdateReservationRequest,Reservation>`	`updateReservationCallable()` Updates properties of the specified reservation.
`Subscription`	`updateSubscription(Subscription subscription, com.google.protobuf.FieldMask updateMask)` Updates properties of the specified subscription.
`Subscription`	`updateSubscription(UpdateSubscriptionRequest request)` Updates properties of the specified subscription.
`com.google.api.gax.rpc.UnaryCallable<UpdateSubscriptionRequest,Subscription>`	`updateSubscriptionCallable()` Updates properties of the specified subscription.
`Topic`	`updateTopic(Topic topic, com.google.protobuf.FieldMask updateMask)` Updates properties of the specified topic.
`Topic`	`updateTopic(UpdateTopicRequest request)` Updates properties of the specified topic.
`com.google.api.gax.rpc.UnaryCallable<UpdateTopicRequest,Topic>`	`updateTopicCallable()` Updates properties of the specified topic.

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

Constructor Detail
- AdminServiceClient
```
protected AdminServiceClient(AdminServiceSettings settings)
                      throws IOException
```
  Constructs an instance of AdminServiceClient, 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
- AdminServiceClient
```
protected AdminServiceClient(AdminServiceStub stub)
```

Method Detail

create

public static final AdminServiceClient create()
                                       throws IOException

Constructs an instance of AdminServiceClient with default settings.

Throws:: IOException

create
```
public static final AdminServiceClient create(AdminServiceSettings settings)
                                       throws IOException
```
Constructs an instance of AdminServiceClient, 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
```
public static final AdminServiceClient create(AdminServiceStub stub)
```
Constructs an instance of AdminServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AdminServiceSettings).

getSettings

public final AdminServiceSettings getSettings()

getStub
```
public AdminServiceStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createTopic

public final Topic createTopic(LocationName parent,
                               Topic topic,
                               String topicId)

Creates a new topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Topic topic = Topic.newBuilder().build();
   String topicId = "topicId-1139259734";
   Topic response = adminServiceClient.createTopic(parent, topic, topicId);
 }

Parameters:: parent - Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`.; topic - Required. Configuration of the topic to create. Its `name` field is ignored.; topicId - Required. The ID to use for the topic, which will become the final component of the topic's name.
This value is structured like: `my-topic-name`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createTopic

public final Topic createTopic(String parent,
                               Topic topic,
                               String topicId)

Creates a new topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Topic topic = Topic.newBuilder().build();
   String topicId = "topicId-1139259734";
   Topic response = adminServiceClient.createTopic(parent, topic, topicId);
 }

Parameters:: parent - Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`.; topic - Required. Configuration of the topic to create. Its `name` field is ignored.; topicId - Required. The ID to use for the topic, which will become the final component of the topic's name.
This value is structured like: `my-topic-name`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createTopic

public final Topic createTopic(CreateTopicRequest request)

Creates a new topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   CreateTopicRequest request =
       CreateTopicRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTopic(Topic.newBuilder().build())
           .setTopicId("topicId-1139259734")
           .build();
   Topic response = adminServiceClient.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<CreateTopicRequest,Topic> createTopicCallable()

Creates a new topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   CreateTopicRequest request =
       CreateTopicRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTopic(Topic.newBuilder().build())
           .setTopicId("topicId-1139259734")
           .build();
   ApiFuture<Topic> future = adminServiceClient.createTopicCallable().futureCall(request);
   // Do something.
   Topic response = future.get();
 }

getTopic

public final Topic getTopic(TopicName name)

Returns the topic configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   TopicName name = TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]");
   Topic response = adminServiceClient.getTopic(name);
 }

Parameters:: name - Required. The name of the topic whose configuration to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTopic

public final Topic getTopic(String name)

Returns the topic configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   String name = TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString();
   Topic response = adminServiceClient.getTopic(name);
 }

Parameters:: name - Required. The name of the topic whose configuration to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTopic

public final Topic getTopic(GetTopicRequest request)

Returns the topic configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   GetTopicRequest request =
       GetTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .build();
   Topic response = adminServiceClient.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()

Returns the topic configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   GetTopicRequest request =
       GetTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .build();
   ApiFuture<Topic> future = adminServiceClient.getTopicCallable().futureCall(request);
   // Do something.
   Topic response = future.get();
 }

getTopicPartitions

public final TopicPartitions getTopicPartitions(TopicName name)

Returns the partition information for the requested topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   TopicName name = TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]");
   TopicPartitions response = adminServiceClient.getTopicPartitions(name);
 }

Parameters:: name - Required. The topic whose partition information to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTopicPartitions

public final TopicPartitions getTopicPartitions(String name)

Returns the partition information for the requested topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   String name = TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString();
   TopicPartitions response = adminServiceClient.getTopicPartitions(name);
 }

Parameters:: name - Required. The topic whose partition information to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTopicPartitions

public final TopicPartitions getTopicPartitions(GetTopicPartitionsRequest request)

Returns the partition information for the requested topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   GetTopicPartitionsRequest request =
       GetTopicPartitionsRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .build();
   TopicPartitions response = adminServiceClient.getTopicPartitions(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

getTopicPartitionsCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTopicPartitionsRequest,TopicPartitions> getTopicPartitionsCallable()

Returns the partition information for the requested topic.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdminServiceClient adminServiceClient = AdminServiceClient.create()) {
   GetTopicPartitionsRequest request =
       GetTopicPartitionsRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .build();
   ApiFuture<TopicPartitions> future =
       adminServiceClient.getTopicPartitionsCallable().futureCall(request);
   // Do something.
   TopicPartitions response = future.get();
 }