# frozen_string_literal: true # Copyright 2024 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/aiplatform/v1/index_endpoint_service_pb" require "google/cloud/ai_platform/v1/index_endpoint_service/rest/service_stub" require "google/cloud/location/rest" require "google/iam/v1/rest" module Google module Cloud module AIPlatform module V1 module IndexEndpointService module Rest ## # REST client for the IndexEndpointService service. # # A service for managing Vertex AI's IndexEndpoints. # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :index_endpoint_service_stub ## # Configure the IndexEndpointService Client class. # # See {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all IndexEndpointService clients # ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "AIPlatform", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end ## # Configure the IndexEndpointService 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 {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # The effective universe domain # # @return [String] # def universe_domain @index_endpoint_service_stub.universe_domain end ## # Create a new IndexEndpointService REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the IndexEndpointService client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @index_endpoint_service_stub = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @index_endpoint_service_stub.endpoint config.universe_domain = @index_endpoint_service_stub.universe_domain config.bindings_override = @config.bindings_override end @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @index_endpoint_service_stub.endpoint config.universe_domain = @index_endpoint_service_stub.universe_domain config.bindings_override = @config.bindings_override end end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client ## # Get the associated client for mix-in of the IAMPolicy. # # @return [Google::Iam::V1::IAMPolicy::Rest::Client] # attr_reader :iam_policy_client # Service calls ## # Creates an IndexEndpoint. # # @overload create_index_endpoint(request, options = nil) # Pass arguments to `create_index_endpoint` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::CreateIndexEndpointRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::CreateIndexEndpointRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload create_index_endpoint(parent: nil, index_endpoint: nil) # Pass arguments to `create_index_endpoint` 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). # # @param parent [::String] # Required. The resource name of the Location to create the IndexEndpoint in. # Format: `projects/{project}/locations/{location}` # @param index_endpoint [::Google::Cloud::AIPlatform::V1::IndexEndpoint, ::Hash] # Required. The IndexEndpoint to create. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::CreateIndexEndpointRequest.new # # # Call the create_index_endpoint method. # result = client.create_index_endpoint 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 # def create_index_endpoint request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateIndexEndpointRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.create_index_endpoint.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_index_endpoint.timeout, metadata: call_metadata, retry_policy: @config.rpcs.create_index_endpoint.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.create_index_endpoint request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets an IndexEndpoint. # # @overload get_index_endpoint(request, options = nil) # Pass arguments to `get_index_endpoint` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::GetIndexEndpointRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::GetIndexEndpointRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_index_endpoint(name: nil) # Pass arguments to `get_index_endpoint` 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). # # @param name [::String] # Required. The name of the IndexEndpoint resource. # Format: # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::AIPlatform::V1::IndexEndpoint] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::AIPlatform::V1::IndexEndpoint] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::GetIndexEndpointRequest.new # # # Call the get_index_endpoint method. # result = client.get_index_endpoint request # # # The returned object is of type Google::Cloud::AIPlatform::V1::IndexEndpoint. # p result # def get_index_endpoint request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetIndexEndpointRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_index_endpoint.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_index_endpoint.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_index_endpoint.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.get_index_endpoint request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists IndexEndpoints in a Location. # # @overload list_index_endpoints(request, options = nil) # Pass arguments to `list_index_endpoints` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_index_endpoints(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil) # Pass arguments to `list_index_endpoints` 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). # # @param parent [::String] # Required. The resource name of the Location from which to list the # IndexEndpoints. Format: `projects/{project}/locations/{location}` # @param filter [::String] # Optional. An expression for filtering the results of the request. For field # names both snake_case and camelCase are supported. # # * `index_endpoint` supports = and !=. `index_endpoint` represents the # IndexEndpoint ID, ie. the last segment of the IndexEndpoint's # {::Google::Cloud::AIPlatform::V1::IndexEndpoint#name resourcename}. # * `display_name` supports =, != and regex() # (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) # * `labels` supports general map functions that is: # `labels.key=value` - key:value equality # `labels.key:* or labels:key - key existence # A key including a space must be quoted. `labels."a key"`. # # Some examples: # * `index_endpoint="1"` # * `display_name="myDisplayName"` # * `regex(display_name, "^A") -> The display name starts with an A. # * `labels.myKey="myValue"` # @param page_size [::Integer] # Optional. The standard list page size. # @param page_token [::String] # Optional. The standard list page token. # Typically obtained via # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse#next_page_token ListIndexEndpointsResponse.next_page_token} # of the previous # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints} # call. # @param read_mask [::Google::Protobuf::FieldMask, ::Hash] # Optional. Mask specifying which fields to read. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::IndexEndpoint>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::IndexEndpoint>] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest.new # # # Call the list_index_endpoints method. # result = client.list_index_endpoints 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::IndexEndpoint. # p item # end # def list_index_endpoints request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_index_endpoints.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_index_endpoints.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_index_endpoints.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.list_index_endpoints request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @index_endpoint_service_stub, :list_index_endpoints, "index_endpoints", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates an IndexEndpoint. # # @overload update_index_endpoint(request, options = nil) # Pass arguments to `update_index_endpoint` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::UpdateIndexEndpointRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::UpdateIndexEndpointRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_index_endpoint(index_endpoint: nil, update_mask: nil) # Pass arguments to `update_index_endpoint` 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). # # @param index_endpoint [::Google::Cloud::AIPlatform::V1::IndexEndpoint, ::Hash] # Required. The IndexEndpoint which replaces the resource on the server. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. The update mask applies to the resource. See # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::AIPlatform::V1::IndexEndpoint] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::AIPlatform::V1::IndexEndpoint] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::UpdateIndexEndpointRequest.new # # # Call the update_index_endpoint method. # result = client.update_index_endpoint request # # # The returned object is of type Google::Cloud::AIPlatform::V1::IndexEndpoint. # p result # def update_index_endpoint request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateIndexEndpointRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_index_endpoint.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_index_endpoint.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_index_endpoint.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.update_index_endpoint request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes an IndexEndpoint. # # @overload delete_index_endpoint(request, options = nil) # Pass arguments to `delete_index_endpoint` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::DeleteIndexEndpointRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::DeleteIndexEndpointRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload delete_index_endpoint(name: nil) # Pass arguments to `delete_index_endpoint` 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). # # @param name [::String] # Required. The name of the IndexEndpoint resource to be deleted. # Format: # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::DeleteIndexEndpointRequest.new # # # Call the delete_index_endpoint method. # result = client.delete_index_endpoint 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 # def delete_index_endpoint request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteIndexEndpointRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete_index_endpoint.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_index_endpoint.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_index_endpoint.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.delete_index_endpoint request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deploys an Index into this IndexEndpoint, creating a DeployedIndex within # it. # Only non-empty Indexes can be deployed. # # @overload deploy_index(request, options = nil) # Pass arguments to `deploy_index` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::DeployIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::DeployIndexRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload deploy_index(index_endpoint: nil, deployed_index: nil) # Pass arguments to `deploy_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). # # @param index_endpoint [::String] # Required. The name of the IndexEndpoint resource into which to deploy an # Index. Format: # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` # @param deployed_index [::Google::Cloud::AIPlatform::V1::DeployedIndex, ::Hash] # Required. The DeployedIndex to be created within the IndexEndpoint. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::DeployIndexRequest.new # # # Call the deploy_index method. # result = client.deploy_index 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 # def deploy_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeployIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.deploy_index.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.deploy_index.timeout, metadata: call_metadata, retry_policy: @config.rpcs.deploy_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.deploy_index request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, # and freeing all resources it's using. # # @overload undeploy_index(request, options = nil) # Pass arguments to `undeploy_index` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::UndeployIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::UndeployIndexRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload undeploy_index(index_endpoint: nil, deployed_index_id: nil) # Pass arguments to `undeploy_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). # # @param index_endpoint [::String] # Required. The name of the IndexEndpoint resource from which to undeploy an # Index. Format: # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` # @param deployed_index_id [::String] # Required. The ID of the DeployedIndex to be undeployed from the # IndexEndpoint. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::UndeployIndexRequest.new # # # Call the undeploy_index method. # result = client.undeploy_index 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 # def undeploy_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UndeployIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.undeploy_index.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.undeploy_index.timeout, metadata: call_metadata, retry_policy: @config.rpcs.undeploy_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.undeploy_index request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Update an existing DeployedIndex under an IndexEndpoint. # # @overload mutate_deployed_index(request, options = nil) # Pass arguments to `mutate_deployed_index` via a request object, either of type # {::Google::Cloud::AIPlatform::V1::MutateDeployedIndexRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AIPlatform::V1::MutateDeployedIndexRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload mutate_deployed_index(index_endpoint: nil, deployed_index: nil) # Pass arguments to `mutate_deployed_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). # # @param index_endpoint [::String] # Required. The name of the IndexEndpoint resource into which to deploy an # Index. Format: # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` # @param deployed_index [::Google::Cloud::AIPlatform::V1::DeployedIndex, ::Hash] # Required. The DeployedIndex to be updated within the IndexEndpoint. # Currently, the updatable fields are # {::Google::Cloud::AIPlatform::V1::DeployedIndex#automatic_resources DeployedIndex.automatic_resources} # and # {::Google::Cloud::AIPlatform::V1::DeployedIndex#dedicated_resources DeployedIndex.dedicated_resources} # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::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::IndexEndpointService::Rest::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AIPlatform::V1::MutateDeployedIndexRequest.new # # # Call the mutate_deployed_index method. # result = client.mutate_deployed_index 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 # def mutate_deployed_index request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::MutateDeployedIndexRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.mutate_deployed_index.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.mutate_deployed_index.timeout, metadata: call_metadata, retry_policy: @config.rpcs.mutate_deployed_index.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @index_endpoint_service_stub.mutate_deployed_index request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the IndexEndpointService REST API. # # This class represents the configuration for IndexEndpointService REST, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_index_endpoint to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_index_endpoint.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_index_endpoint.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "aiplatform.googleapis.com" config_attr :endpoint, nil, ::String, nil config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil # @private # Overrides for http bindings for the RPCs of this service # are only used when this service is used as mixin, and only # by the host service. # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}] config_attr :bindings_override, {}, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the IndexEndpointService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_index_endpoint` # @return [::Gapic::Config::Method] # attr_reader :create_index_endpoint ## # RPC-specific configuration for `get_index_endpoint` # @return [::Gapic::Config::Method] # attr_reader :get_index_endpoint ## # RPC-specific configuration for `list_index_endpoints` # @return [::Gapic::Config::Method] # attr_reader :list_index_endpoints ## # RPC-specific configuration for `update_index_endpoint` # @return [::Gapic::Config::Method] # attr_reader :update_index_endpoint ## # RPC-specific configuration for `delete_index_endpoint` # @return [::Gapic::Config::Method] # attr_reader :delete_index_endpoint ## # RPC-specific configuration for `deploy_index` # @return [::Gapic::Config::Method] # attr_reader :deploy_index ## # RPC-specific configuration for `undeploy_index` # @return [::Gapic::Config::Method] # attr_reader :undeploy_index ## # RPC-specific configuration for `mutate_deployed_index` # @return [::Gapic::Config::Method] # attr_reader :mutate_deployed_index # @private def initialize parent_rpcs = nil create_index_endpoint_config = parent_rpcs.create_index_endpoint if parent_rpcs.respond_to? :create_index_endpoint @create_index_endpoint = ::Gapic::Config::Method.new create_index_endpoint_config get_index_endpoint_config = parent_rpcs.get_index_endpoint if parent_rpcs.respond_to? :get_index_endpoint @get_index_endpoint = ::Gapic::Config::Method.new get_index_endpoint_config list_index_endpoints_config = parent_rpcs.list_index_endpoints if parent_rpcs.respond_to? :list_index_endpoints @list_index_endpoints = ::Gapic::Config::Method.new list_index_endpoints_config update_index_endpoint_config = parent_rpcs.update_index_endpoint if parent_rpcs.respond_to? :update_index_endpoint @update_index_endpoint = ::Gapic::Config::Method.new update_index_endpoint_config delete_index_endpoint_config = parent_rpcs.delete_index_endpoint if parent_rpcs.respond_to? :delete_index_endpoint @delete_index_endpoint = ::Gapic::Config::Method.new delete_index_endpoint_config deploy_index_config = parent_rpcs.deploy_index if parent_rpcs.respond_to? :deploy_index @deploy_index = ::Gapic::Config::Method.new deploy_index_config undeploy_index_config = parent_rpcs.undeploy_index if parent_rpcs.respond_to? :undeploy_index @undeploy_index = ::Gapic::Config::Method.new undeploy_index_config mutate_deployed_index_config = parent_rpcs.mutate_deployed_index if parent_rpcs.respond_to? :mutate_deployed_index @mutate_deployed_index = ::Gapic::Config::Method.new mutate_deployed_index_config yield self if block_given? end end end end end end end end end end