Class ListTopicSnapshotsRequest.Builder (1.131.0)

public static final class ListTopicSnapshotsRequest.Builder extends GeneratedMessageV3.Builder<ListTopicSnapshotsRequest.Builder> implements ListTopicSnapshotsRequestOrBuilder

Request for the ListTopicSnapshots method.

Protobuf type google.pubsub.v1.ListTopicSnapshotsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTopicSnapshotsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

build()

public ListTopicSnapshotsRequest build()
Returns
Type Description
ListTopicSnapshotsRequest

buildPartial()

public ListTopicSnapshotsRequest buildPartial()
Returns
Type Description
ListTopicSnapshotsRequest

clear()

public ListTopicSnapshotsRequest.Builder clear()
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTopicSnapshotsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTopicSnapshotsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

clearPageSize()

public ListTopicSnapshotsRequest.Builder clearPageSize()

Optional. Maximum number of snapshot names to return.

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

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

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];

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

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) = { ... }

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

clone()

public ListTopicSnapshotsRequest.Builder clone()
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTopicSnapshotsRequest getDefaultInstanceForType()
Returns
Type Description
ListTopicSnapshotsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTopicSnapshotsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListTopicSnapshotsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

mergeFrom(ListTopicSnapshotsRequest other)

public ListTopicSnapshotsRequest.Builder mergeFrom(ListTopicSnapshotsRequest other)
Parameter
Name Description
other ListTopicSnapshotsRequest
Returns
Type Description
ListTopicSnapshotsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTopicSnapshotsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTopicSnapshotsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListTopicSnapshotsRequest.Builder
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
value int

The pageSize to set.

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

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
value String

The pageToken to set.

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

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
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListTopicSnapshotsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListTopicSnapshotsRequest.Builder
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
value String

The topic to set.

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

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
value ByteString

The bytes for topic to set.

Returns
Type Description
ListTopicSnapshotsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTopicSnapshotsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListTopicSnapshotsRequest.Builder
Overrides