public final class SeekRequest extends GeneratedMessageV3 implements SeekRequestOrBuilder
Request for the Seek
method.
Protobuf type google.pubsub.v1.SeekRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SeekRequestImplements
SeekRequestOrBuilderStatic Fields
SNAPSHOT_FIELD_NUMBER
public static final int SNAPSHOT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SUBSCRIPTION_FIELD_NUMBER
public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TIME_FIELD_NUMBER
public static final int TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static SeekRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
SeekRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SeekRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newBuilder(SeekRequest prototype)
public static SeekRequest.Builder newBuilder(SeekRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype | SeekRequest |
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
parseDelimitedFrom(InputStream input)
public static SeekRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SeekRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SeekRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SeekRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SeekRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SeekRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SeekRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<SeekRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public SeekRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SeekRequest |
getParserForType()
public Parser<SeekRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SeekRequest> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getSnapshot()
public String getSnapshot()
The snapshot to seek to. The snapshot's topic must be the same as that of
the provided subscription.
Format is projects/{project}/snapshots/{snap}
.
string snapshot = 3 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The snapshot. |
getSnapshotBytes()
public ByteString getSnapshotBytes()
The snapshot to seek to. The snapshot's topic must be the same as that of
the provided subscription.
Format is projects/{project}/snapshots/{snap}
.
string snapshot = 3 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for snapshot. |
getSubscription()
public String getSubscription()
Required. The subscription to affect.
string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The subscription. |
getSubscriptionBytes()
public ByteString getSubscriptionBytes()
Required. The subscription to affect.
string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for subscription. |
getTargetCase()
public SeekRequest.TargetCase getTargetCase()
Returns | |
---|---|
Type | Description |
SeekRequest.TargetCase |
getTime()
public Timestamp getTime()
The time to seek to.
Messages retained in the subscription that were published before this
time are marked as acknowledged, and messages retained in the
subscription that were published after this time are marked as
unacknowledged. Note that this operation affects only those messages
retained in the subscription (configured by the combination of
message_retention_duration
and retain_acked_messages
). For example,
if time
corresponds to a point before the message retention
window (or to a point before the system's notion of the subscription
creation time), only retained messages will be marked as unacknowledged,
and already-expunged messages will not be restored.
.google.protobuf.Timestamp time = 2;
Returns | |
---|---|
Type | Description |
Timestamp | The time. |
getTimeOrBuilder()
public TimestampOrBuilder getTimeOrBuilder()
The time to seek to.
Messages retained in the subscription that were published before this
time are marked as acknowledged, and messages retained in the
subscription that were published after this time are marked as
unacknowledged. Note that this operation affects only those messages
retained in the subscription (configured by the combination of
message_retention_duration
and retain_acked_messages
). For example,
if time
corresponds to a point before the message retention
window (or to a point before the system's notion of the subscription
creation time), only retained messages will be marked as unacknowledged,
and already-expunged messages will not be restored.
.google.protobuf.Timestamp time = 2;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
hasSnapshot()
public boolean hasSnapshot()
The snapshot to seek to. The snapshot's topic must be the same as that of
the provided subscription.
Format is projects/{project}/snapshots/{snap}
.
string snapshot = 3 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
boolean | Whether the snapshot field is set. |
hasTime()
public boolean hasTime()
The time to seek to.
Messages retained in the subscription that were published before this
time are marked as acknowledged, and messages retained in the
subscription that were published after this time are marked as
unacknowledged. Note that this operation affects only those messages
retained in the subscription (configured by the combination of
message_retention_duration
and retain_acked_messages
). For example,
if time
corresponds to a point before the message retention
window (or to a point before the system's notion of the subscription
creation time), only retained messages will be marked as unacknowledged,
and already-expunged messages will not be restored.
.google.protobuf.Timestamp time = 2;
Returns | |
---|---|
Type | Description |
boolean | Whether the time field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SeekRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SeekRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SeekRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |