Package com.google.cloud.contentwarehouse.v1

Class DocumentReference

  • All Implemented Interfaces:
    DocumentReferenceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DocumentReference
extends com.google.protobuf.GeneratedMessageV3
implements DocumentReferenceOrBuilder
     References to the documents.
    Protobuf type google.cloud.contentwarehouse.v1.DocumentReference
    See Also:
    Serialized Form

    • Field Detail

      • DOCUMENT_NAME_FIELD_NUMBER

        public static final int DOCUMENT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_IS_FOLDER_FIELD_NUMBER

        public static final int DOCUMENT_IS_FOLDER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DELETE_TIME_FIELD_NUMBER

        public static final int DELETE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_IS_RETENTION_FOLDER_FIELD_NUMBER

        public static final int DOCUMENT_IS_RETENTION_FOLDER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_IS_LEGAL_HOLD_FOLDER_FIELD_NUMBER

        public static final int DOCUMENT_IS_LEGAL_HOLD_FOLDER_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getDocumentName

        public String getDocumentName()
         Required. Name of the referenced document.
        string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentName in interface DocumentReferenceOrBuilder
        Returns:
        The documentName.

      • getDocumentNameBytes

        public com.google.protobuf.ByteString getDocumentNameBytes()
         Required. Name of the referenced document.
        string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentNameBytes in interface DocumentReferenceOrBuilder
        Returns:
        The bytes for documentName.

      • 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;
        Specified by:
        getDisplayName in interface DocumentReferenceOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.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;
        Specified by:
        getDisplayNameBytes in interface DocumentReferenceOrBuilder
        Returns:
        The bytes for displayName.

      • 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;
        Specified by:
        getSnippet in interface DocumentReferenceOrBuilder
        Returns:
        The snippet.

      • getSnippetBytes

        public com.google.protobuf.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;
        Specified by:
        getSnippetBytes in interface DocumentReferenceOrBuilder
        Returns:
        The bytes for snippet.

      • getDocumentIsFolder

        public boolean getDocumentIsFolder()
         The document type of the document being referenced.
        bool document_is_folder = 4;
        Specified by:
        getDocumentIsFolder in interface DocumentReferenceOrBuilder
        Returns:
        The documentIsFolder.

      • 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];
        Specified by:
        hasUpdateTime in interface DocumentReferenceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the document is last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DocumentReferenceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the document is last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DocumentReferenceOrBuilder

      • 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];
        Specified by:
        hasCreateTime in interface DocumentReferenceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DocumentReferenceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DocumentReferenceOrBuilder

      • 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];
        Specified by:
        hasDeleteTime in interface DocumentReferenceOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTime in interface DocumentReferenceOrBuilder
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTimeOrBuilder in interface DocumentReferenceOrBuilder

      • getDocumentIsRetentionFolder

        public boolean getDocumentIsRetentionFolder()
         Document is a folder with retention policy.
        bool document_is_retention_folder = 8;
        Specified by:
        getDocumentIsRetentionFolder in interface DocumentReferenceOrBuilder
        Returns:
        The documentIsRetentionFolder.

      • getDocumentIsLegalHoldFolder

        public boolean getDocumentIsLegalHoldFolder()
         Document is a folder with legal hold.
        bool document_is_legal_hold_folder = 9;
        Specified by:
        getDocumentIsLegalHoldFolder in interface DocumentReferenceOrBuilder
        Returns:
        The documentIsLegalHoldFolder.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DocumentReference parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DocumentReference parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DocumentReference.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DocumentReference.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DocumentReference.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<DocumentReference> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public DocumentReference getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder