Google Cloud Private Catalog V1beta1 Client - Class Product (0.2.13)

Reference documentation and code samples for the Google Cloud Private Catalog V1beta1 Client class Product.

The readonly representation of a product computed with a given resource context.

Generated from protobuf message google.cloud.privatecatalog.v1beta1.Product

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The resource name of the target product, in the format of `products/[a-z][-a-z0-9]*[a-z0-9]'. A unique identifier for the product under a catalog.
`↳ asset_type`	`string` Output only. The type of the product asset. It can be one of the following values: * `google.deploymentmanager.Template` * `google.cloudprivatecatalog.ListingOnly` * `google.cloudprivatecatalog.Terraform`
`↳ display_metadata`	`Google\Protobuf\Struct` Required. 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 documentations: 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 documentations: 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 When the asset type is `google.cloudprivatecatalog.Terraform`, 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 documentations: 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: true
`↳ icon_uri`	`string` Output only. The icon URI of the product.
`↳ asset_references`	`array<Google\Cloud\PrivateCatalog\V1beta1\AssetReference>` Output only. A collection of assets referred by a product. This field is set for Terraform Products only.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time when the product was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time when the product was last updated.

getName

Output only. The resource name of the target product, in the format of `products/[a-z][-a-z0-9]*[a-z0-9]'.

A unique identifier for the product under a catalog.

Returns
Type	Description
`string`

setName

Output only. The resource name of the target product, in the format of `products/[a-z][-a-z0-9]*[a-z0-9]'.

A unique identifier for the product under a catalog.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAssetType

Output only. The type of the product asset. It can be one of the following values:

google.deploymentmanager.Template
google.cloudprivatecatalog.ListingOnly
google.cloudprivatecatalog.Terraform

Returns
Type	Description
`string`

setAssetType

Output only. The type of the product asset. It can be one of the following values:

google.deploymentmanager.Template
google.cloudprivatecatalog.ListingOnly
google.cloudprivatecatalog.Terraform

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayMetadata

Required. 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
  documentations:
    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
  documentations:
    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

When the asset type is google.cloudprivatecatalog.Terraform, 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
  documentations:
    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: true

Returns
Type	Description
`Google\Protobuf\Struct\|null`

hasDisplayMetadata

clearDisplayMetadata

setDisplayMetadata

Required. 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
  documentations:
    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
  documentations:
    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

When the asset type is google.cloudprivatecatalog.Terraform, 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
  documentations:
    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: true

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getIconUri

Output only. The icon URI of the product.

Returns
Type	Description
`string`

setIconUri

Output only. The icon URI of the product.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAssetReferences

Output only. A collection of assets referred by a product.

This field is set for Terraform Products only.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAssetReferences

Output only. A collection of assets referred by a product.

This field is set for Terraform Products only.

Parameter
Name	Description
`var`	`array<Google\Cloud\PrivateCatalog\V1beta1\AssetReference>`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the product was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the product was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time when the product was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the product was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`