Class ListTopicSnapshotsRequest (1.132.0)

public final class ListTopicSnapshotsRequest extends GeneratedMessageV3 implements ListTopicSnapshotsRequestOrBuilder

Request for the ListTopicSnapshots method.

Protobuf type google.pubsub.v1.ListTopicSnapshotsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListTopicSnapshotsRequest getDefaultInstance()
Returns
Type Description
ListTopicSnapshotsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListTopicSnapshotsRequest.Builder newBuilder()
Returns
Type Description
ListTopicSnapshotsRequest.Builder

newBuilder(ListTopicSnapshotsRequest prototype)

public static ListTopicSnapshotsRequest.Builder newBuilder(ListTopicSnapshotsRequest prototype)
Parameter
Name Description
prototype ListTopicSnapshotsRequest
Returns
Type Description
ListTopicSnapshotsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListTopicSnapshotsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListTopicSnapshotsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListTopicSnapshotsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListTopicSnapshotsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListTopicSnapshotsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListTopicSnapshotsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListTopicSnapshotsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListTopicSnapshotsRequest> parser()
Returns
Type Description
Parser<ListTopicSnapshotsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListTopicSnapshotsRequest getDefaultInstanceForType()
Returns
Type Description
ListTopicSnapshotsRequest

getPageSize()

public int getPageSize()

Optional. Maximum number of snapshot names to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots call, and that the system should return the next page of data.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots call, and that the system should return the next page of data.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<ListTopicSnapshotsRequest> getParserForType()
Returns
Type Description
Parser<ListTopicSnapshotsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopic()

public String getTopic()

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

string topic = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The topic.

getTopicBytes()

public ByteString getTopicBytes()

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

string topic = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for topic.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListTopicSnapshotsRequest.Builder newBuilderForType()
Returns
Type Description
ListTopicSnapshotsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListTopicSnapshotsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListTopicSnapshotsRequest.Builder toBuilder()
Returns
Type Description
ListTopicSnapshotsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException