public static final class ListPartitionCursorsRequest.Builder extends GeneratedMessageV3.Builder<ListPartitionCursorsRequest.Builder> implements ListPartitionCursorsRequestOrBuilder
Request for ListPartitionCursors.
Protobuf type google.cloud.pubsublite.v1.ListPartitionCursorsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPartitionCursorsRequest.BuilderImplements
ListPartitionCursorsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListPartitionCursorsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
build()
public ListPartitionCursorsRequest build()
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest |
buildPartial()
public ListPartitionCursorsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest |
clear()
public ListPartitionCursorsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListPartitionCursorsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListPartitionCursorsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
clearPageSize()
public ListPartitionCursorsRequest.Builder clearPageSize()
The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListPartitionCursorsRequest.Builder clearPageToken()
A page token, received from a previous ListPartitionCursors
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPartitionCursors
must match the call that provided the page token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
clearParent()
public ListPartitionCursorsRequest.Builder clearParent()
Required. The subscription for which to retrieve cursors.
Structured like
projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
clone()
public ListPartitionCursorsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
getDefaultInstanceForType()
public ListPartitionCursorsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getPageSize()
public int getPageSize()
The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
A page token, received from a previous ListPartitionCursors
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPartitionCursors
must match the call that provided the page token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous ListPartitionCursors
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPartitionCursors
must match the call that provided the page token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()
Required. The subscription for which to retrieve cursors.
Structured like
projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The subscription for which to retrieve cursors.
Structured like
projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListPartitionCursorsRequest other)
public ListPartitionCursorsRequest.Builder mergeFrom(ListPartitionCursorsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListPartitionCursorsRequest |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListPartitionCursorsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListPartitionCursorsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListPartitionCursorsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListPartitionCursorsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
setPageSize(int value)
public ListPartitionCursorsRequest.Builder setPageSize(int value)
The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
int32 page_size = 2;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListPartitionCursorsRequest.Builder setPageToken(String value)
A page token, received from a previous ListPartitionCursors
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPartitionCursors
must match the call that provided the page token.
string page_token = 3;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListPartitionCursorsRequest.Builder setPageTokenBytes(ByteString value)
A page token, received from a previous ListPartitionCursors
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPartitionCursors
must match the call that provided the page token.
string page_token = 3;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListPartitionCursorsRequest.Builder setParent(String value)
Required. The subscription for which to retrieve cursors.
Structured like
projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListPartitionCursorsRequest.Builder setParentBytes(ByteString value)
Required. The subscription for which to retrieve cursors.
Structured like
projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListPartitionCursorsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListPartitionCursorsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPartitionCursorsRequest.Builder |