Vertex AI v1 API - Class ModelGardenServiceClient (3.38.0) 

public abstract class ModelGardenServiceClient

Reference documentation and code samples for the Vertex AI v1 API class ModelGardenServiceClient.

ModelGardenService client wrapper, for convenient use.

Inheritance

object > ModelGardenServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

The interface of Model Garden Service.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ModelGardenService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ModelGardenService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default ModelGardenService scopes are:

DeployOperationsClient

public virtual OperationsClient DeployOperationsClient { get; }

The long-running operations client for Deploy.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual ModelGardenService.ModelGardenServiceClient GrpcClient { get; }

The underlying gRPC ModelGardenService client

Property Value
Type Description
ModelGardenServiceModelGardenServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static ModelGardenServiceClient Create()

Synchronously creates a ModelGardenServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ModelGardenServiceClientBuilder .

Returns
Type Description
ModelGardenServiceClient

The created ModelGardenServiceClient.

CreateAsync(CancellationToken)

public static Task<ModelGardenServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ModelGardenServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ModelGardenServiceClientBuilder .

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskModelGardenServiceClient

The task representing the created ModelGardenServiceClient.

Deploy(DeployRequest, CallSettings)

public virtual Operation<DeployResponse, DeployOperationMetadata> Deploy(DeployRequest request, CallSettings callSettings = null)

Deploys a model to a new endpoint.

Parameters
Name Description
request DeployRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDeployResponseDeployOperationMetadata

The RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
DeployRequest request = new DeployRequest
{
    PublisherModelNameAsPublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    DestinationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ModelConfig = new DeployRequest.Types.ModelConfig(),
    EndpointConfig = new DeployRequest.Types.EndpointConfig(),
    DeployConfig = new DeployRequest.Types.DeployConfig(),
};
// Make the request
Operation<DeployResponse, DeployOperationMetadata> response = modelGardenServiceClient.Deploy(request);

// Poll until the returned long-running operation is complete
Operation<DeployResponse, DeployOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployResponse, DeployOperationMetadata> retrievedResponse = modelGardenServiceClient.PollOnceDeploy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployResponse retrievedResult = retrievedResponse.Result;
}

DeployAsync(DeployRequest, CallSettings)

public virtual Task<Operation<DeployResponse, DeployOperationMetadata>> DeployAsync(DeployRequest request, CallSettings callSettings = null)

Deploys a model to a new endpoint.

Parameters
Name Description
request DeployRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDeployResponseDeployOperationMetadata

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
DeployRequest request = new DeployRequest
{
    PublisherModelNameAsPublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    DestinationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ModelConfig = new DeployRequest.Types.ModelConfig(),
    EndpointConfig = new DeployRequest.Types.EndpointConfig(),
    DeployConfig = new DeployRequest.Types.DeployConfig(),
};
// Make the request
Operation<DeployResponse, DeployOperationMetadata> response = await modelGardenServiceClient.DeployAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployResponse, DeployOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployResponse, DeployOperationMetadata> retrievedResponse = await modelGardenServiceClient.PollOnceDeployAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployResponse retrievedResult = retrievedResponse.Result;
}

DeployAsync(DeployRequest, CancellationToken)

public virtual Task<Operation<DeployResponse, DeployOperationMetadata>> DeployAsync(DeployRequest request, CancellationToken cancellationToken)

Deploys a model to a new endpoint.

Parameters
Name Description
request DeployRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationDeployResponseDeployOperationMetadata

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
DeployRequest request = new DeployRequest
{
    PublisherModelNameAsPublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    DestinationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ModelConfig = new DeployRequest.Types.ModelConfig(),
    EndpointConfig = new DeployRequest.Types.EndpointConfig(),
    DeployConfig = new DeployRequest.Types.DeployConfig(),
};
// Make the request
Operation<DeployResponse, DeployOperationMetadata> response = await modelGardenServiceClient.DeployAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployResponse, DeployOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployResponse, DeployOperationMetadata> retrievedResponse = await modelGardenServiceClient.PollOnceDeployAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployResponse retrievedResult = retrievedResponse.Result;
}

GetPublisherModel(GetPublisherModelRequest, CallSettings)

public virtual PublisherModel GetPublisherModel(GetPublisherModelRequest request, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
request GetPublisherModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PublisherModel

The RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
GetPublisherModelRequest request = new GetPublisherModelRequest
{
    PublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    LanguageCode = "",
    View = PublisherModelView.Unspecified,
    IsHuggingFaceModel = false,
    HuggingFaceToken = "",
};
// Make the request
PublisherModel response = modelGardenServiceClient.GetPublisherModel(request);

GetPublisherModel(PublisherModelName, CallSettings)

public virtual PublisherModel GetPublisherModel(PublisherModelName name, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
name PublisherModelName

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PublisherModel

The RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
PublisherModelName name = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]");
// Make the request
PublisherModel response = modelGardenServiceClient.GetPublisherModel(name);

GetPublisherModel(string, CallSettings)

public virtual PublisherModel GetPublisherModel(string name, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
name string

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PublisherModel

The RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
string name = "publishers/[PUBLISHER]/models/[MODEL]";
// Make the request
PublisherModel response = modelGardenServiceClient.GetPublisherModel(name);

GetPublisherModelAsync(GetPublisherModelRequest, CallSettings)

public virtual Task<PublisherModel> GetPublisherModelAsync(GetPublisherModelRequest request, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
request GetPublisherModelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
GetPublisherModelRequest request = new GetPublisherModelRequest
{
    PublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    LanguageCode = "",
    View = PublisherModelView.Unspecified,
    IsHuggingFaceModel = false,
    HuggingFaceToken = "",
};
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(request);

GetPublisherModelAsync(GetPublisherModelRequest, CancellationToken)

public virtual Task<PublisherModel> GetPublisherModelAsync(GetPublisherModelRequest request, CancellationToken cancellationToken)

Gets a Model Garden publisher model.

Parameters
Name Description
request GetPublisherModelRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
GetPublisherModelRequest request = new GetPublisherModelRequest
{
    PublisherModelName = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]"),
    LanguageCode = "",
    View = PublisherModelView.Unspecified,
    IsHuggingFaceModel = false,
    HuggingFaceToken = "",
};
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(request);

GetPublisherModelAsync(PublisherModelName, CallSettings)

public virtual Task<PublisherModel> GetPublisherModelAsync(PublisherModelName name, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
name PublisherModelName

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
PublisherModelName name = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]");
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(name);

GetPublisherModelAsync(PublisherModelName, CancellationToken)

public virtual Task<PublisherModel> GetPublisherModelAsync(PublisherModelName name, CancellationToken cancellationToken)

Gets a Model Garden publisher model.

Parameters
Name Description
name PublisherModelName

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
PublisherModelName name = PublisherModelName.FromPublisherModel("[PUBLISHER]", "[MODEL]");
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(name);

GetPublisherModelAsync(string, CallSettings)

public virtual Task<PublisherModel> GetPublisherModelAsync(string name, CallSettings callSettings = null)

Gets a Model Garden publisher model.

Parameters
Name Description
name string

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "publishers/[PUBLISHER]/models/[MODEL]";
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(name);

GetPublisherModelAsync(string, CancellationToken)

public virtual Task<PublisherModel> GetPublisherModelAsync(string name, CancellationToken cancellationToken)

Gets a Model Garden publisher model.

Parameters
Name Description
name string

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskPublisherModel

A Task containing the RPC response.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "publishers/[PUBLISHER]/models/[MODEL]";
// Make the request
PublisherModel response = await modelGardenServiceClient.GetPublisherModelAsync(name);

PollOnceDeploy(string, CallSettings)

public virtual Operation<DeployResponse, DeployOperationMetadata> PollOnceDeploy(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Deploy.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDeployResponseDeployOperationMetadata

The result of polling the operation.

PollOnceDeployAsync(string, CallSettings)

public virtual Task<Operation<DeployResponse, DeployOperationMetadata>> PollOnceDeployAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Deploy .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDeployResponseDeployOperationMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.