Class ListFieldsRequest.Builder (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public static final class ListFieldsRequest.Builder extends GeneratedMessageV3.Builder<ListFieldsRequest.Builder> implements ListFieldsRequestOrBuilder

The request for FirestoreAdmin.ListFields.

Protobuf type google.firestore.admin.v1.ListFieldsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListFieldsRequest build()
Returns
TypeDescription
ListFieldsRequest

buildPartial()

public ListFieldsRequest buildPartial()
Returns
TypeDescription
ListFieldsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListFieldsRequest.Builder clearFilter()

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

string filter = 2;

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListFieldsRequest.Builder clearPageSize()

The number of results to return.

int32 page_size = 3;

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

clearPageToken()

public ListFieldsRequest.Builder clearPageToken()

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

string page_token = 4;

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

clearParent()

public ListFieldsRequest.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
ListFieldsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListFieldsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListFieldsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

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.ListFields, 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.ListFields, 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(ListFieldsRequest other)

public ListFieldsRequest.Builder mergeFrom(ListFieldsRequest other)
Parameter
NameDescription
otherListFieldsRequest
Returns
TypeDescription
ListFieldsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListFieldsRequest.Builder setFilter(String value)

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFieldsRequest.Builder setFilterBytes(ByteString value)

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFieldsRequest.Builder setPageSize(int value)

The number of results to return.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFieldsRequest.Builder setPageToken(String value)

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

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListFieldsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFieldsRequest.Builder setPageTokenBytes(ByteString value)

A page token, returned from a previous call to FirestoreAdmin.ListFields, 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
ListFieldsRequest.Builder

This builder for chaining.

setParent(String value)

public ListFieldsRequest.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
ListFieldsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFieldsRequest.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
ListFieldsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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