Class PrivateOfferDocument.Builder (0.1.0)

public static final class PrivateOfferDocument.Builder extends GeneratedMessage.Builder<PrivateOfferDocument.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public PrivateOfferDocument build()
Returns
Type Description
PrivateOfferDocument

buildPartial()

public PrivateOfferDocument buildPartial()
Returns
Type Description
PrivateOfferDocument

clear()

public PrivateOfferDocument.Builder clear()
Returns
Type Description
PrivateOfferDocument.Builder
Overrides

clearContent()

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

clearCreateTime()

public PrivateOfferDocument.Builder clearCreateTime()

Output only. The creation time of the resource.

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

Returns
Type Description
PrivateOfferDocument.Builder

clearDocumentType()

public PrivateOfferDocument.Builder clearDocumentType()

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.Builder

This builder for chaining.

clearInlineContent()

public PrivateOfferDocument.Builder clearInlineContent()

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

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

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

clearMimeType()

public PrivateOfferDocument.Builder clearMimeType()

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
PrivateOfferDocument.Builder

This builder for chaining.

clearName()

public PrivateOfferDocument.Builder clearName()

Identifier. Name of the resource.

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

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

clearUpdateTime()

public PrivateOfferDocument.Builder clearUpdateTime()

Output only. The last update time of the resource.

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

Returns
Type Description
PrivateOfferDocument.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time of the resource.

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

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The last update time of the resource.

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public PrivateOfferDocument.Builder mergeCreateTime(Timestamp value)

Output only. The creation time of the resource.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOfferDocument.Builder

mergeFrom(PrivateOfferDocument other)

public PrivateOfferDocument.Builder mergeFrom(PrivateOfferDocument other)
Parameter
Name Description
other PrivateOfferDocument
Returns
Type Description
PrivateOfferDocument.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PrivateOfferDocument.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOfferDocument.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PrivateOfferDocument.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PrivateOfferDocument.Builder
Overrides

mergeUpdateTime(Timestamp value)

public PrivateOfferDocument.Builder mergeUpdateTime(Timestamp value)

Output only. The last update time of the resource.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOfferDocument.Builder

setCreateTime(Timestamp value)

public PrivateOfferDocument.Builder setCreateTime(Timestamp value)

Output only. The creation time of the resource.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOfferDocument.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PrivateOfferDocument.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time of the resource.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOfferDocument.Builder

setDocumentType(PrivateOfferDocument.DocumentType value)

public PrivateOfferDocument.Builder setDocumentType(PrivateOfferDocument.DocumentType value)

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];

Parameter
Name Description
value PrivateOfferDocument.DocumentType

The documentType to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setDocumentTypeValue(int value)

public PrivateOfferDocument.Builder setDocumentTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for documentType to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setInlineContent(ByteString value)

public PrivateOfferDocument.Builder setInlineContent(ByteString value)

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

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

Parameter
Name Description
value ByteString

The inlineContent to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setMimeType(String value)

public PrivateOfferDocument.Builder setMimeType(String value)

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];

Parameter
Name Description
value String

The mimeType to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public PrivateOfferDocument.Builder setMimeTypeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for mimeType to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setName(String value)

public PrivateOfferDocument.Builder setName(String value)

Identifier. Name of the resource.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PrivateOfferDocument.Builder setNameBytes(ByteString value)

Identifier. Name of the resource.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
PrivateOfferDocument.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public PrivateOfferDocument.Builder setUpdateTime(Timestamp value)

Output only. The last update time of the resource.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateOfferDocument.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PrivateOfferDocument.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The last update time of the resource.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateOfferDocument.Builder