Send feedback
Class ListTopicSnapshotsRequest.Builder (1.143.0)
Version latestkeyboard_arrow_down
public static final class ListTopicSnapshotsRequest . Builder extends GeneratedMessageV3 . Builder<ListTopicSnapshotsRequest . Builder > implements ListTopicSnapshotsRequestOrBuilder
Request for the ListTopicSnapshots method.
Protobuf type google.pubsub.v1.ListTopicSnapshotsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListTopicSnapshotsRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public ListTopicSnapshotsRequest build ()
buildPartial()
public ListTopicSnapshotsRequest buildPartial ()
clear()
public ListTopicSnapshotsRequest . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public ListTopicSnapshotsRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ListTopicSnapshotsRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearPageSize()
public ListTopicSnapshotsRequest . Builder clearPageSize ()
Optional. Maximum number of snapshot names to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
clearPageToken()
public ListTopicSnapshotsRequest . Builder clearPageToken ()
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];
clearTopic()
public ListTopicSnapshotsRequest . Builder clearTopic ()
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) = { ... }
clone()
public ListTopicSnapshotsRequest . Builder clone ()
Overrides
getDefaultInstanceForType()
public ListTopicSnapshotsRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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.
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.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
public ListTopicSnapshotsRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public ListTopicSnapshotsRequest . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeFrom(ListTopicSnapshotsRequest other)
public ListTopicSnapshotsRequest . Builder mergeFrom ( ListTopicSnapshotsRequest other )
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListTopicSnapshotsRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ListTopicSnapshotsRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setPageSize(int value)
public ListTopicSnapshotsRequest . Builder setPageSize ( int value )
Optional. Maximum number of snapshot names to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
valueint The pageSize to set.
setPageToken(String value)
public ListTopicSnapshotsRequest . Builder setPageToken ( String value )
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];
Parameter
Name Description
valueString The pageToken to set.
setPageTokenBytes(ByteString value)
public ListTopicSnapshotsRequest . Builder setPageTokenBytes ( ByteString value )
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];
Parameter
Name Description
valueByteString The bytes for pageToken to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListTopicSnapshotsRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setTopic(String value)
public ListTopicSnapshotsRequest . Builder setTopic ( String value )
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) = { ... }
Parameter
Name Description
valueString The topic to set.
setTopicBytes(ByteString value)
public ListTopicSnapshotsRequest . Builder setTopicBytes ( ByteString value )
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) = { ... }
Parameter
Name Description
valueByteString The bytes for topic to set.
setUnknownFields(UnknownFieldSet unknownFields)
public final ListTopicSnapshotsRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
