Class: Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client

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

Overview

Client for the CatalogService service.

Service for ingesting catalog information of the customer's website.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#catalog_item_path_path, #catalog_path

Constructor Details

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

Create a new CatalogService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CatalogService client.

Yield Parameters:



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 154

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/recommendationengine/v1beta1/catalog_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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @catalog_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::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
  )

  @catalog_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
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



217
218
219
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 217

def operations_client
  @operations_client
end

Class Method Details

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

Configure the CatalogService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CatalogService clients
::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/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_catalog_item.timeout = 600.0
    default_config.rpcs.create_catalog_item.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

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

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

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

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

    default_config.rpcs.import_catalog_items.timeout = 600.0
    default_config.rpcs.import_catalog_items.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 CatalogService 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:



124
125
126
127
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 124

def configure
  yield @config if block_given?
  @config
end

#create_catalog_item(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem #create_catalog_item(parent: nil, catalog_item: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Creates a catalog item.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest.new

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

# The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
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.



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
309
310
311
312
313
314
315
316
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 277

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

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

  # 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.create_catalog_item.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::RecommendationEngine::V1beta1::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.parent
    header_params["parent"] = request.parent
  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.create_catalog_item.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_catalog_item.retry_policy

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

  @catalog_service_stub.call_rpc :create_catalog_item, 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

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

Deletes a catalog item.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest, ::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.

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

    Pass arguments to delete_catalog_item 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. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 641

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

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

  # 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.delete_catalog_item.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::RecommendationEngine::V1beta1::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.name
    header_params["name"] = request.name
  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.delete_catalog_item.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_catalog_item.retry_policy

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

  @catalog_service_stub.call_rpc :delete_catalog_item, 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

#get_catalog_item(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem #get_catalog_item(name: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Gets a specific catalog item.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest.new

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

# The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
p result

Overloads:

  • #get_catalog_item(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

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

    Parameters:

    • request (::Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest, ::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.

  • #get_catalog_item(name: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

    Pass arguments to get_catalog_item 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. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



363
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
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 363

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

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

  # 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.get_catalog_item.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::RecommendationEngine::V1beta1::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.name
    header_params["name"] = request.name
  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.get_catalog_item.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_catalog_item.retry_policy

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

  @catalog_service_stub.call_rpc :get_catalog_item, 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

#import_catalog_items(request, options = nil) ⇒ ::Gapic::Operation #import_catalog_items(parent: nil, request_id: nil, input_config: nil, errors_config: nil) ⇒ ::Gapic::Operation

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest.new

# Call the import_catalog_items method.
result = client.import_catalog_items 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

Overloads:

  • #import_catalog_items(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest, ::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.

  • #import_catalog_items(parent: nil, request_id: nil, input_config: nil, errors_config: nil) ⇒ ::Gapic::Operation

    Pass arguments to import_catalog_items 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. projects/1234/locations/global/catalogs/default_catalog

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

      Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.

    • input_config (::Google::Cloud::RecommendationEngine::V1beta1::InputConfig, ::Hash) (defaults to: nil) —

      Required. The desired input location of the data.

    • errors_config (::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig, ::Hash) (defaults to: nil) —

      Optional. The desired location of errors incurred during the Import.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 747

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

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

  # 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.import_catalog_items.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::RecommendationEngine::V1beta1::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.parent
    header_params["parent"] = request.parent
  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.import_catalog_items.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.import_catalog_items.retry_policy

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

  @catalog_service_stub.call_rpc :import_catalog_items, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_catalog_items(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem> #list_catalog_items(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>

Gets a list of catalog items.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest.new

# Call the list_catalog_items method.
result = client.list_catalog_items 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::RecommendationEngine::V1beta1::CatalogItem.
  p item
end

Overloads:

  • #list_catalog_items(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>

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

    Parameters:

    • request (::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest, ::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.

  • #list_catalog_items(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>

    Pass arguments to list_catalog_items 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 catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

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

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

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

      Optional. The previous ListCatalogItemsResponse.next_page_token.

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

      Optional. A filter to apply on the list results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 460

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

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

  # 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.list_catalog_items.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::RecommendationEngine::V1beta1::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.parent
    header_params["parent"] = request.parent
  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.list_catalog_items.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_catalog_items.retry_policy

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

  @catalog_service_stub.call_rpc :list_catalog_items, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_catalog_items, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  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) 


224
225
226
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 224

def logger
  @catalog_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


134
135
136
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 134

def universe_domain
  @catalog_service_stub.universe_domain
end

#update_catalog_item(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem #update_catalog_item(name: nil, catalog_item: nil, update_mask: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Examples:

Basic example

require "google/cloud/recommendation_engine/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest.new

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

# The returned object is of type Google::Cloud::RecommendationEngine::V1beta1::CatalogItem.
p result

Overloads:

  • #update_catalog_item(request, options = nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

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

    Parameters:

    • request (::Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest, ::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.

  • #update_catalog_item(name: nil, catalog_item: nil, update_mask: nil) ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

    Pass arguments to update_catalog_item 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. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

    • catalog_item (::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem, ::Hash) (defaults to: nil) —

      Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb', line 555

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

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

  # 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.update_catalog_item.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::RecommendationEngine::V1beta1::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.name
    header_params["name"] = request.name
  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.update_catalog_item.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_catalog_item.retry_policy

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

  @catalog_service_stub.call_rpc :update_catalog_item, 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