Class AdminClientImpl (1.8.0)

Version 1.8.0

• 1.14.7 (latest)
• 1.14.4
• 1.13.8
• 1.12.22
• 1.11.2
• 1.10.0
• 1.9.4
• 1.8.0
• 1.7.1
• 1.6.3
• 1.5.5
• 1.4.12

public class AdminClientImpl extends ApiResourceAggregation implements AdminClient

Inheritance

java.lang.Object > ApiResourceAggregation > AdminClientImpl

Implements

AdminClient

Inherited Members

ApiResourceAggregation.awaitTermination(long,TimeUnit)

ApiResourceAggregation.close()

ApiResourceAggregation.isShutdown()

ApiResourceAggregation.isTerminated()

ApiResourceAggregation.shutdown()

ApiResourceAggregation.shutdownNow()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

AdminClientImpl(CloudRegion region, AdminServiceClient serviceClient)

public AdminClientImpl(CloudRegion region, AdminServiceClient serviceClient)

Parameters

Name	Description
region	CloudRegion
serviceClient	AdminServiceClient

Methods

createReservation(Reservation reservation)

public ApiFuture<Reservation> createReservation(Reservation reservation)

Create the provided reservation if it does not yet exist.

Parameter

Name	Description
reservation	Reservation

Returns

Type	Description
ApiFuture<Reservation>

createSubscription(Subscription subscription, BacklogLocation startingOffset)

public ApiFuture<Subscription> createSubscription(Subscription subscription, BacklogLocation startingOffset)

Create the provided subscription at the given starting offset if it does not yet exist.

Parameters

Name	Description
subscription	Subscription
startingOffset	BacklogLocation

Returns

Type	Description
ApiFuture<Subscription>

createSubscription(Subscription subscription, SeekTarget target)

public ApiFuture<Subscription> createSubscription(Subscription subscription, SeekTarget target)

Create the provided subscription at the given target location within the message backlog, if it does not yet exist.

A seek is initiated if the target location is a publish or event time. If the seek fails, the created subscription is not deleted.

Parameters

Name	Description
subscription	Subscription
target	SeekTarget

Returns

Type	Description
ApiFuture<Subscription>

createTopic(Topic topic)

public ApiFuture<Topic> createTopic(Topic topic)

Create the provided topic if it does not yet exist.

Parameter

Name	Description
topic	Topic

Returns

Type	Description
ApiFuture<Topic>

deleteReservation(ReservationPath path)

public ApiFuture<Void> deleteReservation(ReservationPath path)

Delete the reservation with id id if it exists.

Parameter

Name	Description
path	ReservationPath

Returns

Type	Description
ApiFuture<Void>

deleteSubscription(SubscriptionPath path)

public ApiFuture<Void> deleteSubscription(SubscriptionPath path)

Delete the subscription with id id if it exists.

Parameter

Name	Description
path	SubscriptionPath

Returns

Type	Description
ApiFuture<Void>

deleteTopic(TopicPath path)

public ApiFuture<Void> deleteTopic(TopicPath path)

Delete the topic with id id if it exists.

Parameter

Name	Description
path	TopicPath

Returns

Type	Description
ApiFuture<Void>

getReservation(ReservationPath path)

public ApiFuture<Reservation> getReservation(ReservationPath path)

Get the reservation with id id if it exists.

Parameter

Name	Description
path	ReservationPath

Returns

Type	Description
ApiFuture<Reservation>

getSubscription(SubscriptionPath path)

public ApiFuture<Subscription> getSubscription(SubscriptionPath path)

Get the subscription with id id if it exists.

Parameter

Name	Description
path	SubscriptionPath

Returns

Type	Description
ApiFuture<Subscription>

getTopic(TopicPath path)

public ApiFuture<Topic> getTopic(TopicPath path)

Get the topic with id id if it exists.

Parameter

Name	Description
path	TopicPath

Returns

Type	Description
ApiFuture<Topic>

getTopicPartitionCount(TopicPath path)

public ApiFuture<Long> getTopicPartitionCount(TopicPath path)

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

Parameter

Name	Description
path	TopicPath

Returns

Type	Description
ApiFuture<Long>

listReservationTopics(ReservationPath path)

public ApiFuture<List<TopicPath>> listReservationTopics(ReservationPath path)

Get the list of topics for the reservation with id id if it exists.

Parameter

Name	Description
path	ReservationPath

Returns

Type	Description
ApiFuture<List<TopicPath>>

listReservations(LocationPath path)

public ApiFuture<List<Reservation>> listReservations(LocationPath path)

List all reservations for the specified project.

Parameter

Name	Description
path	LocationPath

Returns

Type	Description
ApiFuture<List<Reservation>>

listSubscriptions(LocationPath path)

public ApiFuture<List<Subscription>> listSubscriptions(LocationPath path)

List all subscriptions for the specified project.

Parameter

Name	Description
path	LocationPath

Returns

Type	Description
ApiFuture<List<Subscription>>

listTopicSubscriptions(TopicPath path)

public ApiFuture<List<SubscriptionPath>> listTopicSubscriptions(TopicPath path)

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

Parameter

Name	Description
path	TopicPath

Returns

Type	Description
ApiFuture<List<SubscriptionPath>>

listTopics(LocationPath path)

public ApiFuture<List<Topic>> listTopics(LocationPath path)

List all topics for the specified project.

Parameter

Name	Description
path	LocationPath

Returns

Type	Description
ApiFuture<List<Topic>>

region()

public CloudRegion region()

The Google Cloud region this client operates on.

Returns

Type	Description
CloudRegion

seekSubscription(SubscriptionPath path, SeekTarget target)

public OperationFuture<SeekSubscriptionResponse,OperationMetadata> seekSubscription(SubscriptionPath path, SeekTarget target)

Initiate an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog.

See https://cloud.google.com/pubsub/lite/docs/seek for more information.

Parameters

Name	Description
path	SubscriptionPath
target	SeekTarget

Returns

Type	Description
OperationFuture<SeekSubscriptionResponse,OperationMetadata>

updateReservation(Reservation reservation, FieldMask mask)

public ApiFuture<Reservation> updateReservation(Reservation reservation, FieldMask mask)

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

Parameters

Name	Description
reservation	Reservation
mask	FieldMask

Returns

Type	Description
ApiFuture<Reservation>

updateSubscription(Subscription subscription, FieldMask mask)

public ApiFuture<Subscription> updateSubscription(Subscription subscription, FieldMask mask)

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

Parameters

Name	Description
subscription	Subscription
mask	FieldMask

Returns

Type	Description
ApiFuture<Subscription>

updateTopic(Topic topic, FieldMask mask)

public ApiFuture<Topic> updateTopic(Topic topic, FieldMask mask)

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

Parameters

Name	Description
topic	Topic
mask	FieldMask

Returns

Type	Description
ApiFuture<Topic>