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:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 127

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 == 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

  @private_catalog_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
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:



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

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:



106
107
108
109
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 106

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.

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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 208

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
   = @config.rpcs.search_catalogs..to_h

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 292

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
   = @config.rpcs.search_products..to_h

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
# File 'lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb', line 376

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
   = @config.rpcs.search_versions..to_h

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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