Cloud AI Platform v1 API - Class ModelGardenServiceClient (3.12.0)

Version 3.12.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class ModelGardenServiceClient

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

ModelGardenService client wrapper, for convenient use.

Inheritance

object > ModelGardenServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ModelGardenServiceClientImpl

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:

• https://www.googleapis.com/auth/cloud-platform

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.

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

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.