Struct EndpointService

pub struct EndpointService { /* private fields */ }

Available on crate feature endpoint-service only.

Implements a client for the Vertex AI API.

Example

let client = EndpointService::builder().build().await?;
// use `client` to make requests to the Vertex AI API.

Service Description

A service for managing Vertex AI’s Endpoints.

Configuration

To configure EndpointService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://aiplatform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

EndpointService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap EndpointService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl EndpointService

pub fn builder() -> ClientBuilder

Returns a builder for EndpointService.

let client = EndpointService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: EndpointService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_endpoint(&self) -> CreateEndpoint

Creates an Endpoint.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_endpoint(&self) -> GetEndpoint

Gets an Endpoint.

pub fn list_endpoints(&self) -> ListEndpoints

Lists Endpoints in a Location.

pub fn update_endpoint(&self) -> UpdateEndpoint

Updates an Endpoint.

pub fn update_endpoint_long_running(&self) -> UpdateEndpointLongRunning

Updates an Endpoint with a long running operation.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_endpoint(&self) -> DeleteEndpoint

Deletes an Endpoint.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn deploy_model(&self) -> DeployModel

Deploys a Model into this Endpoint, creating a DeployedModel within it.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn undeploy_model(&self) -> UndeployModel

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it’s using.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn mutate_deployed_model(&self) -> MutateDeployedModel

Updates an existing deployed model. Updatable fields include min_replica_count, max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and enable_container_logging (v1beta1 only).

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

pub fn wait_operation(&self) -> WaitOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for EndpointService

fn clone(&self) -> EndpointService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointService

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

Formats the value using the given formatter.