public final class Endpoint extends GeneratedMessageV3 implements EndpointOrBuilder
Models are deployed into it, and afterwards Endpoint is called to obtain
predictions and explanations.
Protobuf type google.cloud.aiplatform.v1beta1.Endpoint
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DEPLOYED_MODELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MODEL_DEPLOYMENT_MONITORING_JOB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PREDICT_REQUEST_RESPONSE_LOGGING_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TRAFFIC_SPLIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Endpoint getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Endpoint.Builder newBuilder()
public static Endpoint.Builder newBuilder(Endpoint prototype)
| Parameter |
|---|
| Name | Description |
prototype | Endpoint
|
public static Endpoint parseDelimitedFrom(InputStream input)
public static Endpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Endpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteString data)
public static Endpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(CodedInputStream input)
public static Endpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(InputStream input)
public static Endpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteBuffer data)
public static Endpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Endpoint> parser()
Methods
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
|
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
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Endpoint was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Endpoint getDefaultInstanceForType()
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.v1beta1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
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.v1beta1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1beta1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.DeployedModelOrBuilder> | |
public String getDescription()
The description of the Endpoint.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
The description of the Endpoint.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
public String getDisplayName()
Required. The display name of the Endpoint.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. The display name of the Endpoint.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
public boolean getEnablePrivateServiceConnect()
Deprecated. google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect is
deprecated. See google/cloud/aiplatform/v1beta1/endpoint.proto;l=126
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 |
|---|
| Type | Description |
boolean | The enablePrivateServiceConnect.
|
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.v1beta1.EncryptionSpec encryption_spec = 10;
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.v1beta1.EncryptionSpec encryption_spec = 10;
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.
|
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.
|
public Map<String,String> getLabels()
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 | |
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;
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;
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
|
public String getModelDeploymentMonitoringJob()
Output only. Resource name of the Model Monitoring job associated with this
Endpoint if monitoring is enabled by
JobService.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.
|
public ByteString getModelDeploymentMonitoringJobBytes()
Output only. Resource name of the Model Monitoring job associated with this
Endpoint if monitoring is enabled by
JobService.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.
|
Output only. The resource name of the Endpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the Endpoint.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public String getNetwork()
Optional. The full name of the Google Compute Engine
network
to which the 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The network.
|
public ByteString getNetworkBytes()
Optional. 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for network.
|
public Parser<Endpoint> getParserForType()
Overrides
public PredictRequestResponseLoggingConfig getPredictRequestResponseLoggingConfig()
Configures the request-response logging for online prediction.
.google.cloud.aiplatform.v1beta1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
public PredictRequestResponseLoggingConfigOrBuilder getPredictRequestResponseLoggingConfigOrBuilder()
Configures the request-response logging for online prediction.
.google.cloud.aiplatform.v1beta1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Map<String,Integer> getTrafficSplit()
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 | |
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;
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 | |
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 | |
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Endpoint was last updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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.v1beta1.EncryptionSpec encryption_spec = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the encryptionSpec field is set.
|
public boolean hasPredictRequestResponseLoggingConfig()
Configures the request-response logging for online prediction.
.google.cloud.aiplatform.v1beta1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
| Returns |
|---|
| Type | Description |
boolean | Whether the predictRequestResponseLoggingConfig field is set.
|
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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public Endpoint.Builder newBuilderForType()
protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Endpoint.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
