Cloud AI Platform v1beta1 API - Class ModelGardenServiceClient (1.0.0-beta02) 

public abstract class ModelGardenServiceClient

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

ModelGardenService client wrapper, for convenient use.

Inheritance

object > ModelGardenServiceClient

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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:

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

ListPublisherModels(ListPublisherModelsRequest, CallSettings)

public virtual PagedEnumerable<ListPublisherModelsResponse, PublisherModel> ListPublisherModels(ListPublisherModelsRequest request, CallSettings callSettings = null)

Lists publisher models in Model Garden.

Parameters
Name Description
request ListPublisherModelsRequest

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
PagedEnumerableListPublisherModelsResponsePublisherModel

A pageable sequence of PublisherModel resources.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
ListPublisherModelsRequest request = new ListPublisherModelsRequest
{
    Parent = "",
    Filter = "",
    View = PublisherModelView.Unspecified,
    OrderBy = "",
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListPublisherModelsResponse, PublisherModel> response = modelGardenServiceClient.ListPublisherModels(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PublisherModel item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPublisherModelsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PublisherModel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PublisherModel> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PublisherModel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPublisherModels(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListPublisherModelsResponse, PublisherModel> ListPublisherModels(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists publisher models in Model Garden.

Parameters
Name Description
parent string

Required. The name of the Publisher from which to list the PublisherModels. Format: publishers/{publisher}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

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

A pageable sequence of PublisherModel resources.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<ListPublisherModelsResponse, PublisherModel> response = modelGardenServiceClient.ListPublisherModels(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PublisherModel item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPublisherModelsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PublisherModel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PublisherModel> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PublisherModel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPublisherModelsAsync(ListPublisherModelsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPublisherModelsResponse, PublisherModel> ListPublisherModelsAsync(ListPublisherModelsRequest request, CallSettings callSettings = null)

Lists publisher models in Model Garden.

Parameters
Name Description
request ListPublisherModelsRequest

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
PagedAsyncEnumerableListPublisherModelsResponsePublisherModel

A pageable asynchronous sequence of PublisherModel resources.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
ListPublisherModelsRequest request = new ListPublisherModelsRequest
{
    Parent = "",
    Filter = "",
    View = PublisherModelView.Unspecified,
    OrderBy = "",
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListPublisherModelsResponse, PublisherModel> response = modelGardenServiceClient.ListPublisherModelsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PublisherModel item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPublisherModelsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PublisherModel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PublisherModel> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PublisherModel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPublisherModelsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPublisherModelsResponse, PublisherModel> ListPublisherModelsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists publisher models in Model Garden.

Parameters
Name Description
parent string

Required. The name of the Publisher from which to list the PublisherModels. Format: publishers/{publisher}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

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

A pageable asynchronous sequence of PublisherModel resources.
Example 
// Create client
ModelGardenServiceClient modelGardenServiceClient = await ModelGardenServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<ListPublisherModelsResponse, PublisherModel> response = modelGardenServiceClient.ListPublisherModelsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PublisherModel item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPublisherModelsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PublisherModel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PublisherModel> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PublisherModel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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.