Class PublisherGrpc.PublisherFutureStub (1.130.0)

public static final class PublisherGrpc.PublisherFutureStub extends AbstractFutureStub<PublisherGrpc.PublisherFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Publisher.

The service that an application uses to manipulate topics, and to send messages to a topic.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > PublisherGrpc.PublisherFutureStub

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

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

Returns
Type	Description
`PublisherGrpc.PublisherFutureStub`

Overrides

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

createTopic(Topic request)

public ListenableFuture<Topic> createTopic(Topic request)

Creates the given topic with the given name. See the resource name rules.

Parameter
Name	Description
`request`	`Topic`

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

deleteTopic(DeleteTopicRequest request)

public ListenableFuture<Empty> deleteTopic(DeleteTopicRequest request)

Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to deleted-topic.

Parameter
Name	Description
`request`	`DeleteTopicRequest`

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

detachSubscription(DetachSubscriptionRequest request)

public ListenableFuture<DetachSubscriptionResponse> detachSubscription(DetachSubscriptionRequest request)

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

Parameter
Name	Description
`request`	`DetachSubscriptionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<DetachSubscriptionResponse>`

getTopic(GetTopicRequest request)

public ListenableFuture<Topic> getTopic(GetTopicRequest request)

Gets the configuration of a topic.

Parameter
Name	Description
`request`	`GetTopicRequest`

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

listTopicSnapshots(ListTopicSnapshotsRequest request)

public ListenableFuture<ListTopicSnapshotsResponse> listTopicSnapshots(ListTopicSnapshotsRequest request)

Lists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Parameter
Name	Description
`request`	`ListTopicSnapshotsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListTopicSnapshotsResponse>`

listTopicSubscriptions(ListTopicSubscriptionsRequest request)

public ListenableFuture<ListTopicSubscriptionsResponse> listTopicSubscriptions(ListTopicSubscriptionsRequest request)

Lists the names of the attached subscriptions on this 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)

Lists matching topics.

Parameter
Name	Description
`request`	`ListTopicsRequest`

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

publish(PublishRequest request)

public ListenableFuture<PublishResponse> publish(PublishRequest request)

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Parameter
Name	Description
`request`	`PublishRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PublishResponse>`

updateTopic(UpdateTopicRequest request)

public ListenableFuture<Topic> updateTopic(UpdateTopicRequest request)

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

Parameter
Name	Description
`request`	`UpdateTopicRequest`

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