public static final class ListIndexesRequest.Builder extends GeneratedMessageV3.Builder<ListIndexesRequest.Builder> implements ListIndexesRequestOrBuilderThe request for FirestoreAdmin.ListIndexes.
 Protobuf type google.firestore.admin.v1.ListIndexesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListIndexesRequest.BuilderImplements
ListIndexesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListIndexesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
build()
public ListIndexesRequest build()| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest | 
        |
buildPartial()
public ListIndexesRequest buildPartial()| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest | 
        |
clear()
public ListIndexesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public ListIndexesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
clearFilter()
public ListIndexesRequest.Builder clearFilter()The filter to apply to list results.
 string filter = 2;
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        This builder for chaining.  | 
      
clearOneof(Descriptors.OneofDescriptor oneof)
public ListIndexesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
clearPageSize()
public ListIndexesRequest.Builder clearPageSize()The number of results to return.
 int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        This builder for chaining.  | 
      
clone()
public ListIndexesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
getDefaultInstanceForType()
public ListIndexesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getFilter()
public String getFilter()The filter to apply to list results.
 string filter = 2;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The filter.  | 
      
getFilterBytes()
public ByteString getFilterBytes()The filter to apply to list results.
 string filter = 2;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for filter.  | 
      
getPageSize()
public int getPageSize()The number of results to return.
 int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| 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) = { ... }
 
| Returns | |
|---|---|
| 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) = { ... }
 
| 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(ListIndexesRequest other)
public ListIndexesRequest.Builder mergeFrom(ListIndexesRequest other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        ListIndexesRequest | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListIndexesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public ListIndexesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListIndexesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public ListIndexesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
setFilter(String value)
public ListIndexesRequest.Builder setFilter(String value)The filter to apply to list results.
 string filter = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe filter to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for filter to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        intThe pageSize to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        StringThe pageToken to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for pageToken to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        StringThe parent to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for parent to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListIndexesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ListIndexesRequest.Builder | 
        |