Interface IndexEndpointOrBuilder (3.18.0)

Version 3.18.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface IndexEndpointOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when this IndexEndpoint was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this IndexEndpoint was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDeployedIndexes(int index)

public abstract DeployedIndex getDeployedIndexes(int index)

Output only. The indexes deployed in this endpoint.

repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DeployedIndex

getDeployedIndexesCount()

public abstract int getDeployedIndexesCount()

Output only. The indexes deployed in this endpoint.

repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getDeployedIndexesList()

public abstract List<DeployedIndex> getDeployedIndexesList()

Output only. The indexes deployed in this endpoint.

repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<DeployedIndex>

getDeployedIndexesOrBuilder(int index)

public abstract DeployedIndexOrBuilder getDeployedIndexesOrBuilder(int index)

Output only. The indexes deployed in this endpoint.

repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DeployedIndexOrBuilder

getDeployedIndexesOrBuilderList()

public abstract List<? extends DeployedIndexOrBuilder> getDeployedIndexesOrBuilderList()

Output only. The indexes deployed in this endpoint.

repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.DeployedIndexOrBuilder>

getDescription()

public abstract String getDescription()

The description of the IndexEndpoint.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The description of the IndexEndpoint.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEnablePrivateServiceConnect() (deprecated)

public abstract boolean getEnablePrivateServiceConnect()

Deprecated. google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/index_endpoint.proto;l=103

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.

bool enable_private_service_connect = 10 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enablePrivateServiceConnect.

getEtag()

public abstract String getEtag()

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

string etag = 5;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 5;

Returns
Type	Description
ByteString	The bytes for etag.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 6;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 6;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 6;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Output only. The resource name of the IndexEndpoint.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the IndexEndpoint.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

public abstract String getNetwork()

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.

string network = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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.

string network = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for network.

getPrivateServiceConnectConfig()

public abstract PrivateServiceConnectConfig getPrivateServiceConnectConfig()

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

.google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateServiceConnectConfig	The privateServiceConnectConfig.

getPrivateServiceConnectConfigOrBuilder()

public abstract PrivateServiceConnectConfigOrBuilder getPrivateServiceConnectConfigOrBuilder()

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

.google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateServiceConnectConfigOrBuilder

getPublicEndpointDomainName()

public abstract String getPublicEndpointDomainName()

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

string public_endpoint_domain_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The publicEndpointDomainName.

getPublicEndpointDomainNameBytes()

public abstract ByteString getPublicEndpointDomainNameBytes()

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

string public_endpoint_domain_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for publicEndpointDomainName.

getPublicEndpointEnabled()

public abstract boolean getPublicEndpointEnabled()

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

bool public_endpoint_enabled = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The publicEndpointEnabled.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when this IndexEndpoint was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasPrivateServiceConnectConfig()

public abstract boolean hasPrivateServiceConnectConfig()

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

.google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the privateServiceConnectConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.