Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::PersistentResourceService::Client (v0.58.0)

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

Client for the PersistentResourceService service.

A service for managing Vertex AI's machine learning PersistentResource.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the PersistentResourceService 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 PersistentResourceService clients
::Google::Cloud::AIPlatform::V1::PersistentResourceService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

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

#create_persistent_resource

def create_persistent_resource(request, options = nil) -> ::Gapic::Operation
def create_persistent_resource(parent: nil, persistent_resource: nil, persistent_resource_id: nil) -> ::Gapic::Operation

Creates a PersistentResource.

Overloads 
def create_persistent_resource(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_persistent_resource via a request object, either of type CreatePersistentResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CreatePersistentResourceRequest, ::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_persistent_resource(parent: nil, persistent_resource: nil, persistent_resource_id: nil) -> ::Gapic::Operation
Pass arguments to create_persistent_resource 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 resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}
  • persistent_resource (::Google::Cloud::AIPlatform::V1::PersistentResource, ::Hash) — Required. The PersistentResource to create.
  • persistent_resource_id (::String) — Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name.

    The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
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::PersistentResourceService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_persistent_resource

def delete_persistent_resource(request, options = nil) -> ::Gapic::Operation
def delete_persistent_resource(name: nil) -> ::Gapic::Operation

Deletes a PersistentResource.

Overloads 
def delete_persistent_resource(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_persistent_resource via a request object, either of type DeletePersistentResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::DeletePersistentResourceRequest, ::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_persistent_resource(name: nil) -> ::Gapic::Operation
Pass arguments to delete_persistent_resource 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 name of the PersistentResource to be deleted. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
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::PersistentResourceService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_persistent_resource

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

Gets a PersistentResource.

Overloads 
def get_persistent_resource(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::PersistentResource
Pass arguments to get_persistent_resource via a request object, either of type GetPersistentResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::GetPersistentResourceRequest, ::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_persistent_resource(name: nil) -> ::Google::Cloud::AIPlatform::V1::PersistentResource
Pass arguments to get_persistent_resource 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 name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::PersistentResourceService::Client.new

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

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

# The returned object is of type Google::Cloud::AIPlatform::V1::PersistentResource.
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 PersistentResourceService client object.

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

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

#list_persistent_resources

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

Lists PersistentResources in a Location.

Overloads 
def list_persistent_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PersistentResource>
Pass arguments to list_persistent_resources via a request object, either of type ListPersistentResourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::ListPersistentResourcesRequest, ::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_persistent_resources(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::PersistentResource>
Pass arguments to list_persistent_resources 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 resource name of the Location to list the PersistentResources from. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The standard list page size.
  • page_token (::String) — Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous [PersistentResourceService.ListPersistentResource][] call.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
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::PersistentResourceService::Client.new

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

# Call the list_persistent_resources method.
result = client.list_persistent_resources 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::PersistentResource.
  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)

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::PersistentResourceService::Operations

Get the associated client for long-running operations.

Returns

#reboot_persistent_resource

def reboot_persistent_resource(request, options = nil) -> ::Gapic::Operation
def reboot_persistent_resource(name: nil) -> ::Gapic::Operation

Reboots a PersistentResource.

Overloads 
def reboot_persistent_resource(request, options = nil) -> ::Gapic::Operation
Pass arguments to reboot_persistent_resource via a request object, either of type RebootPersistentResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::RebootPersistentResourceRequest, ::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 reboot_persistent_resource(name: nil) -> ::Gapic::Operation
Pass arguments to reboot_persistent_resource 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 name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
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::PersistentResourceService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_persistent_resource

def update_persistent_resource(request, options = nil) -> ::Gapic::Operation
def update_persistent_resource(persistent_resource: nil, update_mask: nil) -> ::Gapic::Operation

Updates a PersistentResource.

Overloads 
def update_persistent_resource(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_persistent_resource via a request object, either of type UpdatePersistentResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::UpdatePersistentResourceRequest, ::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_persistent_resource(persistent_resource: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_persistent_resource 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
  • persistent_resource (::Google::Cloud::AIPlatform::V1::PersistentResource, ::Hash) — Required. The PersistentResource to update.

    The PersistentResource's name field is used to identify the PersistentResource to update. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Specify the fields to be overwritten in the PersistentResource by the update method.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
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::PersistentResourceService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end