Class: Google::Apis::CloudprivatecatalogV1beta1::CloudPrivateCatalogService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudprivatecatalog_v1beta1/service.rb

Overview

Cloud Private Catalog API

Enable cloud users to discover enterprise catalogs and products in their organizations.

Examples:

require 'google/apis/cloudprivatecatalog_v1beta1'

Cloudprivatecatalog = Google::Apis::CloudprivatecatalogV1beta1 # Alias the module
service = Cloudprivatecatalog::CloudPrivateCatalogService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCloudPrivateCatalogService

Returns a new instance of CloudPrivateCatalogService.


46
47
48
49
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 46

def initialize
  super('https://cloudprivatecatalog.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


39
40
41
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


44
45
46
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#search_folder_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse

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

Parameters:

  • resource (String)

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

    • projects/project_id``
    • folders/folder_id``
    • organizations/organization_id``
  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

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

    • Get a single catalog: name=catalogs/catalog_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


84
85
86
87
88
89
90
91
92
93
94
95
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 84

def search_folder_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_folder_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • 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_id``
    • Get a product by name: name=catalogs/catalog_id/products/product_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


132
133
134
135
136
137
138
139
140
141
142
143
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 132

def search_folder_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_folder_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

    The query to filter the versions. Required. The supported queries are:

    • List versions under a product: parent=catalogs/catalog_id/products/product_id``
    • Get a version by name: name=catalogs/catalog_id/products/product_id/versions/version_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


180
181
182
183
184
185
186
187
188
189
190
191
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 180

def search_folder_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_organization_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse

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

Parameters:

  • resource (String)

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

    • projects/project_id``
    • folders/folder_id``
    • organizations/organization_id``
  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

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

    • Get a single catalog: name=catalogs/catalog_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


226
227
228
229
230
231
232
233
234
235
236
237
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 226

def search_organization_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_organization_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • 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_id``
    • Get a product by name: name=catalogs/catalog_id/products/product_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


274
275
276
277
278
279
280
281
282
283
284
285
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 274

def search_organization_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_organization_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

    The query to filter the versions. Required. The supported queries are:

    • List versions under a product: parent=catalogs/catalog_id/products/product_id``
    • Get a version by name: name=catalogs/catalog_id/products/product_id/versions/version_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


322
323
324
325
326
327
328
329
330
331
332
333
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 322

def search_organization_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse

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

Parameters:

  • resource (String)

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

    • projects/project_id``
    • folders/folder_id``
    • organizations/organization_id``
  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

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

    • Get a single catalog: name=catalogs/catalog_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


368
369
370
371
372
373
374
375
376
377
378
379
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 368

def search_project_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • 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_id``
    • Get a product by name: name=catalogs/catalog_id/products/product_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


416
417
418
419
420
421
422
423
424
425
426
427
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 416

def search_project_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse

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

Parameters:

  • resource (String)

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

  • page_size (Fixnum) (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. This field is optional.

  • query (String) (defaults to: nil)

    The query to filter the versions. Required. The supported queries are:

    • List versions under a product: parent=catalogs/catalog_id/products/product_id``
    • Get a version by name: name=catalogs/catalog_id/products/product_id/versions/version_id``
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


464
465
466
467
468
469
470
471
472
473
474
475
# File 'generated/google/apis/cloudprivatecatalog_v1beta1/service.rb', line 464

def search_project_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options)
  command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation
  command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end