Class Endpoint.Builder (2.7.4)

Version 2.7.4

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 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 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Endpoint.Builder

Implements

EndpointOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
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

Name	Description
values	Iterable<? extends com.google.cloud.aiplatform.v1.DeployedModel>

Returns

Type	Description
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

Name	Description
value	DeployedModel

Returns

Type	Description
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

Name	Description
builderForValue	DeployedModel.Builder

Returns

Type	Description
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

Name	Description
index	int
value	DeployedModel

Returns

Type	Description
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

Name	Description
index	int
builderForValue	DeployedModel.Builder

Returns

Type	Description
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

Type	Description
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

Name	Description
index	int

Returns

Type	Description
DeployedModel.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Endpoint build()

Returns

Type	Description
Endpoint

buildPartial()

public Endpoint buildPartial()

Returns

Type	Description
Endpoint

clear()

public Endpoint.Builder clear()

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Type	Description
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

Type	Description
Endpoint.Builder

clearDescription()

public Endpoint.Builder clearDescription()

The description of the Endpoint.

string description = 3;

Returns

Type	Description
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

Type	Description
Endpoint.Builder	This builder for chaining.

clearEnablePrivateServiceConnect()

public Endpoint.Builder clearEnablePrivateServiceConnect()

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;

Returns

Type	Description
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

Type	Description
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

Type	Description
Endpoint.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public Endpoint.Builder clearLabels()

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
Endpoint.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearTrafficSplit()

public Endpoint.Builder clearTrafficSplit()

Returns

Type	Description
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

Type	Description
Endpoint.Builder

clone()

public Endpoint.Builder clone()

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Name	Description
key	String

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Endpoint getDefaultInstanceForType()

Returns

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Type	Description
List<? extends com.google.cloud.aiplatform.v1.DeployedModelOrBuilder>

getDescription()

public String getDescription()

The description of the Endpoint.

string description = 3;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Endpoint.

string description = 3;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
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

Type	Description
ByteString	The bytes for displayName.

getEnablePrivateServiceConnect()

public boolean getEnablePrivateServiceConnect()

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;

Returns

Type	Description
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

Type	Description
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

Type	Description
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

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

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

Returns

Type	Description
ByteString	The bytes for etag.

getLabels()

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

Type	Description
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

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

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

Name	Description
key	String

Returns

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for modelDeploymentMonitoringJob.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,String>

getMutableTrafficSplit()

public Map<String,Integer> getMutableTrafficSplit()

Use alternate mutation accessors instead.

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for network.

getTrafficSplit()

public Map<String,Integer> getTrafficSplit()

Use #getTrafficSplitMap() instead.

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
key	String
defaultValue	int

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
boolean	Whether the encryptionSpec 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

Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Name	Description
value	Timestamp

Returns

Type	Description
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

Name	Description
value	EncryptionSpec

Returns

Type	Description
Endpoint.Builder

mergeFrom(Endpoint other)

public Endpoint.Builder mergeFrom(Endpoint other)

Parameter

Name	Description
other	Endpoint

Returns

Type	Description
Endpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Endpoint.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Endpoint.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Endpoint.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
value	Timestamp

Returns

Type	Description
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

Name	Description
values	Map<String,String>

Returns

Type	Description
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

Name	Description
values	Map<String,Integer>

Returns

Type	Description
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

Name	Description
key	String
value	String

Returns

Type	Description
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

Name	Description
key	String
value	int

Returns

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
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

Name	Description
value	Timestamp

Returns

Type	Description
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

Name	Description
builderForValue	Builder

Returns

Type	Description
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

Name	Description
index	int
value	DeployedModel

Returns

Type	Description
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

Name	Description
index	int
builderForValue	DeployedModel.Builder

Returns

Type	Description
Endpoint.Builder

setDescription(String value)

public Endpoint.Builder setDescription(String value)

The description of the Endpoint.

string description = 3;

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Endpoint.Builder setDescriptionBytes(ByteString value)

The description of the Endpoint.

string description = 3;

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
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

Name	Description
value	String The displayName to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for displayName to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setEnablePrivateServiceConnect(boolean value)

public Endpoint.Builder setEnablePrivateServiceConnect(boolean value)

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;

Parameter

Name	Description
value	boolean The enablePrivateServiceConnect to set.

Returns

Type	Description
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

Name	Description
value	EncryptionSpec

Returns

Type	Description
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

Name	Description
builderForValue	EncryptionSpec.Builder

Returns

Type	Description
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

Name	Description
value	String The etag to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for etag to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	String The modelDeploymentMonitoringJob to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for modelDeploymentMonitoringJob to set.

Returns

Type	Description
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

Name	Description
value	String The name to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
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

Name	Description
value	String The network to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for network to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
value	Timestamp

Returns

Type	Description
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

Name	Description
builderForValue	Builder

Returns

Type	Description
Endpoint.Builder