Cloud AI Platform v1 API - Class EndpointService.EndpointServiceClient (2.28.0)

public class EndpointService.EndpointServiceClient : ClientBase<EndpointService.EndpointServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class EndpointService.EndpointServiceClient.

Client for EndpointService

Inheritance

object > ClientBase > ClientBaseEndpointServiceEndpointServiceClient > EndpointService.EndpointServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

EndpointServiceClient()

protected EndpointServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EndpointServiceClient(CallInvoker)

public EndpointServiceClient(CallInvoker callInvoker)

Creates a new client for EndpointService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

EndpointServiceClient(ChannelBase)

public EndpointServiceClient(ChannelBase channel)

Creates a new client for EndpointService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

EndpointServiceClient(ClientBaseConfiguration)

protected EndpointServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateEndpoint(CreateEndpointRequest, CallOptions)

public virtual Operation CreateEndpoint(CreateEndpointRequest request, CallOptions options)

Creates an Endpoint.

Parameters
Name Description
request CreateEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateEndpoint(CreateEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEndpoint(CreateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an Endpoint.

Parameters
Name Description
request CreateEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateEndpointAsync(CreateEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEndpointAsync(CreateEndpointRequest request, CallOptions options)

Creates an Endpoint.

Parameters
Name Description
request CreateEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEndpointAsync(CreateEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEndpointAsync(CreateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an Endpoint.

Parameters
Name Description
request CreateEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteEndpoint(DeleteEndpointRequest, CallOptions)

public virtual Operation DeleteEndpoint(DeleteEndpointRequest request, CallOptions options)

Deletes an Endpoint.

Parameters
Name Description
request DeleteEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEndpoint(DeleteEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEndpoint(DeleteEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an Endpoint.

Parameters
Name Description
request DeleteEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEndpointAsync(DeleteEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEndpointAsync(DeleteEndpointRequest request, CallOptions options)

Deletes an Endpoint.

Parameters
Name Description
request DeleteEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEndpointAsync(DeleteEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEndpointAsync(DeleteEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an Endpoint.

Parameters
Name Description
request DeleteEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeployModel(DeployModelRequest, CallOptions)

public virtual Operation DeployModel(DeployModelRequest request, CallOptions options)

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

Parameters
Name Description
request DeployModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeployModel(DeployModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeployModel(DeployModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DeployModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeployModelAsync(DeployModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeployModelAsync(DeployModelRequest request, CallOptions options)

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

Parameters
Name Description
request DeployModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeployModelAsync(DeployModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeployModelAsync(DeployModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DeployModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetEndpoint(GetEndpointRequest, CallOptions)

public virtual Endpoint GetEndpoint(GetEndpointRequest request, CallOptions options)

Gets an Endpoint.

Parameters
Name Description
request GetEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Endpoint

The response received from the server.

GetEndpoint(GetEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Endpoint GetEndpoint(GetEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an Endpoint.

Parameters
Name Description
request GetEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Endpoint

The response received from the server.

GetEndpointAsync(GetEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Endpoint> GetEndpointAsync(GetEndpointRequest request, CallOptions options)

Gets an Endpoint.

Parameters
Name Description
request GetEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEndpoint

The call object.

GetEndpointAsync(GetEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Endpoint> GetEndpointAsync(GetEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an Endpoint.

Parameters
Name Description
request GetEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEndpoint

The call object.

ListEndpoints(ListEndpointsRequest, CallOptions)

public virtual ListEndpointsResponse ListEndpoints(ListEndpointsRequest request, CallOptions options)

Lists Endpoints in a Location.

Parameters
Name Description
request ListEndpointsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEndpointsResponse

The response received from the server.

ListEndpoints(ListEndpointsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEndpointsResponse ListEndpoints(ListEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Endpoints in a Location.

Parameters
Name Description
request ListEndpointsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEndpointsResponse

The response received from the server.

ListEndpointsAsync(ListEndpointsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEndpointsResponse> ListEndpointsAsync(ListEndpointsRequest request, CallOptions options)

Lists Endpoints in a Location.

Parameters
Name Description
request ListEndpointsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEndpointsResponse

The call object.

ListEndpointsAsync(ListEndpointsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEndpointsResponse> ListEndpointsAsync(ListEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Endpoints in a Location.

Parameters
Name Description
request ListEndpointsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEndpointsResponse

The call object.

MutateDeployedModel(MutateDeployedModelRequest, CallOptions)

public virtual Operation MutateDeployedModel(MutateDeployedModelRequest request, CallOptions options)

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

Parameters
Name Description
request MutateDeployedModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

MutateDeployedModel(MutateDeployedModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation MutateDeployedModel(MutateDeployedModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request MutateDeployedModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

MutateDeployedModelAsync(MutateDeployedModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> MutateDeployedModelAsync(MutateDeployedModelRequest request, CallOptions options)

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

Parameters
Name Description
request MutateDeployedModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

MutateDeployedModelAsync(MutateDeployedModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> MutateDeployedModelAsync(MutateDeployedModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request MutateDeployedModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

NewInstance(ClientBaseConfiguration)

protected override EndpointService.EndpointServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
EndpointServiceEndpointServiceClient
Overrides

UndeployModel(UndeployModelRequest, CallOptions)

public virtual Operation UndeployModel(UndeployModelRequest request, CallOptions options)

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

Parameters
Name Description
request UndeployModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UndeployModel(UndeployModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UndeployModel(UndeployModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UndeployModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UndeployModelAsync(UndeployModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeployModelAsync(UndeployModelRequest request, CallOptions options)

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

Parameters
Name Description
request UndeployModelRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UndeployModelAsync(UndeployModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeployModelAsync(UndeployModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UndeployModelRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateEndpoint(UpdateEndpointRequest, CallOptions)

public virtual Endpoint UpdateEndpoint(UpdateEndpointRequest request, CallOptions options)

Updates an Endpoint.

Parameters
Name Description
request UpdateEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Endpoint

The response received from the server.

UpdateEndpoint(UpdateEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Endpoint UpdateEndpoint(UpdateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an Endpoint.

Parameters
Name Description
request UpdateEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Endpoint

The response received from the server.

UpdateEndpointAsync(UpdateEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Endpoint> UpdateEndpointAsync(UpdateEndpointRequest request, CallOptions options)

Updates an Endpoint.

Parameters
Name Description
request UpdateEndpointRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEndpoint

The call object.

UpdateEndpointAsync(UpdateEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Endpoint> UpdateEndpointAsync(UpdateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an Endpoint.

Parameters
Name Description
request UpdateEndpointRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEndpoint

The call object.