Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::GenAiCacheService::Client (v0.62.0)

Version latest

• 0.62.0 (latest)
• 0.61.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

Client for the GenAiCacheService service.

Service for managing Vertex AI's CachedContent resource.

Inherits

• Object

Includes

• Google::Cloud::AIPlatform::V1::GenAiCacheService::Paths

Methods

.configure

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

Configure the GenAiCacheService Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all GenAiCacheService clients
::Google::Cloud::AIPlatform::V1::GenAiCacheService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the GenAiCacheService 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

• config (Client::Configuration)

Returns

• (Client::Configuration)

#create_cached_content

def create_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent
def create_cached_content(parent: nil, cached_content: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

Overloads

def create_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to create_cached_content via a request object, either of type CreateCachedContentRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::CreateCachedContentRequest, ::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 create_cached_content(parent: nil, cached_content: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to create_cached_content 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

• parent (::String) — Required. The parent resource where the cached content will be created
• cached_content (::Google::Cloud::AIPlatform::V1::CachedContent, ::Hash) — Required. The cached content to create

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::CachedContent)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::CachedContent)

Raises

• (::Google::Cloud::Error) — if the RPC 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::GenAiCacheService::Client.new

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

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

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

#delete_cached_content

def delete_cached_content(request, options = nil) -> ::Google::Protobuf::Empty
def delete_cached_content(name: nil) -> ::Google::Protobuf::Empty

Deletes cached content

Overloads

def delete_cached_content(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_cached_content via a request object, either of type DeleteCachedContentRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::DeleteCachedContentRequest, ::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 delete_cached_content(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_cached_content 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).

Parameter

• name (::String) — Required. The resource name referring to the cached content

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Protobuf::Empty)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Protobuf::Empty)

Raises

• (::Google::Cloud::Error) — if the RPC 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::GenAiCacheService::Client.new

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#get_cached_content

def get_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent
def get_cached_content(name: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Gets cached content configurations

Overloads

def get_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to get_cached_content via a request object, either of type Google::Cloud::AIPlatform::V1::GetCachedContentRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::GetCachedContentRequest, ::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_cached_content(name: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to get_cached_content 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).

Parameter

• name (::String) — Required. The resource name referring to the cached content

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::CachedContent)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::CachedContent)

Raises

• (::Google::Cloud::Error) — if the RPC 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::GenAiCacheService::Client.new

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

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

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

#iam_policy_client

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

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

Returns

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

#initialize

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

Create a new GenAiCacheService client object.

Yields

• (config) — Configure the GenAiCacheService client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::GenAiCacheService::Client.new

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

#list_cached_contents

def list_cached_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>
def list_cached_contents(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>

Lists cached contents in a project

Overloads

def list_cached_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>

Pass arguments to list_cached_contents via a request object, either of type ListCachedContentsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::ListCachedContentsRequest, ::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 list_cached_contents(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>

Pass arguments to list_cached_contents 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

• parent (::String) — Required. The parent, which owns this collection of cached contents.
• page_size (::Integer) — Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
• page_token (::String) — Optional. A page token, received from a previous ListCachedContents call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListCachedContents must match the call that provided the page token.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::CachedContent>)

Raises

• (::Google::Cloud::Error) — if the RPC 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::GenAiCacheService::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::CachedContent.
  p item
end

#location_client

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

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

Returns

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

• (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_cached_content

def update_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent
def update_cached_content(cached_content: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Updates cached content configurations

Overloads

def update_cached_content(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to update_cached_content via a request object, either of type UpdateCachedContentRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::AIPlatform::V1::UpdateCachedContentRequest, ::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 update_cached_content(cached_content: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::CachedContent

Pass arguments to update_cached_content 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

• cached_content (::Google::Cloud::AIPlatform::V1::CachedContent, ::Hash) — Required. The cached content to update
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to update.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::AIPlatform::V1::CachedContent)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::AIPlatform::V1::CachedContent)

Raises

• (::Google::Cloud::Error) — if the RPC 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::GenAiCacheService::Client.new

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

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

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