- 3.48.0 (latest)
- 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 static final class IndexEndpoint.Builder extends GeneratedMessageV3.Builder<IndexEndpoint.Builder> implements IndexEndpointOrBuilder
Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.
Protobuf type google.cloud.aiplatform.v1beta1.IndexEndpoint
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > IndexEndpoint.BuilderImplements
IndexEndpointOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllDeployedIndexes(Iterable<? extends DeployedIndex> values)
public IndexEndpoint.Builder addAllDeployedIndexes(Iterable<? extends DeployedIndex> values)
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 |
values | Iterable<? extends com.google.cloud.aiplatform.v1beta1.DeployedIndex> |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
addDeployedIndexes(DeployedIndex value)
public IndexEndpoint.Builder addDeployedIndexes(DeployedIndex value)
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 |
value | DeployedIndex |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
addDeployedIndexes(DeployedIndex.Builder builderForValue)
public IndexEndpoint.Builder addDeployedIndexes(DeployedIndex.Builder builderForValue)
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 |
builderForValue | DeployedIndex.Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
addDeployedIndexes(int index, DeployedIndex value)
public IndexEndpoint.Builder addDeployedIndexes(int index, DeployedIndex value)
Output only. The indexes deployed in this endpoint.
repeated .google.cloud.aiplatform.v1beta1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index | int |
value | DeployedIndex |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
addDeployedIndexes(int index, DeployedIndex.Builder builderForValue)
public IndexEndpoint.Builder addDeployedIndexes(int index, DeployedIndex.Builder builderForValue)
Output only. The indexes deployed in this endpoint.
repeated .google.cloud.aiplatform.v1beta1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | DeployedIndex.Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
addDeployedIndexesBuilder()
public DeployedIndex.Builder addDeployedIndexesBuilder()
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 |
DeployedIndex.Builder |
addDeployedIndexesBuilder(int index)
public DeployedIndex.Builder addDeployedIndexesBuilder(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.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public IndexEndpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
build()
public IndexEndpoint build()
Returns | |
---|---|
Type | Description |
IndexEndpoint |
buildPartial()
public IndexEndpoint buildPartial()
Returns | |
---|---|
Type | Description |
IndexEndpoint |
clear()
public IndexEndpoint.Builder clear()
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
clearCreateTime()
public IndexEndpoint.Builder clearCreateTime()
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
clearDeployedIndexes()
public IndexEndpoint.Builder clearDeployedIndexes()
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 |
IndexEndpoint.Builder |
clearDescription()
public IndexEndpoint.Builder clearDescription()
The description of the IndexEndpoint.
string description = 3;
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
clearDisplayName()
public IndexEndpoint.Builder clearDisplayName()
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 |
IndexEndpoint.Builder | This builder for chaining. |
clearEnablePrivateServiceConnect() (deprecated)
public IndexEndpoint.Builder clearEnablePrivateServiceConnect()
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 |
IndexEndpoint.Builder | This builder for chaining. |
clearEncryptionSpec()
public IndexEndpoint.Builder clearEncryptionSpec()
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 |
IndexEndpoint.Builder |
clearEtag()
public IndexEndpoint.Builder clearEtag()
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 5;
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public IndexEndpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
clearLabels()
public IndexEndpoint.Builder clearLabels()
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
clearName()
public IndexEndpoint.Builder clearName()
Output only. The resource name of the IndexEndpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
clearNetwork()
public IndexEndpoint.Builder clearNetwork()
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 |
IndexEndpoint.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public IndexEndpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
clearPrivateServiceConnectConfig()
public IndexEndpoint.Builder clearPrivateServiceConnectConfig()
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 |
IndexEndpoint.Builder |
clearPublicEndpointDomainName()
public IndexEndpoint.Builder clearPublicEndpointDomainName()
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 |
IndexEndpoint.Builder | This builder for chaining. |
clearPublicEndpointEnabled()
public IndexEndpoint.Builder clearPublicEndpointEnabled()
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 |
IndexEndpoint.Builder | This builder for chaining. |
clearUpdateTime()
public IndexEndpoint.Builder clearUpdateTime()
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 |
IndexEndpoint.Builder |
clone()
public IndexEndpoint.Builder clone()
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
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 |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
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 |
getDeployedIndexesBuilder(int index)
public DeployedIndex.Builder getDeployedIndexesBuilder(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.Builder |
getDeployedIndexesBuilderList()
public List<DeployedIndex.Builder> getDeployedIndexesBuilderList()
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<Builder> |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getEncryptionSpecBuilder()
public EncryptionSpec.Builder getEncryptionSpecBuilder()
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.Builder |
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 |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,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. |
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. |
getPrivateServiceConnectConfigBuilder()
public PrivateServiceConnectConfig.Builder getPrivateServiceConnectConfigBuilder()
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.Builder |
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. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
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 |
Builder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public IndexEndpoint.Builder mergeCreateTime(Timestamp value)
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergeEncryptionSpec(EncryptionSpec value)
public IndexEndpoint.Builder mergeEncryptionSpec(EncryptionSpec value)
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];
Parameter | |
---|---|
Name | Description |
value | EncryptionSpec |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergeFrom(IndexEndpoint other)
public IndexEndpoint.Builder mergeFrom(IndexEndpoint other)
Parameter | |
---|---|
Name | Description |
other | IndexEndpoint |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public IndexEndpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public IndexEndpoint.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergePrivateServiceConnectConfig(PrivateServiceConnectConfig value)
public IndexEndpoint.Builder mergePrivateServiceConnectConfig(PrivateServiceConnectConfig value)
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];
Parameter | |
---|---|
Name | Description |
value | PrivateServiceConnectConfig |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final IndexEndpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
mergeUpdateTime(Timestamp value)
public IndexEndpoint.Builder mergeUpdateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
putAllLabels(Map<String,String> values)
public IndexEndpoint.Builder putAllLabels(Map<String,String> values)
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 |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
putLabels(String key, String value)
public IndexEndpoint.Builder putLabels(String key, String value)
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 |
value | String |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
removeDeployedIndexes(int index)
public IndexEndpoint.Builder removeDeployedIndexes(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 |
IndexEndpoint.Builder |
removeLabels(String key)
public IndexEndpoint.Builder removeLabels(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 |
IndexEndpoint.Builder |
setCreateTime(Timestamp value)
public IndexEndpoint.Builder setCreateTime(Timestamp value)
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public IndexEndpoint.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. Timestamp when this IndexEndpoint was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setDeployedIndexes(int index, DeployedIndex value)
public IndexEndpoint.Builder setDeployedIndexes(int index, DeployedIndex value)
Output only. The indexes deployed in this endpoint.
repeated .google.cloud.aiplatform.v1beta1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index | int |
value | DeployedIndex |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setDeployedIndexes(int index, DeployedIndex.Builder builderForValue)
public IndexEndpoint.Builder setDeployedIndexes(int index, DeployedIndex.Builder builderForValue)
Output only. The indexes deployed in this endpoint.
repeated .google.cloud.aiplatform.v1beta1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | DeployedIndex.Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setDescription(String value)
public IndexEndpoint.Builder setDescription(String value)
The description of the IndexEndpoint.
string description = 3;
Parameter | |
---|---|
Name | Description |
value | String The description to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public IndexEndpoint.Builder setDescriptionBytes(ByteString value)
The description of the IndexEndpoint.
string description = 3;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setDisplayName(String value)
public IndexEndpoint.Builder setDisplayName(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The displayName to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public IndexEndpoint.Builder setDisplayNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setEnablePrivateServiceConnect(boolean value) (deprecated)
public IndexEndpoint.Builder setEnablePrivateServiceConnect(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value | boolean The enablePrivateServiceConnect to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setEncryptionSpec(EncryptionSpec value)
public IndexEndpoint.Builder setEncryptionSpec(EncryptionSpec value)
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];
Parameter | |
---|---|
Name | Description |
value | EncryptionSpec |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setEncryptionSpec(EncryptionSpec.Builder builderForValue)
public IndexEndpoint.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | EncryptionSpec.Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setEtag(String value)
public IndexEndpoint.Builder setEtag(String value)
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 5;
Parameter | |
---|---|
Name | Description |
value | String The etag to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public IndexEndpoint.Builder setEtagBytes(ByteString value)
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 5;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public IndexEndpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setName(String value)
public IndexEndpoint.Builder setName(String value)
Output only. The resource name of the IndexEndpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public IndexEndpoint.Builder setNameBytes(ByteString value)
Output only. The resource name of the IndexEndpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setNetwork(String value)
public IndexEndpoint.Builder setNetwork(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The network to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setNetworkBytes(ByteString value)
public IndexEndpoint.Builder setNetworkBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for network to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setPrivateServiceConnectConfig(PrivateServiceConnectConfig value)
public IndexEndpoint.Builder setPrivateServiceConnectConfig(PrivateServiceConnectConfig value)
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];
Parameter | |
---|---|
Name | Description |
value | PrivateServiceConnectConfig |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setPrivateServiceConnectConfig(PrivateServiceConnectConfig.Builder builderForValue)
public IndexEndpoint.Builder setPrivateServiceConnectConfig(PrivateServiceConnectConfig.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | PrivateServiceConnectConfig.Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setPublicEndpointDomainName(String value)
public IndexEndpoint.Builder setPublicEndpointDomainName(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The publicEndpointDomainName to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setPublicEndpointDomainNameBytes(ByteString value)
public IndexEndpoint.Builder setPublicEndpointDomainNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for publicEndpointDomainName to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setPublicEndpointEnabled(boolean value)
public IndexEndpoint.Builder setPublicEndpointEnabled(boolean value)
Optional. If true, the deployed index will be accessible through public endpoint.
bool public_endpoint_enabled = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | boolean The publicEndpointEnabled to set. |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public IndexEndpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final IndexEndpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setUpdateTime(Timestamp value)
public IndexEndpoint.Builder setUpdateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public IndexEndpoint.Builder setUpdateTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
IndexEndpoint.Builder |