Class Endpoint.Builder (3.7.0)

public static final class Endpoint.Builder extends GeneratedMessageV3.Builder<Endpoint.Builder> implements EndpointOrBuilder

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

Protobuf type google.cloud.aiplatform.v1.Endpoint

Implements

EndpointOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllDeployedModels(Iterable<? extends DeployedModel> values)

public Endpoint.Builder addAllDeployedModels(Iterable<? extends DeployedModel> values)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.DeployedModel>
Returns
TypeDescription
Endpoint.Builder

addDeployedModels(DeployedModel value)

public Endpoint.Builder addDeployedModels(DeployedModel value)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
valueDeployedModel
Returns
TypeDescription
Endpoint.Builder

addDeployedModels(DeployedModel.Builder builderForValue)

public Endpoint.Builder addDeployedModels(DeployedModel.Builder builderForValue)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
builderForValueDeployedModel.Builder
Returns
TypeDescription
Endpoint.Builder

addDeployedModels(int index, DeployedModel value)

public Endpoint.Builder addDeployedModels(int index, DeployedModel value)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameters
NameDescription
indexint
valueDeployedModel
Returns
TypeDescription
Endpoint.Builder

addDeployedModels(int index, DeployedModel.Builder builderForValue)

public Endpoint.Builder addDeployedModels(int index, DeployedModel.Builder builderForValue)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameters
NameDescription
indexint
builderForValueDeployedModel.Builder
Returns
TypeDescription
Endpoint.Builder

addDeployedModelsBuilder()

public DeployedModel.Builder addDeployedModelsBuilder()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
DeployedModel.Builder

addDeployedModelsBuilder(int index)

public DeployedModel.Builder addDeployedModelsBuilder(int index)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedModel.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Endpoint.Builder
Overrides

build()

public Endpoint build()
Returns
TypeDescription
Endpoint

buildPartial()

public Endpoint buildPartial()
Returns
TypeDescription
Endpoint

clear()

public Endpoint.Builder clear()
Returns
TypeDescription
Endpoint.Builder
Overrides

clearCreateTime()

public Endpoint.Builder clearCreateTime()

Output only. Timestamp when this Endpoint was created.

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

Returns
TypeDescription
Endpoint.Builder

clearDeployedModels()

public Endpoint.Builder clearDeployedModels()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
Endpoint.Builder

clearDescription()

public Endpoint.Builder clearDescription()

The description of the Endpoint.

string description = 3;

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearDisplayName()

public Endpoint.Builder clearDisplayName()

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

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

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearEnablePrivateServiceConnect() (deprecated)

public Endpoint.Builder clearEnablePrivateServiceConnect()

Deprecated. google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/endpoint.proto;l=116

Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

bool enable_private_service_connect = 17 [deprecated = true];

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearEncryptionSpec()

public Endpoint.Builder clearEncryptionSpec()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Returns
TypeDescription
Endpoint.Builder

clearEtag()

public Endpoint.Builder clearEtag()

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

string etag = 6;

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Endpoint.Builder
Overrides

clearLabels()

public Endpoint.Builder clearLabels()
Returns
TypeDescription
Endpoint.Builder

clearModelDeploymentMonitoringJob()

public Endpoint.Builder clearModelDeploymentMonitoringJob()

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearName()

public Endpoint.Builder clearName()

Output only. The resource name of the Endpoint.

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

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearNetwork()

public Endpoint.Builder clearNetwork()

The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Endpoint.Builder
Overrides

clearPredictRequestResponseLoggingConfig()

public Endpoint.Builder clearPredictRequestResponseLoggingConfig()

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Returns
TypeDescription
Endpoint.Builder

clearTrafficSplit()

public Endpoint.Builder clearTrafficSplit()
Returns
TypeDescription
Endpoint.Builder

clearUpdateTime()

public Endpoint.Builder clearUpdateTime()

Output only. Timestamp when this Endpoint was last updated.

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

Returns
TypeDescription
Endpoint.Builder

clone()

public Endpoint.Builder clone()
Returns
TypeDescription
Endpoint.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsTrafficSplit(String key)

public boolean containsTrafficSplit(String key)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Endpoint was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Endpoint was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Endpoint was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Endpoint getDefaultInstanceForType()
Returns
TypeDescription
Endpoint

getDeployedModels(int index)

public DeployedModel getDeployedModels(int index)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedModel

getDeployedModelsBuilder(int index)

public DeployedModel.Builder getDeployedModelsBuilder(int index)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedModel.Builder

getDeployedModelsBuilderList()

public List<DeployedModel.Builder> getDeployedModelsBuilderList()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
List<Builder>

getDeployedModelsCount()

public int getDeployedModelsCount()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
int

getDeployedModelsList()

public List<DeployedModel> getDeployedModelsList()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
List<DeployedModel>

getDeployedModelsOrBuilder(int index)

public DeployedModelOrBuilder getDeployedModelsOrBuilder(int index)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedModelOrBuilder

getDeployedModelsOrBuilderList()

public List<? extends DeployedModelOrBuilder> getDeployedModelsOrBuilderList()

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.DeployedModelOrBuilder>

getDescription()

public String getDescription()

The description of the Endpoint.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Endpoint.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. The display name of the Endpoint. The name can be up to 128 characters long and can be 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 Endpoint. The name can be up to 128 characters long and can be 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.v1.Endpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/endpoint.proto;l=116

Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

bool enable_private_service_connect = 17 [deprecated = true];

Returns
TypeDescription
boolean

The enablePrivateServiceConnect.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Returns
TypeDescription
EncryptionSpec

The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Returns
TypeDescription
EncryptionSpec.Builder

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Returns
TypeDescription
EncryptionSpecOrBuilder

getEtag()

public String getEtag()

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

string etag = 6;

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 = 6;

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 Endpoints. 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 = 7;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

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 Endpoints. 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 = 7;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getModelDeploymentMonitoringJob()

public String getModelDeploymentMonitoringJob()

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The modelDeploymentMonitoringJob.

getModelDeploymentMonitoringJobBytes()

public ByteString getModelDeploymentMonitoringJobBytes()

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for modelDeploymentMonitoringJob.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableTrafficSplit()

public Map<String,Integer> getMutableTrafficSplit()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Integer>

getName()

public String getName()

Output only. The resource name of the Endpoint.

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

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

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for network.

getPredictRequestResponseLoggingConfig()

public PredictRequestResponseLoggingConfig getPredictRequestResponseLoggingConfig()

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Returns
TypeDescription
PredictRequestResponseLoggingConfig

The predictRequestResponseLoggingConfig.

getPredictRequestResponseLoggingConfigBuilder()

public PredictRequestResponseLoggingConfig.Builder getPredictRequestResponseLoggingConfigBuilder()

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Returns
TypeDescription
PredictRequestResponseLoggingConfig.Builder

getPredictRequestResponseLoggingConfigOrBuilder()

public PredictRequestResponseLoggingConfigOrBuilder getPredictRequestResponseLoggingConfigOrBuilder()

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Returns
TypeDescription
PredictRequestResponseLoggingConfigOrBuilder

getTrafficSplit()

public Map<String,Integer> getTrafficSplit()

Use #getTrafficSplitMap() instead.

Returns
TypeDescription
Map<String,Integer>

getTrafficSplitCount()

public int getTrafficSplitCount()

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Returns
TypeDescription
int

getTrafficSplitMap()

public Map<String,Integer> getTrafficSplitMap()

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Returns
TypeDescription
Map<String,Integer>

getTrafficSplitOrDefault(String key, int defaultValue)

public int getTrafficSplitOrDefault(String key, int defaultValue)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameters
NameDescription
keyString
defaultValueint
Returns
TypeDescription
int

getTrafficSplitOrThrow(String key)

public int getTrafficSplitOrThrow(String key)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
int

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Endpoint was last updated.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this Endpoint was last updated.

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Endpoint was last updated.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Endpoint was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Returns
TypeDescription
boolean

Whether the encryptionSpec field is set.

hasPredictRequestResponseLoggingConfig()

public boolean hasPredictRequestResponseLoggingConfig()

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Returns
TypeDescription
boolean

Whether the predictRequestResponseLoggingConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Endpoint was last updated.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Endpoint.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Endpoint was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Endpoint.Builder

mergeEncryptionSpec(EncryptionSpec value)

public Endpoint.Builder mergeEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Parameter
NameDescription
valueEncryptionSpec
Returns
TypeDescription
Endpoint.Builder

mergeFrom(Endpoint other)

public Endpoint.Builder mergeFrom(Endpoint other)
Parameter
NameDescription
otherEndpoint
Returns
TypeDescription
Endpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Endpoint.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Endpoint.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Endpoint.Builder
Overrides

mergePredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig value)

public Endpoint.Builder mergePredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig value)

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Parameter
NameDescription
valuePredictRequestResponseLoggingConfig
Returns
TypeDescription
Endpoint.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Endpoint.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Endpoint.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this Endpoint was last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Endpoint.Builder

putAllLabels(Map<String,String> values)

public Endpoint.Builder putAllLabels(Map<String,String> values)

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Endpoint.Builder

putAllTrafficSplit(Map<String,Integer> values)

public Endpoint.Builder putAllTrafficSplit(Map<String,Integer> values)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameter
NameDescription
valuesMap<String,Integer>
Returns
TypeDescription
Endpoint.Builder

putLabels(String key, String value)

public Endpoint.Builder putLabels(String key, String value)

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Endpoint.Builder

putTrafficSplit(String key, int value)

public Endpoint.Builder putTrafficSplit(String key, int value)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameters
NameDescription
keyString
valueint
Returns
TypeDescription
Endpoint.Builder

removeDeployedModels(int index)

public Endpoint.Builder removeDeployedModels(int index)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Endpoint.Builder

removeLabels(String key)

public Endpoint.Builder removeLabels(String key)

The labels with user-defined metadata to organize your Endpoints. 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 = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
Endpoint.Builder

removeTrafficSplit(String key)

public Endpoint.Builder removeTrafficSplit(String key)

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

map<string, int32> traffic_split = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
Endpoint.Builder

setCreateTime(Timestamp value)

public Endpoint.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Endpoint was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Endpoint.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Endpoint.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Endpoint was created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Endpoint.Builder

setDeployedModels(int index, DeployedModel value)

public Endpoint.Builder setDeployedModels(int index, DeployedModel value)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameters
NameDescription
indexint
valueDeployedModel
Returns
TypeDescription
Endpoint.Builder

setDeployedModels(int index, DeployedModel.Builder builderForValue)

public Endpoint.Builder setDeployedModels(int index, DeployedModel.Builder builderForValue)

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

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

Parameters
NameDescription
indexint
builderForValueDeployedModel.Builder
Returns
TypeDescription
Endpoint.Builder

setDescription(String value)

public Endpoint.Builder setDescription(String value)

The description of the Endpoint.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Endpoint.Builder setDescriptionBytes(ByteString value)

The description of the Endpoint.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setDisplayName(String value)

public Endpoint.Builder setDisplayName(String value)

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

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

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Endpoint.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setEnablePrivateServiceConnect(boolean value) (deprecated)

public Endpoint.Builder setEnablePrivateServiceConnect(boolean value)

Deprecated. google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/endpoint.proto;l=116

Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

bool enable_private_service_connect = 17 [deprecated = true];

Parameter
NameDescription
valueboolean

The enablePrivateServiceConnect to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public Endpoint.Builder setEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Parameter
NameDescription
valueEncryptionSpec
Returns
TypeDescription
Endpoint.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public Endpoint.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

Parameter
NameDescription
builderForValueEncryptionSpec.Builder
Returns
TypeDescription
Endpoint.Builder

setEtag(String value)

public Endpoint.Builder setEtag(String value)

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

string etag = 6;

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Endpoint.Builder setEtagBytes(ByteString value)

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

string etag = 6;

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Endpoint.Builder
Overrides

setModelDeploymentMonitoringJob(String value)

public Endpoint.Builder setModelDeploymentMonitoringJob(String value)

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The modelDeploymentMonitoringJob to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setModelDeploymentMonitoringJobBytes(ByteString value)

public Endpoint.Builder setModelDeploymentMonitoringJobBytes(ByteString value)

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for modelDeploymentMonitoringJob to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setName(String value)

public Endpoint.Builder setName(String value)

Output only. The resource name of the Endpoint.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Endpoint.Builder setNameBytes(ByteString value)

Output only. The resource name of the Endpoint.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setNetwork(String value)

public Endpoint.Builder setNetwork(String value)

The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The network to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public Endpoint.Builder setNetworkBytes(ByteString value)

The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

string network = 13 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for network to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setPredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig value)

public Endpoint.Builder setPredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig value)

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Parameter
NameDescription
valuePredictRequestResponseLoggingConfig
Returns
TypeDescription
Endpoint.Builder

setPredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig.Builder builderForValue)

public Endpoint.Builder setPredictRequestResponseLoggingConfig(PredictRequestResponseLoggingConfig.Builder builderForValue)

Configures the request-response logging for online prediction.

.google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;

Parameter
NameDescription
builderForValuePredictRequestResponseLoggingConfig.Builder
Returns
TypeDescription
Endpoint.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Endpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Endpoint.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Endpoint.Builder
Overrides

setUpdateTime(Timestamp value)

public Endpoint.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this Endpoint was last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Endpoint.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Endpoint.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Endpoint was last updated.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Endpoint.Builder