Class CreateIndexRequest.Builder (3.16.3)

public static final class CreateIndexRequest.Builder extends GeneratedMessageV3.Builder<CreateIndexRequest.Builder> implements CreateIndexRequestOrBuilder

The request for FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.CreateIndexRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreateIndexRequest build()
Returns
TypeDescription
CreateIndexRequest

buildPartial()

public CreateIndexRequest buildPartial()
Returns
TypeDescription
CreateIndexRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearIndex()

public CreateIndexRequest.Builder clearIndex()

Required. The composite index to create.

.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CreateIndexRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

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
TypeDescription
CreateIndexRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CreateIndexRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateIndexRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndex()

public Index getIndex()

Required. The composite index to create.

.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
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.

hasIndex()

public boolean hasIndex()

Required. The composite index to create.

.google.firestore.admin.v1.Index index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the index field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CreateIndexRequest other)

public CreateIndexRequest.Builder mergeFrom(CreateIndexRequest other)
Parameter
NameDescription
otherCreateIndexRequest
Returns
TypeDescription
CreateIndexRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

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
NameDescription
valueIndex
Returns
TypeDescription
CreateIndexRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueIndex
Returns
TypeDescription
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
NameDescription
builderForValueIndex.Builder
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
CreateIndexRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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