As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Privatecatalog v1beta1 API

class google.cloud.privatecatalog_v1beta1.types.AssetReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Defines the reference of an asset belonging to a product.

id

Output only. A unique identifier among asset references in a product.

Type

str

description

Output only. The human-readable description of the referenced asset. Maximum 256 characters in length.

Type

str

inputs

Output only. The definition of input parameters to hydrate the asset template.

Type

google.cloud.privatecatalog_v1beta1.types.Inputs

validation_status

Output only. The current state of the asset reference.

Type

google.cloud.privatecatalog_v1beta1.types.AssetReference.AssetValidationState

validation_operation

Output only. The validation process metadata.

Type

google.longrunning.operations_pb2.Operation

asset

Output only. The asset resource name if an asset is hosted by Private Catalog.

Type

str

gcs_path

Output only. The cloud storage object path.

Type

str

git_source

Output only. The git source.

Type

google.cloud.privatecatalog_v1beta1.types.GitSource

gcs_source

Output only. The cloud storage source.

Type

google.cloud.privatecatalog_v1beta1.types.GcsSource

create_time

Output only. The creation timestamp of the asset reference.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The last update timestamp of the asset reference.

Type

google.protobuf.timestamp_pb2.Timestamp

version

The version of the source used for this asset reference.

Type

str

class AssetValidationState(value)[source]

Bases: proto.enums.Enum

Possible validation steates of an asset reference.

ASSET_VALIDATION_STATE_UNSPECIFIED = 0
INVALID = 3
PENDING = 1
VALID = 2
class google.cloud.privatecatalog_v1beta1.types.Catalog(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

name

Output only. The resource name of the target catalog, in the format of `catalogs/{catalog}’.

Type

str

display_name

Output only. The descriptive name of the catalog as it appears in UIs.

Type

str

description

Output only. The description of the catalog.

Type

str

create_time

Output only. The time when the catalog was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.privatecatalog_v1beta1.types.GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Defines how to access Cloud Storage source.

gcs_path

Output only. the cloud storage object path.

Type

str

generation

Output only. Generation of the object, which is set when the content of an object starts being written.

Type

int

update_time

Output only. The time when the object metadata was last changed.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.privatecatalog_v1beta1.types.GitSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Defines how to access a Git Source.

repo

Location of the Git repo to build.

Type

str

dir_

Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step’s dir is specified and is an absolute path, this value is ignored for that step’s execution.

Type

str

commit

The revision commit to use.

Type

str

branch

The revision branch to use.

Type

str

tag

The revision tag to use.

Type

str

class google.cloud.privatecatalog_v1beta1.types.Inputs(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Defines definition of input parameters of asset templates.

parameters

Output only. The JSON schema defining the inputs and their formats.

Type

google.protobuf.struct_pb2.Struct

class google.cloud.privatecatalog_v1beta1.types.Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

name

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.

Type

str

asset_type

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

Type

str

display_metadata

Required. Output only. The display metadata to describe the product. The JSON schema of the metadata differs by [Product.asset_type][google.cloud.privatecatalog.v1beta1.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
Type

google.protobuf.struct_pb2.Struct

icon_uri

Output only. The icon URI of the product.

Type

str

asset_references

Output only. A collection of assets referred by a product. This field is set for Terraform Products only.

Type

Sequence[google.cloud.privatecatalog_v1beta1.types.AssetReference]

create_time

Output only. The time when the product was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs].

resource

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

  • projects/{project}

  • folders/{folder}

  • organizations/{organization}

Type

str

query

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

  • Get a single catalog: name=catalogs/{catalog}

Type

str

page_size

The maximum number of entries that are requested.

Type

int

page_token

A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from.

Type

str

class google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs].

catalogs

The Catalogs computed from the resource context.

Type

Sequence[google.cloud.privatecatalog_v1beta1.types.Catalog]

next_page_token

A pagination token returned from a previous call to SearchCatalogs that indicates from where listing should continue.

Type

str

property raw_page
class google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts].

resource

Required. The name of the resource context. See [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource] for details.

Type

str

query

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}

Type

str

page_size

The maximum number of entries that are requested.

Type

int

page_token

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

Type

str

class google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts].

products

The Product resources computed from the resource context.

Type

Sequence[google.cloud.privatecatalog_v1beta1.types.Product]

next_page_token

A pagination token returned from a previous call to SearchProducts that indicates from where listing should continue.

Type

str

property raw_page
class google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions].

resource

Required. The name of the resource context. See [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource] for details.

Type

str

query

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}

Type

str

page_size

The maximum number of entries that are requested.

Type

int

page_token

A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from.

Type

str

class google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions].

versions

The Version resources computed from the resource context.

Type

Sequence[google.cloud.privatecatalog_v1beta1.types.Version]

next_page_token

A pagination token returned from a previous call to SearchVersions that indicates from where the listing should continue.

Type

str

property raw_page
class google.cloud.privatecatalog_v1beta1.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The consumer representation of a version which is a child resource under a Product with asset data.

name

Output only. The resource name of the version, in the format `catalogs/{catalog}/products/{product}/versions/[a-z][-a-z0-9]*[a-z0-9]’.

A unique identifier for the version under a product.

Type

str

description

Output only. The user-supplied description of the version. Maximum of 256 characters.

Type

str

asset

Output only. The asset which has been validated and is ready to be provisioned. See [google.cloud.privatecatalogproducer.v1beta.Version.asset][] for details.

Type

google.protobuf.struct_pb2.Struct

create_time

Output only. The time when the version was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp