Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::IndexService::Client (v0.4.0)

Version 0.4.0

• 0.61.0 (latest)
• 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::IndexService::Client.

Client for the IndexService service.

A service for creating and managing Vertex AI's Index resources.

Inherits

• Object

Includes

• Google::Cloud::AIPlatform::V1::IndexService::Paths

Methods

.configure

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

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

#configure

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

Configure the IndexService 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_index

def create_index(request, options = nil) -> ::Gapic::Operation
def create_index(parent: nil, index: nil) -> ::Gapic::Operation

Creates an Index.

Overloads

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

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

Parameters

• request (::Google::Cloud::AIPlatform::V1::CreateIndexRequest, ::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_index(parent: nil, index: nil) -> ::Gapic::Operation

Pass arguments to create_index 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 Index in. Format: projects/{project}/locations/{location}
• index (::Google::Cloud::AIPlatform::V1::Index, ::Hash) — Required. The Index to create.

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::IndexService::Client.new

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

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

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

#delete_index

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

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.

Overloads

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

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

Parameters

• request (::Google::Cloud::AIPlatform::V1::DeleteIndexRequest, ::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_index(name: nil) -> ::Gapic::Operation

Pass arguments to delete_index 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 Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}

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::IndexService::Client.new

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

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

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

#get_index

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

Gets an Index.

Overloads

def get_index(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Index

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

Parameters

• request (::Google::Cloud::AIPlatform::V1::GetIndexRequest, ::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_index(name: nil) -> ::Google::Cloud::AIPlatform::V1::Index

Pass arguments to get_index 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 Index resource. Format: projects/{project}/locations/{location}/indexes/{index}

Yields

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

Yield Parameters

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

Returns

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

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::IndexService::Client.new

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

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

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

#initialize

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

Create a new IndexService client object.

Yields

• (config) — Configure the IndexService 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::IndexService::Client.new

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

#list_indexes

def list_indexes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Index>
def list_indexes(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Index>

Lists Indexes in a Location.

Overloads

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

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

Parameters

• request (::Google::Cloud::AIPlatform::V1::ListIndexesRequest, ::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_indexes(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Index>

Pass arguments to list_indexes 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 from which to list the Indexes. Format: projects/{project}/locations/{location}
• filter (::String) — The standard list filter.
• page_size (::Integer) — The standard list page size.
• page_token (::String) — The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.
• read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.

Yields

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

Yield Parameters

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

Returns

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

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::IndexService::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::Index.
  p response
end

#operations_client

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

Get the associated client for long-running operations.

Returns

• (::Google::Cloud::AIPlatform::V1::IndexService::Operations)

#update_index

def update_index(request, options = nil) -> ::Gapic::Operation
def update_index(index: nil, update_mask: nil) -> ::Gapic::Operation

Updates an Index.

Overloads

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

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

Parameters

• request (::Google::Cloud::AIPlatform::V1::UpdateIndexRequest, ::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_index(index: nil, update_mask: nil) -> ::Gapic::Operation

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

• index (::Google::Cloud::AIPlatform::V1::Index, ::Hash) — Required. The Index which updates the resource on the server.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

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::IndexService::Client.new

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

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

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