Cloud Private Catalog Producer API . catalogs . products

Instance Methods

icons()

Returns the icons Resource.

versions()

Returns the versions Resource.

copy(name, body, x__xgafv=None)

Copies a Product under another Catalog.

create(parent, body, x__xgafv=None)

Creates a Product instance under a given Catalog.

delete(name, x__xgafv=None)

Hard deletes a Product.

get(name, x__xgafv=None)

Returns the requested Product resource.

list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)

Lists Product resources that the producer has access to, within the

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body, updateMask=None, x__xgafv=None)

Updates a specific Product resource.

Method Details

copy(name, body, x__xgafv=None)
Copies a Product under another Catalog.

Args:
  name: string, The resource name of the current product that is copied from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "destinationProductName": "A String", # The resource name of the destination product that is copied to.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
create(parent, body, x__xgafv=None)
Creates a Product instance under a given Catalog.

Args:
  parent: string, The catalog name of the new product's parent. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The producer representation of a product which is a child resource of
    # `Catalog` with display metadata and a list of `Version` resources.
  "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
      # product is created. It supports the values
      # `google.deploymentmanager.Template` and
      # `google.cloudprivatecatalog.ListingOnly`. Other values will be
      # rejected by the server. Read only after creation.
      # 
      # The following fields or resource types have different validation rules
      # under each `asset_type` values:
      # 
      # * Product.display_metadata has different validation schema for each
      # asset type value. See its comment for details.
      # * Version resource isn't allowed to be added under the
      # `google.cloudprivatecatalog.ListingOnly` type.
  "updateTime": "A String", # Output only. The time when the product was last updated.
  "name": "A String", # Required. The resource name of the product in the format
      # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
      # 
      # A unique identifier for the product under a catalog, which cannot
      # be changed after the product is created. The final
      # segment of the name must between 1 and 256 characters in length.
  "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
      # PrivateCatalogProducer.UploadIcon.
      # 
      # If no icon is uploaded, it will be the default icon's URI.
  "createTime": "A String", # Output only. The time when the product was created.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The producer representation of a product which is a child resource of
      # `Catalog` with display metadata and a list of `Version` resources.
    "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
        # product is created. It supports the values
        # `google.deploymentmanager.Template` and
        # `google.cloudprivatecatalog.ListingOnly`. Other values will be
        # rejected by the server. Read only after creation.
        #
        # The following fields or resource types have different validation rules
        # under each `asset_type` values:
        #
        # * Product.display_metadata has different validation schema for each
        # asset type value. See its comment for details.
        # * Version resource isn't allowed to be added under the
        # `google.cloudprivatecatalog.ListingOnly` type.
    "updateTime": "A String", # Output only. The time when the product was last updated.
    "name": "A String", # Required. The resource name of the product in the format
        # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
        #
        # A unique identifier for the product under a catalog, which cannot
        # be changed after the product is created. The final
        # segment of the name must between 1 and 256 characters in length.
    "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
        # PrivateCatalogProducer.UploadIcon.
        #
        # If no icon is uploaded, it will be the default icon's URI.
    "createTime": "A String", # Output only. The time when the product was created.
  }
delete(name, x__xgafv=None)
Hard deletes a Product.

Args:
  name: string, The resource name of the product. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None)
Returns the requested Product resource.

Args:
  name: string, The resource name of the product. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The producer representation of a product which is a child resource of
      # `Catalog` with display metadata and a list of `Version` resources.
    "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
        # product is created. It supports the values
        # `google.deploymentmanager.Template` and
        # `google.cloudprivatecatalog.ListingOnly`. Other values will be
        # rejected by the server. Read only after creation.
        #
        # The following fields or resource types have different validation rules
        # under each `asset_type` values:
        #
        # * Product.display_metadata has different validation schema for each
        # asset type value. See its comment for details.
        # * Version resource isn't allowed to be added under the
        # `google.cloudprivatecatalog.ListingOnly` type.
    "updateTime": "A String", # Output only. The time when the product was last updated.
    "name": "A String", # Required. The resource name of the product in the format
        # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
        #
        # A unique identifier for the product under a catalog, which cannot
        # be changed after the product is created. The final
        # segment of the name must between 1 and 256 characters in length.
    "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
        # PrivateCatalogProducer.UploadIcon.
        #
        # If no icon is uploaded, it will be the default icon's URI.
    "createTime": "A String", # Output only. The time when the product was created.
  }
list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)
Lists Product resources that the producer has access to, within the
scope of the parent catalog.

Args:
  parent: string, The resource name of the parent resource. (required)
  pageToken: string, A pagination token returned from a previous call to ListProducts
that indicates where this listing should continue from.
This field is optional.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, The maximum number of products to return.
  filter: string, A filter expression used to restrict the returned results based
upon properties of the product.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A pagination token returned from a previous call to ListProducts
        # that indicates where the listing should continue from.
        # This field is optional.
    "products": [ # The `Product` returned from the list call.
      { # The producer representation of a product which is a child resource of
          # `Catalog` with display metadata and a list of `Version` resources.
        "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
            # product is created. It supports the values
            # `google.deploymentmanager.Template` and
            # `google.cloudprivatecatalog.ListingOnly`. Other values will be
            # rejected by the server. Read only after creation.
            #
            # The following fields or resource types have different validation rules
            # under each `asset_type` values:
            #
            # * Product.display_metadata has different validation schema for each
            # asset type value. See its comment for details.
            # * Version resource isn't allowed to be added under the
            # `google.cloudprivatecatalog.ListingOnly` type.
        "updateTime": "A String", # Output only. The time when the product was last updated.
        "name": "A String", # Required. The resource name of the product in the format
            # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
            #
            # A unique identifier for the product under a catalog, which cannot
            # be changed after the product is created. The final
            # segment of the name must between 1 and 256 characters in length.
        "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
            # PrivateCatalogProducer.UploadIcon.
            #
            # If no icon is uploaded, it will be the default icon's URI.
        "createTime": "A String", # Output only. The time when the product was created.
      },
    ],
  }
list_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.
    
patch(name, body, updateMask=None, x__xgafv=None)
Updates a specific Product resource.

Args:
  name: string, Required. The resource name of the product in the format
`catalogs/{catalog_id}/products/a-z*[a-z0-9]'.

A unique identifier for the product under a catalog, which cannot
be changed after the product is created. The final
segment of the name must between 1 and 256 characters in length. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The producer representation of a product which is a child resource of
    # `Catalog` with display metadata and a list of `Version` resources.
  "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
      # product is created. It supports the values
      # `google.deploymentmanager.Template` and
      # `google.cloudprivatecatalog.ListingOnly`. Other values will be
      # rejected by the server. Read only after creation.
      # 
      # The following fields or resource types have different validation rules
      # under each `asset_type` values:
      # 
      # * Product.display_metadata has different validation schema for each
      # asset type value. See its comment for details.
      # * Version resource isn't allowed to be added under the
      # `google.cloudprivatecatalog.ListingOnly` type.
  "updateTime": "A String", # Output only. The time when the product was last updated.
  "name": "A String", # Required. The resource name of the product in the format
      # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
      # 
      # A unique identifier for the product under a catalog, which cannot
      # be changed after the product is created. The final
      # segment of the name must between 1 and 256 characters in length.
  "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
      # PrivateCatalogProducer.UploadIcon.
      # 
      # If no icon is uploaded, it will be the default icon's URI.
  "createTime": "A String", # Output only. The time when the product was created.
}

  updateMask: string, Field mask that controls which fields of the product should be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The producer representation of a product which is a child resource of
      # `Catalog` with display metadata and a list of `Version` resources.
    "assetType": "A String", # Required. The type of the product asset, which cannot be changed after the
        # product is created. It supports the values
        # `google.deploymentmanager.Template` and
        # `google.cloudprivatecatalog.ListingOnly`. Other values will be
        # rejected by the server. Read only after creation.
        #
        # The following fields or resource types have different validation rules
        # under each `asset_type` values:
        #
        # * Product.display_metadata has different validation schema for each
        # asset type value. See its comment for details.
        # * Version resource isn't allowed to be added under the
        # `google.cloudprivatecatalog.ListingOnly` type.
    "updateTime": "A String", # Output only. The time when the product was last updated.
    "name": "A String", # Required. The resource name of the product in the format
        # `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.
        #
        # A unique identifier for the product under a catalog, which cannot
        # be changed after the product is created. The final
        # segment of the name must between 1 and 256 characters in length.
    "displayMetadata": { # The user-supplied 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 public accessible URI of the icon uploaded by
        # PrivateCatalogProducer.UploadIcon.
        #
        # If no icon is uploaded, it will be the default icon's URI.
    "createTime": "A String", # Output only. The time when the product was created.
  }