Class CreateIndexRequest (0.1.0)
public final class CreateIndexRequest extends GeneratedMessageV3 implements CreateIndexRequestOrBuilder
Message for creating an Index.
Protobuf type google.cloud.vectorsearch.v1beta.CreateIndexRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INDEX_ID_FIELD_NUMBER
public static final int INDEX_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CreateIndexRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateIndexRequest.Builder newBuilder()
newBuilder(CreateIndexRequest prototype)
public static CreateIndexRequest.Builder newBuilder(CreateIndexRequest prototype)
public static CreateIndexRequest parseDelimitedFrom(InputStream input)
public static CreateIndexRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateIndexRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateIndexRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(CodedInputStream input)
public static CreateIndexRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(InputStream input)
public static CreateIndexRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateIndexRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateIndexRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateIndexRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateIndexRequest getDefaultInstanceForType()
getIndex()
Required. The resource being created
.google.cloud.vectorsearch.v1beta.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Index |
The index.
|
getIndexId()
public String getIndexId()
Required. Id of the requesting object
If auto-generating Id server-side, remove this field and
index_id from the method_signature of Create RPC
string index_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The indexId.
|
getIndexIdBytes()
public ByteString getIndexIdBytes()
Required. Id of the requesting object
If auto-generating Id server-side, remove this field and
index_id from the method_signature of Create RPC
string index_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for indexId.
|
getIndexOrBuilder()
public IndexOrBuilder getIndexOrBuilder()
Required. The resource being created
.google.cloud.vectorsearch.v1beta.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
getParent()
public String getParent()
Required. The resource name of the Collection for which to create the
Index. Format:
projects/{project}/locations/{location}/collections/{collection}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the Collection for which to create the
Index. Format:
projects/{project}/locations/{location}/collections/{collection}
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()
Overrides
getRequestId()
public String getRequestId()
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
String |
The requestId.
|
getRequestIdBytes()
public ByteString getRequestIdBytes()
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for requestId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasIndex()
public boolean hasIndex()
Required. The resource being created
.google.cloud.vectorsearch.v1beta.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the index field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateIndexRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateIndexRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateIndexRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
