Google Cloud Commerce Producer V1beta Client - Class PrivateOfferDocument (0.2.0)

Reference documentation and code samples for the Google Cloud Commerce Producer V1beta Client class PrivateOfferDocument.

Message describing the PrivateOfferDocument resource.

Used to attach documents to a private offer in state DRAFT. Once a private offer is no longer in state DRAFT, the set of child documents is immutable. Existing documents cannot be updated or deleted, and new documents cannot be added. A private offer may have at most one document of each type, and may not have both a standard EULA and a custom EULA. Which document types are required, optional, or not permitted depends on the service the offer is for, and is returned in Service.document_requirement.

Generated from protobuf message google.cloud.commerceproducer.v1beta.PrivateOfferDocument

Namespace

Google \ Cloud \ CommerceProducer \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ inline_content`	`string` Optional. Byte content of an unstructured document. Max size: 4MB
`↳ name`	`string` Identifier. Name of the resource.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The creation time of the resource.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The last update time of the resource.
`↳ document_type`	`int` Required. The classification type of the document. Used to distinguish between different types of documents that may be attached to a private offer for different business purposes.
`↳ mime_type`	`string` Optional. The MIME type of the document. Used to distinguish between different document formats. Supported formats (which may be expanded in the future) - 'application/pdf'

getInlineContent

Optional. Byte content of an unstructured document.

Max size: 4MB

Returns
Type	Description
`string`

hasInlineContent

setInlineContent

Optional. Byte content of an unstructured document.

Max size: 4MB

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

Identifier. Name of the resource.

Returns
Type	Description
`string`

setName

Identifier. Name of the resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation time of the resource.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time of the resource.

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

Returns
Type	Description
`$this`

getUpdateTime

Output only. The last update time of the resource.

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

hasUpdateTime

clearUpdateTime

setUpdateTime