Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates an Index.

post/v1/{+parent}/indexes

Path parameters

parentstring required

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}

Request body

indexUpdateMethod'INDEX_UPDATE_METHOD_UNSPECIFIED' | 'BATCH_UPDATE' | 'STREAM_UPDATE'

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

satisfiesPzsboolean

Output only. Reserved for future use.

displayNamestring

Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

satisfiesPziboolean

Output only. Reserved for future use.

namestring

Output only. The resource name of the Index.

descriptionstring

The description of the Index.

updateTimestring google-datetime

Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

labelsobject

The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

etagstring

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

{"stackTrail":"components:schemas:GoogleCloudAiplatformV1Index:properties:metadata","oasType":"schema","type":"unknown","description":"An additional information about the Index; the schema of the metadata can be found in metadata_schema."}
createTimestring google-datetime

Output only. Timestamp when this Index was created.

metadataSchemaUristring

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Response

Successful response