public static final class ListFieldsRequest.Builder extends GeneratedMessageV3.Builder<ListFieldsRequest.Builder> implements ListFieldsRequestOrBuilderThe request for FirestoreAdmin.ListFields.
Protobuf type google.firestore.admin.v1.ListFieldsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFieldsRequest.BuilderImplements
ListFieldsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListFieldsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListFieldsRequest.Builder |
build()
public ListFieldsRequest build()| Type | Description |
| ListFieldsRequest |
buildPartial()
public ListFieldsRequest buildPartial()| Type | Description |
| ListFieldsRequest |
clear()
public ListFieldsRequest.Builder clear()| Type | Description |
| ListFieldsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListFieldsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ListFieldsRequest.Builder |
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;
| Type | Description |
| ListFieldsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListFieldsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ListFieldsRequest.Builder |
clearPageSize()
public ListFieldsRequest.Builder clearPageSize()The number of results to return.
int32 page_size = 3;
| Type | Description |
| 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;
| Type | Description |
| 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) = { ... }
| Type | Description |
| ListFieldsRequest.Builder | This builder for chaining. |
clone()
public ListFieldsRequest.Builder clone()| Type | Description |
| ListFieldsRequest.Builder |
getDefaultInstanceForType()
public ListFieldsRequest getDefaultInstanceForType()| Type | Description |
| ListFieldsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for filter. |
getPageSize()
public int getPageSize()The number of results to return.
int32 page_size = 3;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(ListFieldsRequest other)
public ListFieldsRequest.Builder mergeFrom(ListFieldsRequest other)| Name | Description |
| other | ListFieldsRequest |
| Type | Description |
| ListFieldsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListFieldsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListFieldsRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ListFieldsRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ListFieldsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListFieldsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListFieldsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListFieldsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListFieldsRequest.Builder |
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;
| Name | Description |
| value | StringThe filter to set. |
| Type | Description |
| 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;
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| Type | Description |
| 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;
| Name | Description |
| value | intThe pageSize to set. |
| Type | Description |
| 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;
| Name | Description |
| value | StringThe pageToken to set. |
| Type | Description |
| 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;
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| Type | Description |
| 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) = { ... }
| Name | Description |
| value | StringThe parent to set. |
| Type | Description |
| 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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| Type | Description |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ListFieldsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListFieldsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListFieldsRequest.Builder |