Class: Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb

Overview

Client for the FeatureOnlineStoreService service.

A service for fetching feature values from the online store.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#feature_view_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new FeatureOnlineStoreService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the FeatureOnlineStoreService client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/aiplatform/v1/feature_online_store_service_services_pb"

  # 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

  @feature_online_store_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @feature_online_store_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @feature_online_store_service_stub.endpoint
    config.universe_domain = @feature_online_store_service_stub.universe_domain
    config.logger = @feature_online_store_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @feature_online_store_service_stub.endpoint
    config.universe_domain = @feature_online_store_service_stub.universe_domain
    config.logger = @feature_online_store_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

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

Returns:

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


205
206
207
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 205

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


198
199
200
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 198

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the FeatureOnlineStoreService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 64

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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the FeatureOnlineStoreService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#feature_view_direct_write(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse>

Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.

Examples:

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

# Create an input stream.
input = Gapic::StreamInput.new

# Call the feature_view_direct_write method to start streaming.
output = client.feature_view_direct_write input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteRequest.new
input << Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse
output.each do |current_response|
  p current_response
end

Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 447

def feature_view_direct_write request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteRequest
  end

  # 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
  metadata = @config.rpcs.feature_view_direct_write.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.feature_view_direct_write.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.feature_view_direct_write.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @feature_online_store_service_stub.call_rpc :feature_view_direct_write, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_feature_values(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse #fetch_feature_values(feature_view: nil, data_key: nil, data_format: nil) ⇒ ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse

Fetch feature values under a FeatureView.

Examples:

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

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

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

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 269

def fetch_feature_values request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::FetchFeatureValuesRequest

  # 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
  metadata = @config.rpcs.fetch_feature_values.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.feature_view
    header_params["feature_view"] = request.feature_view
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_feature_values.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_feature_values.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @feature_online_store_service_stub.call_rpc :fetch_feature_values, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#generate_fetch_access_token(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenResponse #generate_fetch_access_token(feature_view: nil) ⇒ ::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenResponse

RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.

Examples:

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

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

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

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

Overloads:

  • #generate_fetch_access_token(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenResponse

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

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #generate_fetch_access_token(feature_view: nil) ⇒ ::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenResponse

    Pass arguments to generate_fetch_access_token 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:

    • feature_view (::String) (defaults to: nil) —

      FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 531

def generate_fetch_access_token request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GenerateFetchAccessTokenRequest

  # 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
  metadata = @config.rpcs.generate_fetch_access_token.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.feature_view
    header_params["feature_view"] = request.feature_view
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.generate_fetch_access_token.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_fetch_access_token.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @feature_online_store_service_stub.call_rpc :generate_fetch_access_token, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


212
213
214
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 212

def logger
  @feature_online_store_service_stub.logger
end

#search_nearest_entities(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse #search_nearest_entities(feature_view: nil, query: nil, return_full_entity: nil) ⇒ ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Examples:

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

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

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

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

Overloads:

  • #search_nearest_entities(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse

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

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_nearest_entities(feature_view: nil, query: nil, return_full_entity: nil) ⇒ ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesResponse

    Pass arguments to search_nearest_entities 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:

    • feature_view (::String) (defaults to: nil) —

      Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

    • query (::Google::Cloud::AIPlatform::V1::NearestNeighborQuery, ::Hash) (defaults to: nil) —

      Required. The query.

    • return_full_entity (::Boolean) (defaults to: nil) —

      Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 364

def search_nearest_entities request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::SearchNearestEntitiesRequest

  # 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
  metadata = @config.rpcs.search_nearest_entities.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.feature_view
    header_params["feature_view"] = request.feature_view
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_nearest_entities.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_nearest_entities.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @feature_online_store_service_stub.call_rpc :search_nearest_entities, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb', line 106

def universe_domain
  @feature_online_store_service_stub.universe_domain
end