Class: Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Rest::Client

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

Overview

REST client for the FeaturestoreOnlineServingService service.

A service for serving online feature values.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#entity_type_path

Constructor Details

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

Create a new FeaturestoreOnlineServingService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the FeaturestoreOnlineServingService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 128

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

  @featurestore_online_serving_service_stub = ::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::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 = @featurestore_online_serving_service_stub.endpoint
    config.universe_domain = @featurestore_online_serving_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 = @featurestore_online_serving_service_stub.endpoint
    config.universe_domain = @featurestore_online_serving_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
  end
end

Instance Attribute Details

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

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

Returns:

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


187
188
189
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 187

def iam_policy_client
  @iam_policy_client
end

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

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

Returns:

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


180
181
182
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 180

def location_client
  @location_client
end

Class Method Details

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

Configure the FeaturestoreOnlineServingService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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 FeaturestoreOnlineServingService 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:



98
99
100
101
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#read_feature_values(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse #read_feature_values(entity_type: nil, entity_id: nil, feature_selector: nil) ⇒ ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

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

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

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

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

Overloads:

  • #read_feature_values(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

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

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::ReadFeatureValuesRequest, ::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.

  • #read_feature_values(entity_type: nil, entity_id: nil, feature_selector: nil) ⇒ ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse

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

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

      Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

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

      Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

    • feature_selector (::Google::Cloud::AIPlatform::V1::FeatureSelector, ::Hash) (defaults to: nil) —

      Required. Selector choosing Features of the target EntityType.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 246

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

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

  # 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.read_feature_values.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.read_feature_values.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.read_feature_values.retry_policy

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

  @featurestore_online_serving_service_stub.read_feature_values 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

#streaming_read_feature_values(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse> #streaming_read_feature_values(entity_type: nil, entity_ids: nil, feature_selector: nil) ⇒ ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

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

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

# Call the streaming_read_feature_values method to start streaming.
output = client.streaming_read_feature_values request

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

Overloads:

  • #streaming_read_feature_values(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

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

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::StreamingReadFeatureValuesRequest, ::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.

  • #streaming_read_feature_values(entity_type: nil, entity_ids: nil, feature_selector: nil) ⇒ ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>

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

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

      Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

    • entity_ids (::Array<::String>) (defaults to: nil) —

      Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

    • feature_selector (::Google::Cloud::AIPlatform::V1::FeatureSelector, ::Hash) (defaults to: nil) —

      Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

Returns:

Raises:

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

    if the REST call is aborted.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 338

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

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

  # 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.streaming_read_feature_values.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.streaming_read_feature_values.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.streaming_read_feature_values.retry_policy

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

  ::Gapic::Rest::ServerStream.new(
    ::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse,
    ::Gapic::Rest::ThreadedEnumerator.new do |in_q, out_q|
      @featurestore_online_serving_service_stub.streaming_read_feature_values request, options do |chunk|
        in_q.deq
        out_q.enq chunk
      end
    end
  )
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 108

def universe_domain
  @featurestore_online_serving_service_stub.universe_domain
end

#write_feature_values(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse #write_feature_values(entity_type: nil, payloads: nil) ⇒ ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

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

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

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

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

Overloads:

  • #write_feature_values(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

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

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::WriteFeatureValuesRequest, ::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.

  • #write_feature_values(entity_type: nil, payloads: nil) ⇒ ::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse

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

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

      Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ \\{featurestore}/entityTypes/\\{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

    • payloads (::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload, ::Hash>) (defaults to: nil) —

      Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb', line 434

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

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

  # 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.write_feature_values.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.write_feature_values.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.write_feature_values.retry_policy

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

  @featurestore_online_serving_service_stub.write_feature_values 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