Class DocumentReference.Builder (0.30.0)

public static final class DocumentReference.Builder extends GeneratedMessageV3.Builder<DocumentReference.Builder> implements DocumentReferenceOrBuilder

References to the documents.

Protobuf type google.cloud.contentwarehouse.v1.DocumentReference

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentReference.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentReference.Builder
Overrides

build()

public DocumentReference build()
Returns
TypeDescription
DocumentReference

buildPartial()

public DocumentReference buildPartial()
Returns
TypeDescription
DocumentReference

clear()

public DocumentReference.Builder clear()
Returns
TypeDescription
DocumentReference.Builder
Overrides

clearCreateTime()

public DocumentReference.Builder clearCreateTime()

Output only. The time when the document is created.

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

Returns
TypeDescription
DocumentReference.Builder

clearDeleteTime()

public DocumentReference.Builder clearDeleteTime()

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DocumentReference.Builder

clearDisplayName()

public DocumentReference.Builder clearDisplayName()

display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.

string display_name = 2;

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearDocumentIsFolder()

public DocumentReference.Builder clearDocumentIsFolder()

The document type of the document being referenced.

bool document_is_folder = 4;

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearDocumentIsLegalHoldFolder()

public DocumentReference.Builder clearDocumentIsLegalHoldFolder()

Document is a folder with legal hold.

bool document_is_legal_hold_folder = 9;

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearDocumentIsRetentionFolder()

public DocumentReference.Builder clearDocumentIsRetentionFolder()

Document is a folder with retention policy.

bool document_is_retention_folder = 8;

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearDocumentName()

public DocumentReference.Builder clearDocumentName()

Required. Name of the referenced document.

string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentReference.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DocumentReference.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentReference.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DocumentReference.Builder
Overrides

clearSnippet()

public DocumentReference.Builder clearSnippet()

Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.

string snippet = 3;

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

clearUpdateTime()

public DocumentReference.Builder clearUpdateTime()

Output only. The time when the document is last updated.

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

Returns
TypeDescription
DocumentReference.Builder

clone()

public DocumentReference.Builder clone()
Returns
TypeDescription
DocumentReference.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the document is created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the document is created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the document is created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public DocumentReference getDefaultInstanceForType()
Returns
TypeDescription
DocumentReference

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getDocumentIsFolder()

public boolean getDocumentIsFolder()

The document type of the document being referenced.

bool document_is_folder = 4;

Returns
TypeDescription
boolean

The documentIsFolder.

getDocumentIsLegalHoldFolder()

public boolean getDocumentIsLegalHoldFolder()

Document is a folder with legal hold.

bool document_is_legal_hold_folder = 9;

Returns
TypeDescription
boolean

The documentIsLegalHoldFolder.

getDocumentIsRetentionFolder()

public boolean getDocumentIsRetentionFolder()

Document is a folder with retention policy.

bool document_is_retention_folder = 8;

Returns
TypeDescription
boolean

The documentIsRetentionFolder.

getDocumentName()

public String getDocumentName()

Required. Name of the referenced document.

string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The documentName.

getDocumentNameBytes()

public ByteString getDocumentNameBytes()

Required. Name of the referenced document.

string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for documentName.

getSnippet()

public String getSnippet()

Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.

string snippet = 3;

Returns
TypeDescription
String

The snippet.

getSnippetBytes()

public ByteString getSnippetBytes()

Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.

string snippet = 3;

Returns
TypeDescription
ByteString

The bytes for snippet.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the document is last updated.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the document is last updated.

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the document is last updated.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the document is created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the document is last updated.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public DocumentReference.Builder mergeCreateTime(Timestamp value)

Output only. The time when the document is created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

mergeDeleteTime(Timestamp value)

public DocumentReference.Builder mergeDeleteTime(Timestamp value)

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

mergeFrom(DocumentReference other)

public DocumentReference.Builder mergeFrom(DocumentReference other)
Parameter
NameDescription
otherDocumentReference
Returns
TypeDescription
DocumentReference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentReference.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentReference.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DocumentReference.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DocumentReference.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentReference.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentReference.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DocumentReference.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the document is last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

setCreateTime(Timestamp value)

public DocumentReference.Builder setCreateTime(Timestamp value)

Output only. The time when the document is created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DocumentReference.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the document is created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
DocumentReference.Builder

setDeleteTime(Timestamp value)

public DocumentReference.Builder setDeleteTime(Timestamp value)

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public DocumentReference.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The time when the document is deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
DocumentReference.Builder

setDisplayName(String value)

public DocumentReference.Builder setDisplayName(String value)

display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DocumentReference.Builder setDisplayNameBytes(ByteString value)

display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDocumentIsFolder(boolean value)

public DocumentReference.Builder setDocumentIsFolder(boolean value)

The document type of the document being referenced.

bool document_is_folder = 4;

Parameter
NameDescription
valueboolean

The documentIsFolder to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDocumentIsLegalHoldFolder(boolean value)

public DocumentReference.Builder setDocumentIsLegalHoldFolder(boolean value)

Document is a folder with legal hold.

bool document_is_legal_hold_folder = 9;

Parameter
NameDescription
valueboolean

The documentIsLegalHoldFolder to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDocumentIsRetentionFolder(boolean value)

public DocumentReference.Builder setDocumentIsRetentionFolder(boolean value)

Document is a folder with retention policy.

bool document_is_retention_folder = 8;

Parameter
NameDescription
valueboolean

The documentIsRetentionFolder to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDocumentName(String value)

public DocumentReference.Builder setDocumentName(String value)

Required. Name of the referenced document.

string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The documentName to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setDocumentNameBytes(ByteString value)

public DocumentReference.Builder setDocumentNameBytes(ByteString value)

Required. Name of the referenced document.

string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for documentName to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentReference.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentReference.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DocumentReference.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentReference.Builder
Overrides

setSnippet(String value)

public DocumentReference.Builder setSnippet(String value)

Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.

string snippet = 3;

Parameter
NameDescription
valueString

The snippet to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setSnippetBytes(ByteString value)

public DocumentReference.Builder setSnippetBytes(ByteString value)

Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.

string snippet = 3;

Parameter
NameDescription
valueByteString

The bytes for snippet to set.

Returns
TypeDescription
DocumentReference.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentReference.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentReference.Builder
Overrides

setUpdateTime(Timestamp value)

public DocumentReference.Builder setUpdateTime(Timestamp value)

Output only. The time when the document is last updated.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentReference.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DocumentReference.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the document is last updated.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
DocumentReference.Builder