Send feedback
Class DocumentReference (0.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.52.0keyboard_arrow_down
public final class DocumentReference extends GeneratedMessageV3 implements DocumentReferenceOrBuilder
References to the documents.
Protobuf type google.cloud.contentwarehouse.v1.DocumentReference
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_IS_FOLDER_FIELD_NUMBER
public static final int DOCUMENT_IS_FOLDER_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_IS_LEGAL_HOLD_FOLDER_FIELD_NUMBER
public static final int DOCUMENT_IS_LEGAL_HOLD_FOLDER_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_IS_RETENTION_FOLDER_FIELD_NUMBER
public static final int DOCUMENT_IS_RETENTION_FOLDER_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_NAME_FIELD_NUMBER
public static final int DOCUMENT_NAME_FIELD_NUMBER
Field Value
Type Description
int
SNIPPET_FIELD_NUMBER
public static final int SNIPPET_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 DocumentReference getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DocumentReference . Builder newBuilder ()
newBuilder(DocumentReference prototype)
public static DocumentReference . Builder newBuilder ( DocumentReference prototype )
parseDelimitedFrom(InputStream input)
public static DocumentReference parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DocumentReference parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DocumentReference parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static DocumentReference parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static DocumentReference parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DocumentReference parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentReference parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DocumentReference> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
Type Description
Timestamp The createTime.
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];
getDefaultInstanceForType()
public DocumentReference getDefaultInstanceForType ()
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
Type Description
Timestamp The deleteTime.
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];
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
Type Description
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
Type Description
ByteString The bytes for displayName.
getDocumentIsFolder()
public boolean getDocumentIsFolder ()
The document type of the document being referenced.
bool document_is_folder = 4;
Returns
Type Description
boolean The documentIsFolder.
getDocumentIsLegalHoldFolder()
public boolean getDocumentIsLegalHoldFolder ()
Document is a folder with legal hold.
bool document_is_legal_hold_folder = 9;
Returns
Type Description
boolean The documentIsLegalHoldFolder.
getDocumentIsRetentionFolder()
public boolean getDocumentIsRetentionFolder ()
Document is a folder with retention policy.
bool document_is_retention_folder = 8;
Returns
Type Description
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
Type Description
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
Type Description
ByteString The bytes for documentName.
getParserForType()
public Parser<DocumentReference> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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
Type Description
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
Type Description
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
Type Description
Timestamp The updateTime.
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];
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
Type Description
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
Type Description
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
Type Description
boolean Whether the updateTime field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DocumentReference . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentReference . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DocumentReference . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
