Interface CreateIndexRequestOrBuilder (0.1.0) 

public interface CreateIndexRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIndex()

public abstract Index 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 abstract 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 abstract 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 abstract IndexOrBuilder getIndexOrBuilder()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Index index = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IndexOrBuilder

getParent()

public abstract 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 abstract 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.

getRequestId()

public abstract 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 abstract 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.

hasIndex()

public abstract 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.