Class AdminServiceGrpc.AdminServiceBlockingStub (1.13.0)

public static final class AdminServiceGrpc.AdminServiceBlockingStub extends AbstractBlockingStub<AdminServiceGrpc.AdminServiceBlockingStub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > AdminServiceGrpc.AdminServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected AdminServiceGrpc.AdminServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
AdminServiceGrpc.AdminServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createReservation(CreateReservationRequest request)

public Reservation createReservation(CreateReservationRequest request)

Creates a new reservation.

Parameter
NameDescription
requestCreateReservationRequest
Returns
TypeDescription
Reservation

createSubscription(CreateSubscriptionRequest request)

public Subscription createSubscription(CreateSubscriptionRequest request)

Creates a new subscription.

Parameter
NameDescription
requestCreateSubscriptionRequest
Returns
TypeDescription
Subscription

createTopic(CreateTopicRequest request)

public Topic createTopic(CreateTopicRequest request)

Creates a new topic.

Parameter
NameDescription
requestCreateTopicRequest
Returns
TypeDescription
Topic

deleteReservation(DeleteReservationRequest request)

public Empty deleteReservation(DeleteReservationRequest request)

Deletes the specified reservation.

Parameter
NameDescription
requestDeleteReservationRequest
Returns
TypeDescription
Empty

deleteSubscription(DeleteSubscriptionRequest request)

public Empty deleteSubscription(DeleteSubscriptionRequest request)

Deletes the specified subscription.

Parameter
NameDescription
requestDeleteSubscriptionRequest
Returns
TypeDescription
Empty

deleteTopic(DeleteTopicRequest request)

public Empty deleteTopic(DeleteTopicRequest request)

Deletes the specified topic.

Parameter
NameDescription
requestDeleteTopicRequest
Returns
TypeDescription
Empty

getReservation(GetReservationRequest request)

public Reservation getReservation(GetReservationRequest request)

Returns the reservation configuration.

Parameter
NameDescription
requestGetReservationRequest
Returns
TypeDescription
Reservation

getSubscription(GetSubscriptionRequest request)

public Subscription getSubscription(GetSubscriptionRequest request)

Returns the subscription configuration.

Parameter
NameDescription
requestGetSubscriptionRequest
Returns
TypeDescription
Subscription

getTopic(GetTopicRequest request)

public Topic getTopic(GetTopicRequest request)

Returns the topic configuration.

Parameter
NameDescription
requestGetTopicRequest
Returns
TypeDescription
Topic

getTopicPartitions(GetTopicPartitionsRequest request)

public TopicPartitions getTopicPartitions(GetTopicPartitionsRequest request)

Returns the partition information for the requested topic.

Parameter
NameDescription
requestGetTopicPartitionsRequest
Returns
TypeDescription
TopicPartitions

listReservationTopics(ListReservationTopicsRequest request)

public ListReservationTopicsResponse listReservationTopics(ListReservationTopicsRequest request)

Lists the topics attached to the specified reservation.

Parameter
NameDescription
requestListReservationTopicsRequest
Returns
TypeDescription
ListReservationTopicsResponse

listReservations(ListReservationsRequest request)

public ListReservationsResponse listReservations(ListReservationsRequest request)

Returns the list of reservations for the given project.

Parameter
NameDescription
requestListReservationsRequest
Returns
TypeDescription
ListReservationsResponse

listSubscriptions(ListSubscriptionsRequest request)

public ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)

Returns the list of subscriptions for the given project.

Parameter
NameDescription
requestListSubscriptionsRequest
Returns
TypeDescription
ListSubscriptionsResponse

listTopicSubscriptions(ListTopicSubscriptionsRequest request)

public ListTopicSubscriptionsResponse listTopicSubscriptions(ListTopicSubscriptionsRequest request)

Lists the subscriptions attached to the specified topic.

Parameter
NameDescription
requestListTopicSubscriptionsRequest
Returns
TypeDescription
ListTopicSubscriptionsResponse

listTopics(ListTopicsRequest request)

public ListTopicsResponse listTopics(ListTopicsRequest request)

Returns the list of topics for the given project.

Parameter
NameDescription
requestListTopicsRequest
Returns
TypeDescription
ListTopicsResponse

seekSubscription(SeekSubscriptionRequest request)

public 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
NameDescription
requestSeekSubscriptionRequest
Returns
TypeDescription
Operation

updateReservation(UpdateReservationRequest request)

public Reservation updateReservation(UpdateReservationRequest request)

Updates properties of the specified reservation.

Parameter
NameDescription
requestUpdateReservationRequest
Returns
TypeDescription
Reservation

updateSubscription(UpdateSubscriptionRequest request)

public Subscription updateSubscription(UpdateSubscriptionRequest request)

Updates properties of the specified subscription.

Parameter
NameDescription
requestUpdateSubscriptionRequest
Returns
TypeDescription
Subscription

updateTopic(UpdateTopicRequest request)

public Topic updateTopic(UpdateTopicRequest request)

Updates properties of the specified topic.

Parameter
NameDescription
requestUpdateTopicRequest
Returns
TypeDescription
Topic