Class IndexEndpoint (3.24.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
TypeDescription
int

DEPLOYED_INDEXES_FIELD_NUMBER

public static final int DEPLOYED_INDEXES_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER

public static final int ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER

public static final int PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER

public static final int PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static IndexEndpoint getDefaultInstance()
Returns
TypeDescription
IndexEndpoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static IndexEndpoint.Builder newBuilder()
Returns
TypeDescription
IndexEndpoint.Builder

newBuilder(IndexEndpoint prototype)

public static IndexEndpoint.Builder newBuilder(IndexEndpoint prototype)
Parameter
NameDescription
prototypeIndexEndpoint
Returns
TypeDescription
IndexEndpoint.Builder

parseDelimitedFrom(InputStream input)

public static IndexEndpoint parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static IndexEndpoint parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexEndpoint parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexEndpoint parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static IndexEndpoint parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static IndexEndpoint parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<IndexEndpoint> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public IndexEndpoint getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.DeployedIndexOrBuilder>

getDescription()

public String getDescription()

The description of the IndexEndpoint.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the IndexEndpoint.

string description = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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=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
TypeDescription
boolean

The enablePrivateServiceConnect.

getEtag()

public String getEtag()

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

string etag = 5;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Output only. The resource name of the IndexEndpoint.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for network.

getParserForType()

public Parser<IndexEndpoint> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The publicEndpointEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the createTime 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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public IndexEndpoint.Builder newBuilderForType()
Returns
TypeDescription
IndexEndpoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexEndpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
IndexEndpoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public IndexEndpoint.Builder toBuilder()
Returns
TypeDescription
IndexEndpoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException