Google Cloud Vector Search V1 Client - Class CreateIndexRequest (0.2.0)

Version latest

• 0.2.0 (latest)
• 0.1.0

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class CreateIndexRequest.

Message for creating an Index.

Generated from protobuf message google.cloud.vectorsearch.v1.CreateIndexRequest

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection}
↳ index_id	string Required. ID of the Index to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.
↳ index	Index Required. The resource being created
↳ request_id	string 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).

getParent

Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection}

Returns
Type	Description
string

setParent

Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getIndexId

Required. ID of the Index to create.

The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

Returns
Type	Description
string

setIndexId

Required. ID of the Index to create.

The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getIndex

Required. The resource being created

Returns
Type	Description
Index|null

hasIndex

clearIndex

setIndex

Required. The resource being created

Parameter
Name	Description
var	Index

Returns
Type	Description
$this

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).

Returns
Type	Description
string

setRequestId

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).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection} Please see VectorSearchServiceClient::collectionName() for help formatting this field.
index	Index Required. The resource being created
indexId	string Required. ID of the Index to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

Returns
Type	Description
CreateIndexRequest