Class AdminServiceGrpc.AdminServiceFutureStub (1.9.0)

public static final class AdminServiceGrpc.AdminServiceFutureStub extends AbstractFutureStub<AdminServiceGrpc.AdminServiceFutureStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AdminServiceGrpc.AdminServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

build(Channel channel, CallOptions callOptions)

protected AdminServiceGrpc.AdminServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
AdminServiceGrpc.AdminServiceFutureStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createReservation(CreateReservationRequest request)

public ListenableFuture<Reservation> createReservation(CreateReservationRequest request)

Creates a new reservation.

Parameter

Name	Description
request	`CreateReservationRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Reservation>

createSubscription(CreateSubscriptionRequest request)

public ListenableFuture<Subscription> createSubscription(CreateSubscriptionRequest request)

Creates a new subscription.

Parameter

Name	Description
request	`CreateSubscriptionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Subscription>

createTopic(CreateTopicRequest request)

public ListenableFuture<Topic> createTopic(CreateTopicRequest request)

Creates a new topic.

Parameter

Name	Description
request	`CreateTopicRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Topic>

deleteReservation(DeleteReservationRequest request)

public ListenableFuture<Empty> deleteReservation(DeleteReservationRequest request)

Deletes the specified reservation.

Parameter

Name	Description
request	`DeleteReservationRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteSubscription(DeleteSubscriptionRequest request)

public ListenableFuture<Empty> deleteSubscription(DeleteSubscriptionRequest request)

Deletes the specified subscription.

Parameter

Name	Description
request	`DeleteSubscriptionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTopic(DeleteTopicRequest request)

public ListenableFuture<Empty> deleteTopic(DeleteTopicRequest request)

Deletes the specified topic.

Parameter

Name	Description
request	`DeleteTopicRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getReservation(GetReservationRequest request)

public ListenableFuture<Reservation> getReservation(GetReservationRequest request)

Returns the reservation configuration.

Parameter

Name	Description
request	`GetReservationRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Reservation>

getSubscription(GetSubscriptionRequest request)

public ListenableFuture<Subscription> getSubscription(GetSubscriptionRequest request)

Returns the subscription configuration.

Parameter

Name	Description
request	`GetSubscriptionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Subscription>

getTopic(GetTopicRequest request)

public ListenableFuture<Topic> getTopic(GetTopicRequest request)

Returns the topic configuration.

Parameter

Name	Description
request	`GetTopicRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Topic>

getTopicPartitions(GetTopicPartitionsRequest request)

public ListenableFuture<TopicPartitions> getTopicPartitions(GetTopicPartitionsRequest request)

Returns the partition information for the requested topic.

Parameter

Name	Description
request	`GetTopicPartitionsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<TopicPartitions>

listReservationTopics(ListReservationTopicsRequest request)

public ListenableFuture<ListReservationTopicsResponse> listReservationTopics(ListReservationTopicsRequest request)

Lists the topics attached to the specified reservation.

Parameter

Name	Description
request	`ListReservationTopicsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListReservationTopicsResponse>

listReservations(ListReservationsRequest request)

public ListenableFuture<ListReservationsResponse> listReservations(ListReservationsRequest request)

Returns the list of reservations for the given project.

Parameter

Name	Description
request	`ListReservationsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListReservationsResponse>

listSubscriptions(ListSubscriptionsRequest request)

public ListenableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest request)

Returns the list of subscriptions for the given project.

Parameter

Name	Description
request	`ListSubscriptionsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListSubscriptionsResponse>

listTopicSubscriptions(ListTopicSubscriptionsRequest request)

public ListenableFuture<ListTopicSubscriptionsResponse> listTopicSubscriptions(ListTopicSubscriptionsRequest request)

Lists the subscriptions attached to the specified topic.

Parameter

Name	Description
request	`ListTopicSubscriptionsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListTopicSubscriptionsResponse>

listTopics(ListTopicsRequest request)

public ListenableFuture<ListTopicsResponse> listTopics(ListTopicsRequest request)

Returns the list of topics for the given project.

Parameter

Name	Description
request	`ListTopicsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListTopicsResponse>

seekSubscription(SeekSubscriptionRequest request)

public ListenableFuture<Operation> seekSubscription(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. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.

Parameter

Name	Description
request	`SeekSubscriptionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateReservation(UpdateReservationRequest request)

public ListenableFuture<Reservation> updateReservation(UpdateReservationRequest request)

Updates properties of the specified reservation.

Parameter

Name	Description
request	`UpdateReservationRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Reservation>

updateSubscription(UpdateSubscriptionRequest request)

public ListenableFuture<Subscription> updateSubscription(UpdateSubscriptionRequest request)

Updates properties of the specified subscription.

Parameter

Name	Description
request	`UpdateSubscriptionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Subscription>

updateTopic(UpdateTopicRequest request)

public ListenableFuture<Topic> updateTopic(UpdateTopicRequest request)

Updates properties of the specified topic.

Parameter

Name	Description
request	`UpdateTopicRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Topic>