public sealed class Endpoint : IMessage<Endpoint>, IEquatable<Endpoint>, IDeepCloneable<Endpoint>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class Endpoint.
Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
Namespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
Endpoint()
public Endpoint()Endpoint(Endpoint)
public Endpoint(Endpoint other)| Parameter | |
|---|---|
| Name | Description |
other |
Endpoint |
Properties
ClientConnectionConfig
public ClientConnectionConfig ClientConnectionConfig { get; set; }Configurations that are applied to the endpoint for online prediction.
| Property Value | |
|---|---|
| Type | Description |
ClientConnectionConfig |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp when this Endpoint was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DedicatedEndpointDns
public string DedicatedEndpointDns { get; set; }Output only. DNS of the dedicated endpoint. Will only be populated if
dedicated_endpoint_enabled is true.
Format:
https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DedicatedEndpointEnabled
public bool DedicatedEndpointEnabled { get; set; }If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DeployedModels
public RepeatedField<DeployedModel> DeployedModels { get; }Output only. The models deployed in this Endpoint. To add or remove DeployedModels use [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] and [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel] respectively.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDeployedModel |
|
Description
public string Description { get; set; }The description of the Endpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnablePrivateServiceConnect
[Obsolete]
public bool EnablePrivateServiceConnect { get; set; }Deprecated: If true, expose the Endpoint via private service connect.
Only one of the fields, [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect], can be set.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EncryptionSpec
public EncryptionSpec EncryptionSpec { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
EncryptionSpec |
|
EndpointName
public EndpointName EndpointName { get; set; }EndpointName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
EndpointName |
|
Etag
public string Etag { get; set; }Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
ModelDeploymentMonitoringJob
public string ModelDeploymentMonitoringJob { get; set; }Output only. Resource name of the Model Monitoring job associated with this
Endpoint if monitoring is enabled by
[JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1beta1.JobService.CreateModelDeploymentMonitoringJob].
Format:
projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
| Property Value | |
|---|---|
| Type | Description |
string |
|
ModelDeploymentMonitoringJobAsModelDeploymentMonitoringJobName
public ModelDeploymentMonitoringJobName ModelDeploymentMonitoringJobAsModelDeploymentMonitoringJobName { get; set; }ModelDeploymentMonitoringJobName-typed view over the ModelDeploymentMonitoringJob resource name property.
| Property Value | |
|---|---|
| Type | Description |
ModelDeploymentMonitoringJobName |
|
Name
public string Name { get; set; }Output only. The resource name of the Endpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Network
public string Network { get; set; }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][google.cloud.aiplatform.v1beta1.Endpoint.network] or [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
NetworkAsNetworkName
public NetworkName NetworkAsNetworkName { get; set; }NetworkName-typed view over the Network resource name property.
| Property Value | |
|---|---|
| Type | Description |
NetworkName |
|
PredictRequestResponseLoggingConfig
public PredictRequestResponseLoggingConfig PredictRequestResponseLoggingConfig { get; set; }Configures the request-response logging for online prediction.
| Property Value | |
|---|---|
| Type | Description |
PredictRequestResponseLoggingConfig |
|
PrivateServiceConnectConfig
public PrivateServiceConnectConfig PrivateServiceConnectConfig { get; set; }Optional. Configuration for private service connect.
[network][google.cloud.aiplatform.v1beta1.Endpoint.network] and [private_service_connect_config][google.cloud.aiplatform.v1beta1.Endpoint.private_service_connect_config] are mutually exclusive.
| Property Value | |
|---|---|
| Type | Description |
PrivateServiceConnectConfig |
|
SatisfiesPzi
public bool SatisfiesPzi { get; set; }Output only. Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SatisfiesPzs
public bool SatisfiesPzs { get; set; }Output only. Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
TrafficSplit
public MapField<string, int> TrafficSplit { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringint |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp when this Endpoint was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|