com.google.firestore.admin.v1

Class ListFieldsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

com.google.firestore.admin.v1.ListFieldsRequest.Builder

All Implemented Interfaces:

ListFieldsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListFieldsRequest

public static final class ListFieldsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>
implements ListFieldsRequestOrBuilder

 The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
 

Protobuf type google.firestore.admin.v1.ListFieldsRequest

Method Summary

Modifier and Type	Method and Description
ListFieldsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListFieldsRequest	build()
ListFieldsRequest	buildPartial()
ListFieldsRequest.Builder	clear()
ListFieldsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListFieldsRequest.Builder	clearFilter() The filter to apply to list results.
ListFieldsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListFieldsRequest.Builder	clearPageSize() The number of results to return.
ListFieldsRequest.Builder	clearPageToken() A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
ListFieldsRequest.Builder	clearParent() Required.
ListFieldsRequest.Builder	clone()
ListFieldsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() The filter to apply to list results.
com.google.protobuf.ByteString	getFilterBytes() The filter to apply to list results.
int	getPageSize() The number of results to return.
String	getPageToken() A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
com.google.protobuf.ByteString	getPageTokenBytes() A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListFieldsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListFieldsRequest.Builder	mergeFrom(ListFieldsRequest other)
ListFieldsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListFieldsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListFieldsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListFieldsRequest.Builder	setFilter(String value) The filter to apply to list results.
ListFieldsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) The filter to apply to list results.
ListFieldsRequest.Builder	setPageSize(int value) The number of results to return.
ListFieldsRequest.Builder	setPageToken(String value) A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
ListFieldsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
ListFieldsRequest.Builder	setParent(String value) Required.
ListFieldsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListFieldsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListFieldsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

clear

public ListFieldsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

getDefaultInstanceForType

public ListFieldsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListFieldsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListFieldsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ListFieldsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

setField

public ListFieldsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

clearField

public ListFieldsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

clearOneof

public ListFieldsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

setRepeatedField

public ListFieldsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

addRepeatedField

public ListFieldsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

mergeFrom

public ListFieldsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListFieldsRequest.Builder>

mergeFrom

public ListFieldsRequest.Builder mergeFrom(ListFieldsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

mergeFrom

public ListFieldsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListFieldsRequest.Builder>

Throws:

IOException

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

Specified by:

getParent in interface ListFieldsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface ListFieldsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListFieldsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

 The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
 that have been explicitly overridden. To issue this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
 `indexConfig.usesAncestorConfig:false`.
 

string filter = 2;

Specified by:

getFilter in interface ListFieldsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
 that have been explicitly overridden. To issue this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
 `indexConfig.usesAncestorConfig:false`.
 

string filter = 2;

Specified by:

getFilterBytes in interface ListFieldsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListFieldsRequest.Builder setFilter(String value)

 The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
 that have been explicitly overridden. To issue this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
 `indexConfig.usesAncestorConfig:false`.
 

string filter = 2;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListFieldsRequest.Builder clearFilter()

 The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
 that have been explicitly overridden. To issue this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
 `indexConfig.usesAncestorConfig:false`.
 

string filter = 2;

Returns:

This builder for chaining.

setFilterBytes

public ListFieldsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
 that have been explicitly overridden. To issue this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
 `indexConfig.usesAncestorConfig:false`.
 

string filter = 2;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getPageSize

public int getPageSize()

 The number of results to return.
 

int32 page_size = 3;

Specified by:

getPageSize in interface ListFieldsRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListFieldsRequest.Builder setPageSize(int value)

 The number of results to return.
 

int32 page_size = 3;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListFieldsRequest.Builder clearPageSize()

 The number of results to return.
 

int32 page_size = 3;

Returns:

This builder for chaining.

getPageToken

public String getPageToken()

 A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next
 page of results.
 

string page_token = 4;

Specified by:

getPageToken in interface ListFieldsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next
 page of results.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListFieldsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListFieldsRequest.Builder setPageToken(String value)

 A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next
 page of results.
 

string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListFieldsRequest.Builder clearPageToken()

 A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next
 page of results.
 

string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

public ListFieldsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next
 page of results.
 

string page_token = 4;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListFieldsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>

mergeUnknownFields

public final ListFieldsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListFieldsRequest.Builder>