Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client (v0.49.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.

REST client for the ModelGardenService service.

The interface of Model Garden Service.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ModelGardenService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ModelGardenService clients
::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ModelGardenService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#get_publisher_model

def get_publisher_model(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
def get_publisher_model(name: nil, language_code: nil, view: nil, is_hugging_face_model: nil, hugging_face_token: nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel

Gets a Model Garden publisher model.

Overloads 
def get_publisher_model(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
Pass arguments to get_publisher_model via a request object, either of type GetPublisherModelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetPublisherModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_publisher_model(name: nil, language_code: nil, view: nil, is_hugging_face_model: nil, hugging_face_token: nil) -> ::Google::Cloud::AIPlatform::V1::PublisherModel
Pass arguments to get_publisher_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}
  • language_code (::String) — Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
  • view (::Google::Cloud::AIPlatform::V1::PublisherModelView) — Optional. PublisherModel view specifying which fields to read.
  • is_hugging_face_model (::Boolean) — Optional. Boolean indicates whether the requested model is a Hugging Face model.
  • hugging_face_token (::String) — Optional. Token used to access Hugging Face gated models.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetPublisherModelRequest.new

# Call the get_publisher_model method.
result = client.get_publisher_model request

# The returned object is of type Google::Cloud::AIPlatform::V1::PublisherModel.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new ModelGardenService REST client object.

Yields
  • (config) — Configure the ModelGardenService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)