Package com.google.cloud.contentwarehouse.v1

Class CreateDocumentRequest

  • All Implemented Interfaces:
    CreateDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CreateDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateDocumentRequestOrBuilder
     Request message for DocumentService.CreateDocument.
    Protobuf type google.cloud.contentwarehouse.v1.CreateDocumentRequest
    See Also:
    Serialized Form

    • Field Detail

      • REQUEST_METADATA_FIELD_NUMBER

        public static final int REQUEST_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER

        public static final int CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_MASK_FIELD_NUMBER

        public static final int CREATE_MASK_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

      • getParent

        public String getParent()
         Required. The parent name.
 Format: projects/{project_number}/locations/{location}.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface CreateDocumentRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent name.
 Format: projects/{project_number}/locations/{location}.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface CreateDocumentRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasDocument

        public boolean hasDocument()
         Required. The document to create.
        .google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasDocument in interface CreateDocumentRequestOrBuilder
        Returns:
        Whether the document field is set.

      • getDocument

        public Document getDocument()
         Required. The document to create.
        .google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocument in interface CreateDocumentRequestOrBuilder
        Returns:
        The document.

      • hasRequestMetadata

        public boolean hasRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control for the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Specified by:
        hasRequestMetadata in interface CreateDocumentRequestOrBuilder
        Returns:
        Whether the requestMetadata field is set.

      • getRequestMetadata

        public RequestMetadata getRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control for the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Specified by:
        getRequestMetadata in interface CreateDocumentRequestOrBuilder
        Returns:
        The requestMetadata.

      • hasPolicy

        public boolean hasPolicy()
         Default document policy during creation.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for the Document.
 Conditions defined in the policy will be ignored.
        .google.iam.v1.Policy policy = 4;
        Specified by:
        hasPolicy in interface CreateDocumentRequestOrBuilder
        Returns:
        Whether the policy field is set.

      • getPolicy

        public com.google.iam.v1.Policy getPolicy()
         Default document policy during creation.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for the Document.
 Conditions defined in the policy will be ignored.
        .google.iam.v1.Policy policy = 4;
        Specified by:
        getPolicy in interface CreateDocumentRequestOrBuilder
        Returns:
        The policy.

      • getPolicyOrBuilder

        public com.google.iam.v1.PolicyOrBuilder getPolicyOrBuilder()
         Default document policy during creation.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for the Document.
 Conditions defined in the policy will be ignored.
        .google.iam.v1.Policy policy = 4;
        Specified by:
        getPolicyOrBuilder in interface CreateDocumentRequestOrBuilder

      • hasCloudAiDocumentOption

        public boolean hasCloudAiDocumentOption()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        hasCloudAiDocumentOption in interface CreateDocumentRequestOrBuilder
        Returns:
        Whether the cloudAiDocumentOption field is set.

      • getCloudAiDocumentOption

        public CloudAIDocumentOption getCloudAiDocumentOption()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        getCloudAiDocumentOption in interface CreateDocumentRequestOrBuilder
        Returns:
        The cloudAiDocumentOption.

      • getCloudAiDocumentOptionOrBuilder

        public CloudAIDocumentOptionOrBuilder getCloudAiDocumentOptionOrBuilder()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        getCloudAiDocumentOptionOrBuilder in interface CreateDocumentRequestOrBuilder

      • hasCreateMask

        public boolean hasCreateMask()
         Field mask for creating Document fields. If mask path is empty,
 it means all fields are masked.
 For the `FieldMask` definition,
 see
 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
        .google.protobuf.FieldMask create_mask = 6;
        Specified by:
        hasCreateMask in interface CreateDocumentRequestOrBuilder
        Returns:
        Whether the createMask field is set.

      • getCreateMask

        public com.google.protobuf.FieldMask getCreateMask()
         Field mask for creating Document fields. If mask path is empty,
 it means all fields are masked.
 For the `FieldMask` definition,
 see
 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
        .google.protobuf.FieldMask create_mask = 6;
        Specified by:
        getCreateMask in interface CreateDocumentRequestOrBuilder
        Returns:
        The createMask.

      • getCreateMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getCreateMaskOrBuilder()
         Field mask for creating Document fields. If mask path is empty,
 it means all fields are masked.
 For the `FieldMask` definition,
 see
 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
        .google.protobuf.FieldMask create_mask = 6;
        Specified by:
        getCreateMaskOrBuilder in interface CreateDocumentRequestOrBuilder

      • 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 CreateDocumentRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<CreateDocumentRequest> 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 CreateDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder