com.google.cloud.pubsublite.internal

Class AdminClientImpl

java.lang.Object

com.google.api.gax.core.BackgroundResourceAggregation

com.google.cloud.pubsublite.internal.AdminClientImpl

All Implemented Interfaces:

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

public class AdminClientImpl
extends com.google.api.gax.core.BackgroundResourceAggregation
implements AdminClient

Constructor Summary

Constructors

Constructor and Description
AdminClientImpl(CloudRegion region, AdminServiceGrpc.AdminServiceBlockingStub stub, com.google.api.gax.retrying.RetrySettings retrySettings)

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<Subscription>	createSubscription(Subscription subscription) Create the provided subscription if it does not yet exist.
com.google.api.core.ApiFuture<Topic>	createTopic(Topic topic) Create the provided topic if it does not yet exist.
com.google.api.core.ApiFuture<Void>	deleteSubscription(SubscriptionPath path) Delete the subscription with id id if it exists.
com.google.api.core.ApiFuture<Void>	deleteTopic(TopicPath path) Delete the topic with id id if it exists.
com.google.api.core.ApiFuture<Subscription>	getSubscription(SubscriptionPath path) Get the subscription with id id if it exists.
com.google.api.core.ApiFuture<Topic>	getTopic(TopicPath path) Get the topic with id id if it exists.
com.google.api.core.ApiFuture<Long>	getTopicPartitionCount(TopicPath path) Get the partitioning info for the topic with id id if it exists.
com.google.api.core.ApiFuture<List<Subscription>>	listSubscriptions(LocationPath path) List all subscriptions for the specified project.
com.google.api.core.ApiFuture<List<Topic>>	listTopics(LocationPath path) List all topics for the specified project.
com.google.api.core.ApiFuture<List<SubscriptionPath>>	listTopicSubscriptions(TopicPath path) Get the list of subscriptions for the topic with id id if it exists.
CloudRegion	region() The Google Cloud region this client operates on.
com.google.api.core.ApiFuture<Subscription>	updateSubscription(Subscription subscription, com.google.protobuf.FieldMask mask) Update the subscription with path subscription.getPath() if it exists.
com.google.api.core.ApiFuture<Topic>	updateTopic(Topic topic, com.google.protobuf.FieldMask mask) Update the topic with path topic.getPath() if it exists.

Methods inherited from class com.google.api.gax.core.BackgroundResourceAggregation

awaitTermination, close, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.pubsublite.AdminClient

create

Methods inherited from interface com.google.api.gax.core.BackgroundResource

awaitTermination, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

AdminClientImpl

public AdminClientImpl(CloudRegion region,
                       AdminServiceGrpc.AdminServiceBlockingStub stub,
                       com.google.api.gax.retrying.RetrySettings retrySettings)

Method Detail

region

public CloudRegion region()

Description copied from interface: AdminClient

The Google Cloud region this client operates on.

Specified by:

region in interface AdminClient

createTopic

public com.google.api.core.ApiFuture<Topic> createTopic(Topic topic)

Description copied from interface: AdminClient

Create the provided topic if it does not yet exist.

Specified by:

createTopic in interface AdminClient

Parameters:

topic - The topic to create.

Returns:

A future that will have either an error StatusException or the topic on success.

getTopic

public com.google.api.core.ApiFuture<Topic> getTopic(TopicPath path)

Description copied from interface: AdminClient

Get the topic with id id if it exists.

Specified by:

getTopic in interface AdminClient

Parameters:

path - The path of the topic to retrieve.

Returns:

A future that will have either an error StatusException or the topic on success.

getTopicPartitionCount

public com.google.api.core.ApiFuture<Long> getTopicPartitionCount(TopicPath path)

Description copied from interface: AdminClient

Get the partitioning info for the topic with id id if it exists.

Specified by:

getTopicPartitionCount in interface AdminClient

Parameters:

path - The path of the topic to retrieve.

Returns:

A future that will have either an error StatusException or the number of topic partitions on success.

listTopics

public com.google.api.core.ApiFuture<List<Topic>> listTopics(LocationPath path)

Description copied from interface: AdminClient

List all topics for the specified project.

Specified by:

listTopics in interface AdminClient

Parameters:

path - The path of the project to list topics for.

Returns:

A future that will have either an error StatusException or the list of topic paths on success.

updateTopic

public com.google.api.core.ApiFuture<Topic> updateTopic(Topic topic,
                                                        com.google.protobuf.FieldMask mask)

Description copied from interface: AdminClient

Update the topic with path topic.getPath() if it exists.

Specified by:

updateTopic in interface AdminClient

Parameters:

topic - The topic to update.

mask - The mask indicating which fields should be updated.

Returns:

A future that will have either an error StatusException or the resulting topic on success. Updating nonexistent topics will cause the future to have an exception with status Status.Code.NOT_FOUND

deleteTopic

public com.google.api.core.ApiFuture<Void> deleteTopic(TopicPath path)

Description copied from interface: AdminClient

Delete the topic with id id if it exists.

Specified by:

deleteTopic in interface AdminClient

Parameters:

path - The path of the topic to retrieve.

Returns:

A future that will have either an error StatusException or void on success. Deleting nonexistent topics will cause the future to have an exception with status Status.Code.NOT_FOUND

listTopicSubscriptions

public com.google.api.core.ApiFuture<List<SubscriptionPath>> listTopicSubscriptions(TopicPath path)

Description copied from interface: AdminClient

Get the list of subscriptions for the topic with id id if it exists.

Specified by:

listTopicSubscriptions in interface AdminClient

Parameters:

path - The path of the topic to retrieve.

Returns:

A future that will have either an error StatusException or the list of subscriptions on success.

createSubscription

public com.google.api.core.ApiFuture<Subscription> createSubscription(Subscription subscription)

Description copied from interface: AdminClient

Create the provided subscription if it does not yet exist.

Specified by:

createSubscription in interface AdminClient

Parameters:

subscription - The subscription to create.

Returns:

A future that will have either an error StatusException or the subscription on success.

getSubscription

public com.google.api.core.ApiFuture<Subscription> getSubscription(SubscriptionPath path)

Description copied from interface: AdminClient

Get the subscription with id id if it exists.

Specified by:

getSubscription in interface AdminClient

Parameters:

path - The path of the subscription to retrieve.

Returns:

A future that will have either an error StatusException or the subscription on success.

listSubscriptions

public com.google.api.core.ApiFuture<List<Subscription>> listSubscriptions(LocationPath path)

Description copied from interface: AdminClient

List all subscriptions for the specified project.

Specified by:

listSubscriptions in interface AdminClient

Parameters:

path - The path of the project to list subscriptions for.

Returns:

A future that will have either an error StatusException or the list of subscription paths on success.

updateSubscription

public com.google.api.core.ApiFuture<Subscription> updateSubscription(Subscription subscription,
                                                                      com.google.protobuf.FieldMask mask)

Description copied from interface: AdminClient

Update the subscription with path subscription.getPath() if it exists.

Specified by:

updateSubscription in interface AdminClient

Parameters:

subscription - The subscription to update.

mask - The mask indicating which fields should be updated.

Returns:

A future that will have either an error StatusException or the resulting subscription on success. Updating nonexistent subscriptions will cause the future to have an exception with status Status.Code.NOT_FOUND

deleteSubscription

public com.google.api.core.ApiFuture<Void> deleteSubscription(SubscriptionPath path)

Description copied from interface: AdminClient

Delete the subscription with id id if it exists.

Specified by:

deleteSubscription in interface AdminClient

Parameters:

path - The path of the subscription to retrieve.

Returns:

A future that will have either an error StatusException or void on success. Deleting nonexistent subscriptions will cause the future to have an exception with status Status.Code.NOT_FOUND