Class ListIndexesRequest.Builder (3.3.0)

public static final class ListIndexesRequest.Builder extends GeneratedMessageV3.Builder<ListIndexesRequest.Builder> implements ListIndexesRequestOrBuilder

The request for FirestoreAdmin.ListIndexes.

Protobuf type google.firestore.admin.v1.ListIndexesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListIndexesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

build()

public ListIndexesRequest build()
Returns
TypeDescription
ListIndexesRequest

buildPartial()

public ListIndexesRequest buildPartial()
Returns
TypeDescription
ListIndexesRequest

clear()

public ListIndexesRequest.Builder clear()
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListIndexesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

clearFilter()

public ListIndexesRequest.Builder clearFilter()

The filter to apply to list results.

string filter = 2;

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListIndexesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

clearPageSize()

public ListIndexesRequest.Builder clearPageSize()

The number of results to return.

int32 page_size = 3;

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

clearPageToken()

public ListIndexesRequest.Builder clearPageToken()

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

string page_token = 4;

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

clearParent()

public ListIndexesRequest.Builder clearParent()

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

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

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

clone()

public ListIndexesRequest.Builder clone()
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListIndexesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListIndexesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

The filter to apply to list results.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter to apply to list results.

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The number of results to return.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListIndexesRequest other)

public ListIndexesRequest.Builder mergeFrom(ListIndexesRequest other)
Parameter
NameDescription
otherListIndexesRequest
Returns
TypeDescription
ListIndexesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListIndexesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListIndexesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListIndexesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListIndexesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

setFilter(String value)

public ListIndexesRequest.Builder setFilter(String value)

The filter to apply to list results.

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListIndexesRequest.Builder setFilterBytes(ByteString value)

The filter to apply to list results.

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListIndexesRequest.Builder setPageSize(int value)

The number of results to return.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListIndexesRequest.Builder setPageToken(String value)

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListIndexesRequest.Builder setPageTokenBytes(ByteString value)

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setParent(String value)

public ListIndexesRequest.Builder setParent(String value)

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListIndexesRequest.Builder setParentBytes(ByteString value)

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListIndexesRequest.Builder

This builder for chaining.

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

public ListIndexesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListIndexesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListIndexesRequest.Builder
Overrides