public static final class CreateIndexRequest.Builder extends GeneratedMessage.Builder<CreateIndexRequest.Builder> implements CreateIndexRequestOrBuilderThe request for FirestoreAdmin.CreateIndex.
Protobuf type google.firestore.admin.v1.CreateIndexRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CreateIndexRequest.BuilderImplements
CreateIndexRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public CreateIndexRequest build()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
buildPartial()
public CreateIndexRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
clear()
public CreateIndexRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
clearIndex()
public CreateIndexRequest.Builder clearIndex()Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
clearParent()
public CreateIndexRequest.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 |
CreateIndexRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public CreateIndexRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIndex()
public Index getIndex()Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Index |
The index. |
getIndexBuilder()
public Index.Builder getIndexBuilder()Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Index.Builder |
|
getIndexOrBuilder()
public IndexOrBuilder getIndexOrBuilder()Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
IndexOrBuilder |
|
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. |
hasIndex()
public boolean hasIndex()Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the index field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CreateIndexRequest other)
public CreateIndexRequest.Builder mergeFrom(CreateIndexRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CreateIndexRequest |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreateIndexRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
mergeIndex(Index value)
public CreateIndexRequest.Builder mergeIndex(Index value)Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setIndex(Index value)
public CreateIndexRequest.Builder setIndex(Index value)Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setIndex(Index.Builder builderForValue)
public CreateIndexRequest.Builder setIndex(Index.Builder builderForValue)Required. The composite index to create.
.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Index.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setParent(String value)
public CreateIndexRequest.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 |
CreateIndexRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateIndexRequest.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 |
CreateIndexRequest.Builder |
This builder for chaining. |