public final class IndexEndpoint extends GeneratedMessageV3 implements IndexEndpointOrBuilder
Indexes are deployed into it. An IndexEndpoint can have multiple
DeployedIndexes.
Protobuf type google.cloud.aiplatform.v1.IndexEndpoint
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DEPLOYED_INDEXES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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 static final int PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static IndexEndpoint getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static IndexEndpoint.Builder newBuilder()
public static IndexEndpoint.Builder newBuilder(IndexEndpoint prototype)
public static IndexEndpoint parseDelimitedFrom(InputStream input)
public static IndexEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexEndpoint parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static IndexEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static IndexEndpoint parseFrom(ByteString data)
public static IndexEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IndexEndpoint parseFrom(CodedInputStream input)
public static IndexEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexEndpoint parseFrom(InputStream input)
public static IndexEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexEndpoint parseFrom(ByteBuffer data)
public static IndexEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<IndexEndpoint> parser()
Methods
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
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public IndexEndpoint getDefaultInstanceForType()
public 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
|
public 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 | |
public 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];
public 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
|
public 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> | |
public String getDescription()
The description of the IndexEndpoint.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
The description of the IndexEndpoint.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
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.
|
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.
|
public 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.
|
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.
|
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.
|
public Map<String,String> getLabels()
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 | |
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;
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;
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
|
Output only. The resource name of the IndexEndpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
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.
|
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.
|
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.
|
public Parser<IndexEndpoint> getParserForType()
Overrides
public 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];
public 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];
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.
|
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.
|
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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];
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.
|
public 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.
|
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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public IndexEndpoint.Builder newBuilderForType()
protected IndexEndpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public IndexEndpoint.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
