Class CreateIndexRequest (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public final class CreateIndexRequest extends GeneratedMessageV3 implements CreateIndexRequestOrBuilder

The request for FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.CreateIndexRequest

Static Fields

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateIndexRequest getDefaultInstance()
Returns
TypeDescription
CreateIndexRequest

getDescriptor()

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

newBuilder()

public static CreateIndexRequest.Builder newBuilder()
Returns
TypeDescription
CreateIndexRequest.Builder

newBuilder(CreateIndexRequest prototype)

public static CreateIndexRequest.Builder newBuilder(CreateIndexRequest prototype)
Parameter
NameDescription
prototypeCreateIndexRequest
Returns
TypeDescription
CreateIndexRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateIndexRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateIndexRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateIndexRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateIndexRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateIndexRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateIndexRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateIndexRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateIndexRequest> parser()
Returns
TypeDescription
Parser<CreateIndexRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateIndexRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateIndexRequest

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.

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.

getParserForType()

public Parser<CreateIndexRequest> getParserForType()
Returns
TypeDescription
Parser<CreateIndexRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateIndexRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateIndexRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateIndexRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateIndexRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateIndexRequest.Builder toBuilder()
Returns
TypeDescription
CreateIndexRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException