Class AdminServiceGrpc.AdminServiceStub (1.15.0)

public static final class AdminServiceGrpc.AdminServiceStub extends AbstractAsyncStub<AdminServiceGrpc.AdminServiceStub>

A stub to allow clients to do asynchronous rpc calls to service AdminService.

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.AbstractAsyncStub > AdminServiceGrpc.AdminServiceStub

Inherited Members

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

io.grpc.stub.AbstractAsyncStub.<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(java.time.Duration)

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.withOnReadyThreshold(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.AdminServiceStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
`AdminServiceGrpc.AdminServiceStub`

Overrides

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

createReservation(CreateReservationRequest request, StreamObserver<Reservation> responseObserver)

public void createReservation(CreateReservationRequest request, StreamObserver<Reservation> responseObserver)

Creates a new reservation.

Parameters
Name	Description
`request`	`CreateReservationRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Reservation>`

createSubscription(CreateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

public void createSubscription(CreateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

Creates a new subscription.

Parameters
Name	Description
`request`	`CreateSubscriptionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Subscription>`

createTopic(CreateTopicRequest request, StreamObserver<Topic> responseObserver)

public void createTopic(CreateTopicRequest request, StreamObserver<Topic> responseObserver)

Creates a new topic.

Parameters
Name	Description
`request`	`CreateTopicRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Topic>`

deleteReservation(DeleteReservationRequest request, StreamObserver<Empty> responseObserver)

public void deleteReservation(DeleteReservationRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified reservation.

Parameters
Name	Description
`request`	`DeleteReservationRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteSubscription(DeleteSubscriptionRequest request, StreamObserver<Empty> responseObserver)

public void deleteSubscription(DeleteSubscriptionRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified subscription.

Parameters
Name	Description
`request`	`DeleteSubscriptionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTopic(DeleteTopicRequest request, StreamObserver<Empty> responseObserver)

public void deleteTopic(DeleteTopicRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified topic.

Parameters
Name	Description
`request`	`DeleteTopicRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getReservation(GetReservationRequest request, StreamObserver<Reservation> responseObserver)

public void getReservation(GetReservationRequest request, StreamObserver<Reservation> responseObserver)

Returns the reservation configuration.

Parameters
Name	Description
`request`	`GetReservationRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Reservation>`

getSubscription(GetSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

public void getSubscription(GetSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

Returns the subscription configuration.

Parameters
Name	Description
`request`	`GetSubscriptionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Subscription>`

getTopic(GetTopicRequest request, StreamObserver<Topic> responseObserver)

public void getTopic(GetTopicRequest request, StreamObserver<Topic> responseObserver)

Returns the topic configuration.

Parameters
Name	Description
`request`	`GetTopicRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Topic>`

getTopicPartitions(GetTopicPartitionsRequest request, StreamObserver<TopicPartitions> responseObserver)

public void getTopicPartitions(GetTopicPartitionsRequest request, StreamObserver<TopicPartitions> responseObserver)

Returns the partition information for the requested topic.

Parameters
Name	Description
`request`	`GetTopicPartitionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TopicPartitions>`

listReservationTopics(ListReservationTopicsRequest request, StreamObserver<ListReservationTopicsResponse> responseObserver)

public void listReservationTopics(ListReservationTopicsRequest request, StreamObserver<ListReservationTopicsResponse> responseObserver)

Lists the topics attached to the specified reservation.

Parameters
Name	Description
`request`	`ListReservationTopicsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListReservationTopicsResponse>`

listReservations(ListReservationsRequest request, StreamObserver<ListReservationsResponse> responseObserver)

public void listReservations(ListReservationsRequest request, StreamObserver<ListReservationsResponse> responseObserver)

Returns the list of reservations for the given project.

Parameters
Name	Description
`request`	`ListReservationsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListReservationsResponse>`

listSubscriptions(ListSubscriptionsRequest request, StreamObserver<ListSubscriptionsResponse> responseObserver)

public void listSubscriptions(ListSubscriptionsRequest request, StreamObserver<ListSubscriptionsResponse> responseObserver)

Returns the list of subscriptions for the given project.

Parameters
Name	Description
`request`	`ListSubscriptionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListSubscriptionsResponse>`

listTopicSubscriptions(ListTopicSubscriptionsRequest request, StreamObserver<ListTopicSubscriptionsResponse> responseObserver)

public void listTopicSubscriptions(ListTopicSubscriptionsRequest request, StreamObserver<ListTopicSubscriptionsResponse> responseObserver)

Lists the subscriptions attached to the specified topic.

Parameters
Name	Description
`request`	`ListTopicSubscriptionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListTopicSubscriptionsResponse>`

listTopics(ListTopicsRequest request, StreamObserver<ListTopicsResponse> responseObserver)

public void listTopics(ListTopicsRequest request, StreamObserver<ListTopicsResponse> responseObserver)

Returns the list of topics for the given project.

Parameters
Name	Description
`request`	`ListTopicsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListTopicsResponse>`

seekSubscription(SeekSubscriptionRequest request, StreamObserver<Operation> responseObserver)

public void seekSubscription(SeekSubscriptionRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`SeekSubscriptionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateReservation(UpdateReservationRequest request, StreamObserver<Reservation> responseObserver)

public void updateReservation(UpdateReservationRequest request, StreamObserver<Reservation> responseObserver)

Updates properties of the specified reservation.

Parameters
Name	Description
`request`	`UpdateReservationRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Reservation>`

updateSubscription(UpdateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

public void updateSubscription(UpdateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)

Updates properties of the specified subscription.

Parameters
Name	Description
`request`	`UpdateSubscriptionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Subscription>`

updateTopic(UpdateTopicRequest request, StreamObserver<Topic> responseObserver)

public void updateTopic(UpdateTopicRequest request, StreamObserver<Topic> responseObserver)

Updates properties of the specified topic.

Parameters
Name	Description
`request`	`UpdateTopicRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Topic>`