Package com.google.cloud.contentwarehouse.v1

Class DocumentReference.Builder

  • All Implemented Interfaces:
    DocumentReferenceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DocumentReference
    public static final class DocumentReference.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>
implements DocumentReferenceOrBuilder
     References to the documents.
    Protobuf type google.cloud.contentwarehouse.v1.DocumentReference

    • Method Detail

      • 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.Builder<DocumentReference.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public DocumentReference.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • clearField

        public DocumentReference.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • clearOneof

        public DocumentReference.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • setRepeatedField

        public DocumentReference.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • addRepeatedField

        public DocumentReference.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • mergeFrom

        public DocumentReference.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentReference.Builder>

      • isInitialized

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

      • mergeFrom

        public DocumentReference.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentReference.Builder>
        Throws:
        IOException

      • 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.

      • setDocumentName

        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) = { ... }
        Parameters:
        value - The documentName to set.
        Returns:
        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:
        This builder for chaining.

      • setDocumentNameBytes

        public DocumentReference.Builder setDocumentNameBytes​(com.google.protobuf.ByteString value)
         Required. Name of the referenced document.
        string document_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for documentName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDisplayName

        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;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setDisplayNameBytes

        public DocumentReference.Builder setDisplayNameBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setSnippet

        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;
        Parameters:
        value - The snippet to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setSnippetBytes

        public DocumentReference.Builder setSnippetBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for snippet to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDocumentIsFolder

        public DocumentReference.Builder setDocumentIsFolder​(boolean value)
         The document type of the document being referenced.
        bool document_is_folder = 4;
        Parameters:
        value - The documentIsFolder to set.
        Returns:
        This builder for chaining.

      • clearDocumentIsFolder

        public DocumentReference.Builder clearDocumentIsFolder()
         The document type of the document being referenced.
        bool document_is_folder = 4;
        Returns:
        This builder for chaining.

      • 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.

      • setUpdateTime

        public DocumentReference.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setUpdateTime

        public DocumentReference.Builder setUpdateTime​(com.google.protobuf.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];

      • mergeUpdateTime

        public DocumentReference.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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];

      • getUpdateTimeBuilder

        public com.google.protobuf.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];

      • 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.

      • setCreateTime

        public DocumentReference.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreateTime

        public DocumentReference.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreateTime

        public DocumentReference.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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];

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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.

      • setDeleteTime

        public DocumentReference.Builder setDeleteTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setDeleteTime

        public DocumentReference.Builder setDeleteTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeDeleteTime

        public DocumentReference.Builder mergeDeleteTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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];

      • getDeleteTimeBuilder

        public com.google.protobuf.Timestamp.Builder getDeleteTimeBuilder()
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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.

      • setDocumentIsRetentionFolder

        public DocumentReference.Builder setDocumentIsRetentionFolder​(boolean value)
         Document is a folder with retention policy.
        bool document_is_retention_folder = 8;
        Parameters:
        value - The documentIsRetentionFolder to set.
        Returns:
        This builder for chaining.

      • clearDocumentIsRetentionFolder

        public DocumentReference.Builder clearDocumentIsRetentionFolder()
         Document is a folder with retention policy.
        bool document_is_retention_folder = 8;
        Returns:
        This builder for chaining.

      • 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.

      • setDocumentIsLegalHoldFolder

        public DocumentReference.Builder setDocumentIsLegalHoldFolder​(boolean value)
         Document is a folder with legal hold.
        bool document_is_legal_hold_folder = 9;
        Parameters:
        value - The documentIsLegalHoldFolder to set.
        Returns:
        This builder for chaining.

      • clearDocumentIsLegalHoldFolder

        public DocumentReference.Builder clearDocumentIsLegalHoldFolder()
         Document is a folder with legal hold.
        bool document_is_legal_hold_folder = 9;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final DocumentReference.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>

      • mergeUnknownFields

        public final DocumentReference.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentReference.Builder>