Package com.google.cloud.contentwarehouse.v1

Interface DocumentReferenceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DocumentReference, DocumentReference.Builder
    public interface DocumentReferenceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Timestamp getCreateTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      Output only.
      com.google.protobuf.Timestamp getDeleteTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
      Output only.
      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.
      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.
      boolean getDocumentIsFolder()
      The document type of the document being referenced.
      boolean getDocumentIsLegalHoldFolder()
      Document is a folder with legal hold.
      boolean getDocumentIsRetentionFolder()
      Document is a folder with retention policy.
      String getDocumentName()
      Required.
      com.google.protobuf.ByteString getDocumentNameBytes()
      Required.
      String getSnippet()
      Stores the subset of the referenced document's content.
      com.google.protobuf.ByteString getSnippetBytes()
      Stores the subset of the referenced document's content.
      com.google.protobuf.Timestamp getUpdateTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
      Output only.
      boolean hasCreateTime()
      Output only.
      boolean hasDeleteTime()
      Output only.
      boolean hasUpdateTime()
      Output only.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDocumentName

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

      • getDocumentNameBytes

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

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        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;
        Returns:
        The bytes for displayName.

      • getSnippet

        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:
        The snippet.

      • getSnippetBytes

        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;
        Returns:
        The bytes for snippet.

      • getDocumentIsFolder

        boolean getDocumentIsFolder()
         The document type of the document being referenced.
        bool document_is_folder = 4;
        Returns:
        The documentIsFolder.

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time when the document is created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. The time when the document is deleted.
        .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        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];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

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

      • getDocumentIsRetentionFolder

        boolean getDocumentIsRetentionFolder()
         Document is a folder with retention policy.
        bool document_is_retention_folder = 8;
        Returns:
        The documentIsRetentionFolder.

      • getDocumentIsLegalHoldFolder

        boolean getDocumentIsLegalHoldFolder()
         Document is a folder with legal hold.
        bool document_is_legal_hold_folder = 9;
        Returns:
        The documentIsLegalHoldFolder.