public final class CreateIndexRequest extends GeneratedMessage implements CreateIndexRequestOrBuilderThe request for FirestoreAdmin.CreateIndex.
Protobuf type google.firestore.admin.v1.CreateIndexRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > CreateIndexRequestImplements
CreateIndexRequestOrBuilderStatic Fields
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static CreateIndexRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static CreateIndexRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
newBuilder(CreateIndexRequest prototype)
public static CreateIndexRequest.Builder newBuilder(CreateIndexRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
CreateIndexRequest |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static CreateIndexRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static CreateIndexRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static CreateIndexRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static CreateIndexRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static CreateIndexRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static CreateIndexRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<CreateIndexRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<CreateIndexRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public CreateIndexRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
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. |
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. |
getParserForType()
public Parser<CreateIndexRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<CreateIndexRequest> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public CreateIndexRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CreateIndexRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
toBuilder()
public CreateIndexRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|