Class SubscriberGrpc.SubscriberFutureStub (1.135.0)

public static final class SubscriberGrpc.SubscriberFutureStub extends AbstractFutureStub<SubscriberGrpc.SubscriberFutureStub>

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

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method or by establishing a bi-directional stream using the StreamingPull method.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > SubscriberGrpc.SubscriberFutureStub

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(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

acknowledge(AcknowledgeRequest request)

public ListenableFuture<Empty> acknowledge(AcknowledgeRequest request)

Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Parameter
Name	Description
`request`	`AcknowledgeRequest`

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

build(Channel channel, CallOptions callOptions)

protected SubscriberGrpc.SubscriberFutureStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
`SubscriberGrpc.SubscriberFutureStub`

Overrides

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

createSnapshot(CreateSnapshotRequest request)

public ListenableFuture<Snapshot> createSnapshot(CreateSnapshotRequest request)

Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Parameter
Name	Description
`request`	`CreateSnapshotRequest`

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

createSubscription(Subscription request)

public ListenableFuture<Subscription> createSubscription(Subscription request)

Creates a subscription to a given topic. See the resource name rules. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Parameter
Name	Description
`request`	`Subscription`

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

deleteSnapshot(DeleteSnapshotRequest request)

public ListenableFuture<Empty> deleteSnapshot(DeleteSnapshotRequest request)

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Parameter
Name	Description
`request`	`DeleteSnapshotRequest`

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

deleteSubscription(DeleteSubscriptionRequest request)

public ListenableFuture<Empty> deleteSubscription(DeleteSubscriptionRequest request)

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Parameter
Name	Description
`request`	`DeleteSubscriptionRequest`

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

getSnapshot(GetSnapshotRequest request)

public ListenableFuture<Snapshot> getSnapshot(GetSnapshotRequest request)

Gets the configuration details of a snapshot. 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`	`GetSnapshotRequest`

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

getSubscription(GetSubscriptionRequest request)

public ListenableFuture<Subscription> getSubscription(GetSubscriptionRequest request)

Gets the configuration details of a subscription.

Parameter
Name	Description
`request`	`GetSubscriptionRequest`

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

listSnapshots(ListSnapshotsRequest request)

public ListenableFuture<ListSnapshotsResponse> listSnapshots(ListSnapshotsRequest request)

Lists the existing snapshots. 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`	`ListSnapshotsRequest`

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

listSubscriptions(ListSubscriptionsRequest request)

public ListenableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest request)

Lists matching subscriptions.

Parameter
Name	Description
`request`	`ListSubscriptionsRequest`

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

modifyAckDeadline(ModifyAckDeadlineRequest request)

public ListenableFuture<Empty> modifyAckDeadline(ModifyAckDeadlineRequest request)

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.

Parameter
Name	Description
`request`	`ModifyAckDeadlineRequest`

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

modifyPushConfig(ModifyPushConfigRequest request)

public ListenableFuture<Empty> modifyPushConfig(ModifyPushConfigRequest request)

Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

Parameter
Name	Description
`request`	`ModifyPushConfigRequest`

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

pull(PullRequest request)

public ListenableFuture<PullResponse> pull(PullRequest request)

Pulls messages from the server.

Parameter
Name	Description
`request`	`PullRequest`

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

seek(SeekRequest request)

public ListenableFuture<SeekResponse> seek(SeekRequest request)

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. 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. Note that both the subscription and the snapshot must be on the same topic.

Parameter
Name	Description
`request`	`SeekRequest`

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

updateSnapshot(UpdateSnapshotRequest request)

public ListenableFuture<Snapshot> updateSnapshot(UpdateSnapshotRequest request)

Updates an existing snapshot by updating the fields specified in the update mask. 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`	`UpdateSnapshotRequest`

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

updateSubscription(UpdateSubscriptionRequest request)

public ListenableFuture<Subscription> updateSubscription(UpdateSubscriptionRequest request)

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

Parameter
Name	Description
`request`	`UpdateSubscriptionRequest`

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