Cloud Private Catalog Producer API . catalogs . products . versions

Instance Methods

create(parent, body, x__xgafv=None)

Creates a Version instance under a given Product.

delete(name, x__xgafv=None)

Hard deletes a Version.

get(name, x__xgafv=None)

Returns the requested Version resource.

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

Lists Version 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 Version resource.

Method Details

create(parent, body, x__xgafv=None)
Creates a Version instance under a given Product.

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

{ # The producer representation of a version, which is a child resource under a
      # `Product` with asset data.
    "updateTime": "A String", # Output only. The time when the version was last updated.
    "name": "A String", # Required. The resource name of the version, in the format
        # `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.
        # 
        # A unique identifier for the version under a product, which can't
        # be changed after the version is created. The final segment of the name must
        # between 1 and 63 characters in length.
    "originalAsset": { # The user-supplied asset payload. The maximum size of the payload is 2MB.
        # The JSON schema of the payload is defined as:
        # 
        # ```
        # type: object
        # properties:
        #   mainTemplate:
        #     type: string
        #     description: The file name of the main template and name prefix of
        #     schema file. The content of the main template should be set in the
        #     imports list. The schema file name is expected to be
        #     .schema in the imports list. required: true
        #   imports:
        #     type: array
        #     description: Import template and schema file contents. Required to have
        #     both  and .schema files. required: true
        #     minItems: 2
        #     items:
        #       type: object
        #       properties:
        #         name:
        #           type: string
        #         content:
        #           type: string
        # ```
      "a_key": "", # Properties of the object.
    },
    "asset": { # Output only. The asset which has been validated and is ready to be
        # provisioned. See Version.original_asset for the schema.
      "a_key": "", # Properties of the object.
    },
    "createTime": "A String", # Output only. The time when the version was created.
    "description": "A String", # The user-supplied description of the version. Maximum of 256 characters.
  }

  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.
    },
  }
delete(name, x__xgafv=None)
Hard deletes a Version.

Args:
  name: string, The resource name of the version. (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 Version resource.

Args:
  name: string, The resource name of the version. (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 version, which is a child resource under a
        # `Product` with asset data.
      "updateTime": "A String", # Output only. The time when the version was last updated.
      "name": "A String", # Required. The resource name of the version, in the format
          # `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.
          #
          # A unique identifier for the version under a product, which can't
          # be changed after the version is created. The final segment of the name must
          # between 1 and 63 characters in length.
      "originalAsset": { # The user-supplied asset payload. The maximum size of the payload is 2MB.
          # The JSON schema of the payload is defined as:
          #
          # ```
          # type: object
          # properties:
          #   mainTemplate:
          #     type: string
          #     description: The file name of the main template and name prefix of
          #     schema file. The content of the main template should be set in the
          #     imports list. The schema file name is expected to be
          #     .schema in the imports list. required: true
          #   imports:
          #     type: array
          #     description: Import template and schema file contents. Required to have
          #     both  and .schema files. required: true
          #     minItems: 2
          #     items:
          #       type: object
          #       properties:
          #         name:
          #           type: string
          #         content:
          #           type: string
          # ```
        "a_key": "", # Properties of the object.
      },
      "asset": { # Output only. The asset which has been validated and is ready to be
          # provisioned. See Version.original_asset for the schema.
        "a_key": "", # Properties of the object.
      },
      "createTime": "A String", # Output only. The time when the version was created.
      "description": "A String", # The user-supplied description of the version. Maximum of 256 characters.
    }
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Version resources that the producer has access to, within the
scope of the parent Product.

Args:
  parent: string, The resource name of the parent resource. (required)
  pageSize: integer, The maximum number of versions to return.
  pageToken: string, A pagination token returned from a previous call to ListVersions
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

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.
    "versions": [ # The `VersiVersionon` returned from the list call.
      { # The producer representation of a version, which is a child resource under a
            # `Product` with asset data.
          "updateTime": "A String", # Output only. The time when the version was last updated.
          "name": "A String", # Required. The resource name of the version, in the format
              # `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.
              #
              # A unique identifier for the version under a product, which can't
              # be changed after the version is created. The final segment of the name must
              # between 1 and 63 characters in length.
          "originalAsset": { # The user-supplied asset payload. The maximum size of the payload is 2MB.
              # The JSON schema of the payload is defined as:
              #
              # ```
              # type: object
              # properties:
              #   mainTemplate:
              #     type: string
              #     description: The file name of the main template and name prefix of
              #     schema file. The content of the main template should be set in the
              #     imports list. The schema file name is expected to be
              #     .schema in the imports list. required: true
              #   imports:
              #     type: array
              #     description: Import template and schema file contents. Required to have
              #     both  and .schema files. required: true
              #     minItems: 2
              #     items:
              #       type: object
              #       properties:
              #         name:
              #           type: string
              #         content:
              #           type: string
              # ```
            "a_key": "", # Properties of the object.
          },
          "asset": { # Output only. The asset which has been validated and is ready to be
              # provisioned. See Version.original_asset for the schema.
            "a_key": "", # Properties of the object.
          },
          "createTime": "A String", # Output only. The time when the version was created.
          "description": "A String", # The user-supplied description of the version. Maximum of 256 characters.
        },
    ],
  }
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 Version resource.

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

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

{ # The producer representation of a version, which is a child resource under a
      # `Product` with asset data.
    "updateTime": "A String", # Output only. The time when the version was last updated.
    "name": "A String", # Required. The resource name of the version, in the format
        # `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.
        # 
        # A unique identifier for the version under a product, which can't
        # be changed after the version is created. The final segment of the name must
        # between 1 and 63 characters in length.
    "originalAsset": { # The user-supplied asset payload. The maximum size of the payload is 2MB.
        # The JSON schema of the payload is defined as:
        # 
        # ```
        # type: object
        # properties:
        #   mainTemplate:
        #     type: string
        #     description: The file name of the main template and name prefix of
        #     schema file. The content of the main template should be set in the
        #     imports list. The schema file name is expected to be
        #     .schema in the imports list. required: true
        #   imports:
        #     type: array
        #     description: Import template and schema file contents. Required to have
        #     both  and .schema files. required: true
        #     minItems: 2
        #     items:
        #       type: object
        #       properties:
        #         name:
        #           type: string
        #         content:
        #           type: string
        # ```
      "a_key": "", # Properties of the object.
    },
    "asset": { # Output only. The asset which has been validated and is ready to be
        # provisioned. See Version.original_asset for the schema.
      "a_key": "", # Properties of the object.
    },
    "createTime": "A String", # Output only. The time when the version was created.
    "description": "A String", # The user-supplied description of the version. Maximum of 256 characters.
  }

  updateMask: string, Field mask that controls which fields of the version 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 version, which is a child resource under a
        # `Product` with asset data.
      "updateTime": "A String", # Output only. The time when the version was last updated.
      "name": "A String", # Required. The resource name of the version, in the format
          # `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'.
          #
          # A unique identifier for the version under a product, which can't
          # be changed after the version is created. The final segment of the name must
          # between 1 and 63 characters in length.
      "originalAsset": { # The user-supplied asset payload. The maximum size of the payload is 2MB.
          # The JSON schema of the payload is defined as:
          #
          # ```
          # type: object
          # properties:
          #   mainTemplate:
          #     type: string
          #     description: The file name of the main template and name prefix of
          #     schema file. The content of the main template should be set in the
          #     imports list. The schema file name is expected to be
          #     .schema in the imports list. required: true
          #   imports:
          #     type: array
          #     description: Import template and schema file contents. Required to have
          #     both  and .schema files. required: true
          #     minItems: 2
          #     items:
          #       type: object
          #       properties:
          #         name:
          #           type: string
          #         content:
          #           type: string
          # ```
        "a_key": "", # Properties of the object.
      },
      "asset": { # Output only. The asset which has been validated and is ready to be
          # provisioned. See Version.original_asset for the schema.
        "a_key": "", # Properties of the object.
      },
      "createTime": "A String", # Output only. The time when the version was created.
      "description": "A String", # The user-supplied description of the version. Maximum of 256 characters.
    }