Class PrivateOfferDocument (0.1.0)

public final class PrivateOfferDocument extends GeneratedMessage implements PrivateOfferDocumentOrBuilder

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 must include a EULA, either by assigning a standard EULA or attaching a custom EULA document, or a statement of work document.

Protobuf type google.cloud.commerceproducer.v1beta.PrivateOfferDocument

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_TYPE_FIELD_NUMBER

public static final int DOCUMENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

INLINE_CONTENT_FIELD_NUMBER

public static final int INLINE_CONTENT_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateOfferDocument getDefaultInstance()
Returns
Type Description
PrivateOfferDocument

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PrivateOfferDocument.Builder newBuilder()
Returns
Type Description
PrivateOfferDocument.Builder

newBuilder(PrivateOfferDocument prototype)

public static PrivateOfferDocument.Builder newBuilder(PrivateOfferDocument prototype)
Parameter
Name Description
prototype PrivateOfferDocument
Returns
Type Description
PrivateOfferDocument.Builder

parseDelimitedFrom(InputStream input)

public static PrivateOfferDocument parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PrivateOfferDocument parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PrivateOfferDocument parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PrivateOfferDocument parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PrivateOfferDocument parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PrivateOfferDocument parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PrivateOfferDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PrivateOfferDocument> parser()
Returns
Type Description
Parser<PrivateOfferDocument>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContentCase()

public PrivateOfferDocument.ContentCase getContentCase()
Returns
Type Description
PrivateOfferDocument.ContentCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PrivateOfferDocument getDefaultInstanceForType()
Returns
Type Description
PrivateOfferDocument

getDocumentType()

public PrivateOfferDocument.DocumentType getDocumentType()

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.

.google.cloud.commerceproducer.v1beta.PrivateOfferDocument.DocumentType document_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PrivateOfferDocument.DocumentType

The documentType.

getDocumentTypeValue()

public int getDocumentTypeValue()

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.

.google.cloud.commerceproducer.v1beta.PrivateOfferDocument.DocumentType document_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for documentType.

getInlineContent()

public ByteString getInlineContent()

Optional. Byte content of an unstructured document. Max size: 4MB

bytes inline_content = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The inlineContent.

getMimeType()

public String getMimeType()

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'

string mime_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

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'

string mime_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for mimeType.

getName()

public String getName()

Identifier. Name of the resource.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the resource.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PrivateOfferDocument> getParserForType()
Returns
Type Description
Parser<PrivateOfferDocument>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update time of the resource.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update time of the resource.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time of the resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasInlineContent()

public boolean hasInlineContent()

Optional. Byte content of an unstructured document. Max size: 4MB

bytes inline_content = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inlineContent field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update time of the resource.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrivateOfferDocument.Builder newBuilderForType()
Returns
Type Description
PrivateOfferDocument.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PrivateOfferDocument.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrivateOfferDocument.Builder
Overrides

toBuilder()

public PrivateOfferDocument.Builder toBuilder()
Returns
Type Description
PrivateOfferDocument.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException