Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::IndexEndpoint (v0.52.0)

Version 0.52.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::IndexEndpoint.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this IndexEndpoint was created.

#deployed_indexes

def deployed_indexes() -> ::Array<::Google::Cloud::AIPlatform::V1::DeployedIndex>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::DeployedIndex>) — Output only. The indexes deployed in this endpoint.

#description

def description() -> ::String

Returns

• (::String) — The description of the IndexEndpoint.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — The description of the IndexEndpoint.

Returns

• (::String) — The description of the IndexEndpoint.

#display_name

def display_name() -> ::String

Returns

• (::String) — Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns

• (::String) — Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#enable_private_service_connect

def enable_private_service_connect() -> ::Boolean

Returns

• (::Boolean) — 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.

#enable_private_service_connect=

def enable_private_service_connect=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

• (::Google::Cloud::AIPlatform::V1::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.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::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.

Returns

• (::Google::Cloud::AIPlatform::V1::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.

#etag

def etag() -> ::String

Returns

• (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String

Parameter

• value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns

• (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String

Returns

• (::String) — Output only. The resource name of the IndexEndpoint.

#network

def network() -> ::String

Returns

• (::String) — 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.

#network=

def network=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#private_service_connect_config

def private_service_connect_config() -> ::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig

Returns

• (::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig) — Optional. Configuration for private service connect.

  network and private_service_connect_config are mutually exclusive.

#private_service_connect_config=

def private_service_connect_config=(value) -> ::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig) — Optional. Configuration for private service connect.

  network and private_service_connect_config are mutually exclusive.

Returns

• (::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig) — Optional. Configuration for private service connect.

  network and private_service_connect_config are mutually exclusive.

#public_endpoint_domain_name

def public_endpoint_domain_name() -> ::String

Returns

• (::String) — Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.

#public_endpoint_enabled

def public_endpoint_enabled() -> ::Boolean

Returns

• (::Boolean) — Optional. If true, the deployed index will be accessible through public endpoint.

#public_endpoint_enabled=

def public_endpoint_enabled=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. If true, the deployed index will be accessible through public endpoint.

Returns

• (::Boolean) — Optional. If true, the deployed index will be accessible through public endpoint.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::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.