Struct Endpoint 

#[non_exhaustive]
pub struct Endpoint {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub deployed_models: Vec<DeployedModel>,
    pub traffic_split: HashMap<String, i32>,
    pub etag: String,
    pub labels: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub network: String,
    pub enable_private_service_connect: bool,
    pub private_service_connect_config: Option<PrivateServiceConnectConfig>,
    pub model_deployment_monitoring_job: String,
    pub predict_request_response_logging_config: Option<PredictRequestResponseLoggingConfig>,
    pub dedicated_endpoint_enabled: bool,
    pub dedicated_endpoint_dns: String,
    pub client_connection_config: Option<ClientConnectionConfig>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    pub gen_ai_advanced_features_config: Option<GenAiAdvancedFeaturesConfig>,
    pub private_model_server_enabled: bool,
    /* private fields */
}

Available on crate feature endpoint-service only.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. The resource name of the Endpoint.

display_name: String

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

description: String

The description of the Endpoint.

deployed_models: Vec<DeployedModel>

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

traffic_split: HashMap<String, i32>

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.

etag: String

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

labels: HashMap<String, String>

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.

create_time: Option<Timestamp>

Output only. Timestamp when this Endpoint was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Endpoint was last updated.

encryption_spec: Option<EncryptionSpec>

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.

network: String

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.

enable_private_service_connect: bool

👎Deprecated

Deprecated: If true, expose the Endpoint via private service connect.

Only one of the fields, network or enable_private_service_connect, can be set.

private_service_connect_config: Option<PrivateServiceConnectConfig>

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

model_deployment_monitoring_job: String

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}

predict_request_response_logging_config: Option<PredictRequestResponseLoggingConfig>

Configures the request-response logging for online prediction.

dedicated_endpoint_enabled: bool

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.

dedicated_endpoint_dns: String

Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog.

client_connection_config: Option<ClientConnectionConfig>

Configurations that are applied to the endpoint for online prediction.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

gen_ai_advanced_features_config: Option<GenAiAdvancedFeaturesConfig>

Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.

private_model_server_enabled: bool

If true, the model server will be isolated from the external internet.

Implementations

impl Endpoint

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_deployed_models<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DeployedModel>,

Sets the value of deployed_models.

pub fn set_traffic_split<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<i32>,

Sets the value of traffic_split.

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

pub fn set_encryption_spec<T>(self, v: T) -> Self

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

pub fn set_or_clear_encryption_spec<T>(self, v: Option<T>) -> Self

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

pub fn set_network<T: Into<String>>(self, v: T) -> Self

Sets the value of network.

pub fn set_enable_private_service_connect<T: Into<bool>>(self, v: T) -> Self

👎Deprecated

Sets the value of enable_private_service_connect.

pub fn set_private_service_connect_config<T>(self, v: T) -> Self

where T: Into<PrivateServiceConnectConfig>,

Sets the value of private_service_connect_config.

pub fn set_or_clear_private_service_connect_config<T>( self, v: Option<T>, ) -> Self

where T: Into<PrivateServiceConnectConfig>,

Sets or clears the value of private_service_connect_config.

pub fn set_model_deployment_monitoring_job<T: Into<String>>(self, v: T) -> Self

Sets the value of model_deployment_monitoring_job.

pub fn set_predict_request_response_logging_config<T>(self, v: T) -> Self

where T: Into<PredictRequestResponseLoggingConfig>,

Sets the value of predict_request_response_logging_config.

pub fn set_or_clear_predict_request_response_logging_config<T>( self, v: Option<T>, ) -> Self

where T: Into<PredictRequestResponseLoggingConfig>,

Sets or clears the value of predict_request_response_logging_config.

pub fn set_dedicated_endpoint_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of dedicated_endpoint_enabled.

pub fn set_dedicated_endpoint_dns<T: Into<String>>(self, v: T) -> Self

Sets the value of dedicated_endpoint_dns.

pub fn set_client_connection_config<T>(self, v: T) -> Self

where T: Into<ClientConnectionConfig>,

Sets the value of client_connection_config.

pub fn set_or_clear_client_connection_config<T>(self, v: Option<T>) -> Self

where T: Into<ClientConnectionConfig>,

Sets or clears the value of client_connection_config.

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

pub fn set_satisfies_pzi<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzi.

pub fn set_gen_ai_advanced_features_config<T>(self, v: T) -> Self

where T: Into<GenAiAdvancedFeaturesConfig>,

Sets the value of gen_ai_advanced_features_config.

pub fn set_or_clear_gen_ai_advanced_features_config<T>( self, v: Option<T>, ) -> Self

where T: Into<GenAiAdvancedFeaturesConfig>,

Sets or clears the value of gen_ai_advanced_features_config.

pub fn set_private_model_server_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of private_model_server_enabled.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Endpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Endpoint

Returns the “default value” for a type.

impl Message for Endpoint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Endpoint

fn eq(&self, other: &Endpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Endpoint