Cloud Private Catalog API . projects . products

Instance Methods

search(resource, pageSize=None, pageToken=None, query=None, x__xgafv=None)

Search Product resources that consumers have access to, within the

search_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

search(resource, pageSize=None, pageToken=None, query=None, x__xgafv=None)
Search Product resources that consumers have access to, within the
scope of the consumer cloud resource hierarchy context.

Args:
  resource: string, Required. The name of the resource context. See
SearchCatalogsRequest.resource for details. (required)
  pageSize: integer, The maximum number of entries that are requested.
  pageToken: string, A pagination token returned from a previous call to SearchProducts that
indicates where this listing should continue from.
This field is optional.
  query: string, 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}`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for PrivateCatalog.SearchProducts.
    "nextPageToken": "A String", # A pagination token returned from a previous call to SearchProducts that
        # indicates from where listing should continue.
        # This field is optional.
    "products": [ # The `Product` resources computed from the resource context.
      { # The readonly representation of a product computed with a given resource
          # context.
        "assetType": "A String", # Output only. The type of the product asset. It can be one of the
            # following values:
            #
            # * `google.deploymentmanager.Template`
            # * `google.cloudprivatecatalog.ListingOnly`
        "updateTime": "A String", # Output only. The time when the product was last updated.
        "name": "A String", # Output only. The resource name of the target product, in the format of
            # `products/a-z*[a-z0-9]'.
            #
            # A unique identifier for the product under a catalog.
        "displayMetadata": { # Output only. The display metadata to describe the product.
            # The JSON schema of the metadata differs by Product.asset_type.
            # When the type is `google.deploymentmanager.Template`, the schema is as
            # follows:
            #
            # ```
            # "$schema": http://json-schema.org/draft-04/schema#
            # type: object
            # properties:
            #   name:
            #     type: string
            #     minLength: 1
            #     maxLength: 64
            #   description:
            #     type: string
            #     minLength: 1
            #     maxLength: 2048
            #   tagline:
            #     type: string
            #     minLength: 1
            #     maxLength: 100
            #   support_info:
            #     type: string
            #     minLength: 1
            #     maxLength: 2048
            #   creator:
            #     type: string
            #     minLength: 1
            #     maxLength: 100
            #   documentation:
            #     type: array
            #     items:
            #       type: object
            #       properties:
            #         url:
            #           type: string
            #           pattern:
            #           "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
            #         title:
            #           type: string
            #           minLength: 1
            #           maxLength: 64
            #         description:
            #           type: string
            #           minLength: 1
            #           maxLength: 2048
            # required:
            # - name
            # - description
            # additionalProperties: false
            #
            # ```
            #
            # When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
            # is as follows:
            #
            # ```
            # "$schema": http://json-schema.org/draft-04/schema#
            # type: object
            # properties:
            #   name:
            #     type: string
            #     minLength: 1
            #     maxLength: 64
            #   description:
            #     type: string
            #     minLength: 1
            #     maxLength: 2048
            #   tagline:
            #     type: string
            #     minLength: 1
            #     maxLength: 100
            #   support_info:
            #     type: string
            #     minLength: 1
            #     maxLength: 2048
            #   creator:
            #     type: string
            #     minLength: 1
            #     maxLength: 100
            #   documentation:
            #     type: array
            #     items:
            #       type: object
            #       properties:
            #         url:
            #           type: string
            #           pattern:
            #           "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
            #         title:
            #           type: string
            #           minLength: 1
            #           maxLength: 64
            #         description:
            #           type: string
            #           minLength: 1
            #           maxLength: 2048
            #   signup_url:
            #     type: string
            #     pattern:
            #     "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
            # required:
            # - name
            # - description
            # - signup_url
            # additionalProperties: false
            # ```
          "a_key": "", # Properties of the object.
        },
        "iconUri": "A String", # Output only. The icon URI of the product.
        "createTime": "A String", # Output only. The time when the product was created.
      },
    ],
  }
search_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.