Class DocumentReference (0.43.0)

public final class DocumentReference extends GeneratedMessageV3 implements DocumentReferenceOrBuilder

References to the documents.

Protobuf type google.cloud.contentwarehouse.v1.DocumentReference

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
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()
Returns
Type Description
DocumentReference

getDescriptor()

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

newBuilder()

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

newBuilder(DocumentReference prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DocumentReference getDefaultInstanceForType()
Returns
Type Description
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
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];

Returns
Type Description
TimestampOrBuilder

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()
Returns
Type Description
Parser<DocumentReference>
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];

Returns
Type Description
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
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentReference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentReference.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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