Class: Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb

Overview

Client for the PrivateCatalog service.

PrivateCatalog allows catalog consumers to retrieve Catalog, Product and Version resources under a target resource context.

Catalog is computed based on the [Association][]s linked to the target resource and its ancestors. Each association's [google.cloud.privatecatalogproducer.v1beta.Catalog][] is transformed into a Catalog. If multiple associations have the same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], they are de-duplicated into one Catalog. Users must have cloudprivatecatalog.catalogTargets.get IAM permission on the resource context in order to access catalogs. Catalog contains the resource name and a subset of data of the original [google.cloud.privatecatalogproducer.v1beta.Catalog][].

Product is child resource of the catalog. A Product contains the resource name and a subset of the data of the original [google.cloud.privatecatalogproducer.v1beta.Product][].

Version is child resource of the product. A Version contains the resource name and a subset of the data of the original [google.cloud.privatecatalogproducer.v1beta.Version][].

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new PrivateCatalog client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the PrivateCatalog client.

Yield Parameters:



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

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/privatecatalog/v1beta1/private_catalog_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

  @private_catalog_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::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
  )
end

Class Method Details

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

Configure the PrivateCatalog Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 77

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "PrivateCatalog", "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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the PrivateCatalog 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/private_catalog/v1beta1/private_catalog/client.rb', line 109

def configure
  yield @config if block_given?
  @config
end

#search_catalogs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Catalog> #search_catalogs(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Catalog>

Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Examples:

Basic example

require "google/cloud/private_catalog/v1beta1"

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

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

# Call the search_catalogs method.
result = client.search_catalogs 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::PrivateCatalog::V1beta1::Catalog.
  p item
end

Overloads:

  • #search_catalogs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Catalog>

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

    Parameters:

    • request (::Google::Cloud::PrivateCatalog::V1beta1::SearchCatalogsRequest, ::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_catalogs(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Catalog>

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

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

      Required. The name of the resource context. It can be in following formats:

      • projects/{project}
      • folders/{folder}
      • organizations/{organization}
    • query (::String) (defaults to: nil) —

      The query to filter the catalogs. The supported queries are:

      • Get a single catalog: name=catalogs/{catalog}
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of entries that are requested.

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

      A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



243
244
245
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
281
282
283
 
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 243

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PrivateCatalog::V1beta1::SearchCatalogsRequest

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

  # Set x-goog-api-client and x-goog-user-project 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::PrivateCatalog::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  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_catalogs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_catalogs.retry_policy

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

  @private_catalog_stub.call_rpc :search_catalogs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @private_catalog_stub, :search_catalogs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_products(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Product> #search_products(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Product>

Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Examples:

Basic example

require "google/cloud/private_catalog/v1beta1"

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

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

# Call the search_products method.
result = client.search_products 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::PrivateCatalog::V1beta1::Product.
  p item
end

Overloads:

  • #search_products(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Product>

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

    Parameters:

    • request (::Google::Cloud::PrivateCatalog::V1beta1::SearchProductsRequest, ::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_products(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Product>

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

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

      Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

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

      The query to filter the products.

      The supported queries are:

      • List products of all catalogs: empty
      • List products under a catalog: parent=catalogs/{catalog}
      • Get a product by name: name=catalogs/{catalog}/products/{product}
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of entries that are requested.

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

      A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PrivateCatalog::V1beta1::SearchProductsRequest

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

  # Set x-goog-api-client and x-goog-user-project 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::PrivateCatalog::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  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_products.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_products.retry_policy

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

  @private_catalog_stub.call_rpc :search_products, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @private_catalog_stub, :search_products, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_versions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Version> #search_versions(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Version>

Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Examples:

Basic example

require "google/cloud/private_catalog/v1beta1"

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

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

# Call the search_versions method.
result = client.search_versions 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::PrivateCatalog::V1beta1::Version.
  p item
end

Overloads:

  • #search_versions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Version>

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

    Parameters:

    • request (::Google::Cloud::PrivateCatalog::V1beta1::SearchVersionsRequest, ::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_versions(resource: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Version>

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

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

      Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

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

      Required. The query to filter the versions.

      The supported queries are:

      • List versions under a product: parent=catalogs/{catalog}/products/{product}
      • Get a version by name: name=catalogs/{catalog}/products/{product}/versions/{version}
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of entries that are requested.

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

      A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 453

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PrivateCatalog::V1beta1::SearchVersionsRequest

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

  # Set x-goog-api-client and x-goog-user-project 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::PrivateCatalog::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  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_versions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_versions.retry_policy

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

  @private_catalog_stub.call_rpc :search_versions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @private_catalog_stub, :search_versions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 119

def universe_domain
  @private_catalog_stub.universe_domain
end