Class IndexEndpoint (3.55.0)

public final class IndexEndpoint extends GeneratedMessageV3 implements IndexEndpointOrBuilder

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

Protobuf type google.cloud.aiplatform.v1beta1.IndexEndpoint

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYED_INDEXES_FIELD_NUMBER

public static final int DEPLOYED_INDEXES_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER

public static final int ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER

public static final int PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER

public static final int PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexEndpoint getDefaultInstance()
Returns
Type Description
IndexEndpoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static IndexEndpoint.Builder newBuilder()
Returns
Type Description
IndexEndpoint.Builder

newBuilder(IndexEndpoint prototype)

public static IndexEndpoint.Builder newBuilder(IndexEndpoint prototype)
Parameter
Name Description
prototype IndexEndpoint
Returns
Type Description
IndexEndpoint.Builder

parseDelimitedFrom(InputStream input)

public static IndexEndpoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IndexEndpoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexEndpoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexEndpoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IndexEndpoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IndexEndpoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IndexEndpoint> parser()
Returns
Type Description
Parser<IndexEndpoint>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public 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 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

getDefaultInstanceForType()

public IndexEndpoint getDefaultInstanceForType()
Returns
Type Description
IndexEndpoint

getDeployedIndexes(int index)

public DeployedIndex getDeployedIndexes(int index)

Output only. The indexes deployed in this endpoint.

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

Parameter
Name Description
index int
Returns
Type Description
DeployedIndex

getDeployedIndexesCount()

public int getDeployedIndexesCount()

Output only. The indexes deployed in this endpoint.

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

Returns
Type Description
int

getDeployedIndexesList()

public List<DeployedIndex> getDeployedIndexesList()

Output only. The indexes deployed in this endpoint.

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

Returns
Type Description
List<DeployedIndex>

getDeployedIndexesOrBuilder(int index)

public DeployedIndexOrBuilder getDeployedIndexesOrBuilder(int index)

Output only. The indexes deployed in this endpoint.

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

Parameter
Name Description
index int
Returns
Type Description
DeployedIndexOrBuilder

getDeployedIndexesOrBuilderList()

public List<? extends DeployedIndexOrBuilder> getDeployedIndexesOrBuilderList()

Output only. The indexes deployed in this endpoint.

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

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

getDescription()

public String getDescription()

The description of the IndexEndpoint.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the IndexEndpoint.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public 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 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 boolean getEnablePrivateServiceConnect()

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

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.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

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.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

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.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
EncryptionSpecOrBuilder

getEtag()

public 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 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() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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 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 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 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.

getParserForType()

public Parser<IndexEndpoint> getParserForType()
Returns
Type Description
Parser<IndexEndpoint>
Overrides

getPrivateServiceConnectConfig()

public PrivateServiceConnectConfig getPrivateServiceConnectConfig()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

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

Returns
Type Description
PrivateServiceConnectConfig

The privateServiceConnectConfig.

getPrivateServiceConnectConfigOrBuilder()

public PrivateServiceConnectConfigOrBuilder getPrivateServiceConnectConfigOrBuilder()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

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

Returns
Type Description
PrivateServiceConnectConfigOrBuilder

getPublicEndpointDomainName()

public 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 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 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.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public 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 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 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.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

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.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasPrivateServiceConnectConfig()

public boolean hasPrivateServiceConnectConfig()

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

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

Returns
Type Description
boolean

Whether the privateServiceConnectConfig field is set.

hasUpdateTime()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IndexEndpoint.Builder newBuilderForType()
Returns
Type Description
IndexEndpoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexEndpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IndexEndpoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IndexEndpoint.Builder toBuilder()
Returns
Type Description
IndexEndpoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException