Class: Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb

Overview

REST client for the PredictionApiKeyRegistry service.

Service for registering API keys for use with the predict method. If you use an API key to request predictions, you must first register the API key. Otherwise, your prediction request is rejected. If you use OAuth to authenticate your predict method call, you do not need to register an API key. You can register up to 20 API keys per project.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#event_store_path, #prediction_api_key_registration_path

Constructor Details

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

Create a new PredictionApiKeyRegistry REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the PredictionApiKeyRegistry client.

Yield Parameters:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 130

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 == Client.configure.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

  @prediction_api_key_registry_stub = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Class Method Details

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

Configure the PredictionApiKeyRegistry Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all PredictionApiKeyRegistry clients
::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "RecommendationEngine", "V1beta1"]
    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.rpcs.create_prediction_api_key_registration.timeout = 600.0
    default_config.rpcs.create_prediction_api_key_registration.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_prediction_api_key_registrations.timeout = 600.0
    default_config.rpcs.list_prediction_api_key_registrations.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_prediction_api_key_registration.timeout = 600.0
    default_config.rpcs.delete_prediction_api_key_registration.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the PredictionApiKeyRegistry 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:



109
110
111
112
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 109

def configure
  yield @config if block_given?
  @config
end

#create_prediction_api_key_registration(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration #create_prediction_api_key_registration(parent: nil, prediction_api_key_registration: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration

Register an API key for use with predict method.

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 187

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::CreatePredictionApiKeyRegistrationRequest

  # 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_prediction_api_key_registration.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::RecommendationEngine::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_prediction_api_key_registration.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_prediction_api_key_registration.retry_policy

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

  @prediction_api_key_registry_stub.create_prediction_api_key_registration 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

#delete_prediction_api_key_registration(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_prediction_api_key_registration(name: nil) ⇒ ::Google::Protobuf::Empty

Unregister an apiKey from using for predict method.

Overloads:

  • #delete_prediction_api_key_registration(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

  • #delete_prediction_api_key_registration(name: nil) ⇒ ::Google::Protobuf::Empty

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

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

      Required. The API key to unregister including full resource path. projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 319

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::DeletePredictionApiKeyRegistrationRequest

  # 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_prediction_api_key_registration.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::RecommendationEngine::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_prediction_api_key_registration.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_prediction_api_key_registration.retry_policy

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

  @prediction_api_key_registry_stub.delete_prediction_api_key_registration 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

#list_prediction_api_key_registrations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration> #list_prediction_api_key_registrations(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration>

List the registered apiKeys for use with predict method.

Overloads:

  • #list_prediction_api_key_registrations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration>

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

    Parameters:

  • #list_prediction_api_key_registrations(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration>

    Pass arguments to list_prediction_api_key_registrations 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) (defaults to: nil) —

      Required. The parent placement resource name such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store

    • page_size (::Integer) (defaults to: nil) —

      Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.

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

      Optional. The previous ListPredictionApiKeyRegistration.nextPageToken.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb', line 255

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::ListPredictionApiKeyRegistrationsRequest

  # 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_prediction_api_key_registrations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::RecommendationEngine::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_prediction_api_key_registrations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_prediction_api_key_registrations.retry_policy

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

  @prediction_api_key_registry_stub.list_prediction_api_key_registrations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @prediction_api_key_registry_stub, :list_prediction_api_key_registrations, "prediction_api_key_registrations", 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