Class IndexEndpoint (1.81.0) 

IndexEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Attributes
Name Description
name str
Output only. The resource name of the IndexEndpoint.
display_name str
Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description str
The description of the IndexEndpoint.
deployed_indexes MutableSequence[google.cloud.aiplatform_v1beta1.types.DeployedIndex]
Output only. The indexes deployed in this endpoint.
etag str
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels MutableMapping[str, str]
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.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this IndexEndpoint was created.
update_time google.protobuf.timestamp_pb2.Timestamp
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.
network str
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.
enable_private_service_connect bool
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.
private_service_connect_config google.cloud.aiplatform_v1beta1.types.PrivateServiceConnectConfig
Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
public_endpoint_enabled bool
Optional. If true, the deployed index will be accessible through public endpoint.
public_endpoint_domain_name str
Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
encryption_spec google.cloud.aiplatform_v1beta1.types.EncryptionSpec
Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
satisfies_pzs bool
Output only. Reserved for future use.
satisfies_pzi bool
Output only. Reserved for future use.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Methods

IndexEndpoint

IndexEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.