v1

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

Creates an IndexEndpoint.

post/v1/{+parent}/indexEndpoints

Path parameters

parentstring required

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

Request body

createTimestring google-datetime

Output only. Timestamp when this IndexEndpoint was created.

labelsobject

The labels with user-defined metadata to organize your IndexEndpoints. 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.

updateTimestring google-datetime

Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.

etagstring

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

enablePrivateServiceConnectboolean

Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

networkstring

Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in '12345', and {network} is network name.

publicEndpointEnabledboolean

Optional. If true, the deployed index will be accessible through public endpoint.

displayNamestring

Required. The display name of the IndexEndpoint. 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 IndexEndpoint.

descriptionstring

The description of the IndexEndpoint.

publicEndpointDomainNamestring

Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.

satisfiesPzsboolean

Output only. Reserved for future use.

Response

Successful response