Interface DocumentReferenceOrBuilder (0.49.0)

public interface DocumentReferenceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract 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 abstract 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

getDeleteTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean getDocumentIsFolder()

The document type of the document being referenced.

bool document_is_folder = 4;

Returns
Type Description
boolean

The documentIsFolder.

getDocumentIsLegalHoldFolder()

public abstract boolean getDocumentIsLegalHoldFolder()

Document is a folder with legal hold.

bool document_is_legal_hold_folder = 9;

Returns
Type Description
boolean

The documentIsLegalHoldFolder.

getDocumentIsRetentionFolder()

public abstract boolean getDocumentIsRetentionFolder()

Document is a folder with retention policy.

bool document_is_retention_folder = 8;

Returns
Type Description
boolean

The documentIsRetentionFolder.

getDocumentName()

public abstract 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 abstract 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.

getSnippet()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.