Package com.google.cloud.discoveryengine.v1beta

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][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument]
 method.
    Protobuf type google.cloud.discoveryengine.v1beta.CreateDocumentRequest
    See Also:
    Serialized Form

    • 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 resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        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 resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
        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][google.cloud.discoveryengine.v1beta.Document] to
 create.
        .google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.Document] to
 create.
        .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocument in interface CreateDocumentRequestOrBuilder
        Returns:
        The document.

      • getDocumentOrBuilder

        public DocumentOrBuilder getDocumentOrBuilder()
         Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
        .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocumentOrBuilder in interface CreateDocumentRequestOrBuilder

      • getDocumentId

        public String getDocumentId()
         Required. The ID to use for the
 [Document][google.cloud.discoveryengine.v1beta.Document], which will become
 the final component of the
 [Document.name][google.cloud.discoveryengine.v1beta.Document.name].

 If the caller does not have permission to create the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 This field must be unique among all
 [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
 [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
 Otherwise, an `ALREADY_EXISTS` error is returned.

 This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocumentId in interface CreateDocumentRequestOrBuilder
        Returns:
        The documentId.

      • getDocumentIdBytes

        public com.google.protobuf.ByteString getDocumentIdBytes()
         Required. The ID to use for the
 [Document][google.cloud.discoveryengine.v1beta.Document], which will become
 the final component of the
 [Document.name][google.cloud.discoveryengine.v1beta.Document.name].

 If the caller does not have permission to create the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 This field must be unique among all
 [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
 [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
 Otherwise, an `ALREADY_EXISTS` error is returned.

 This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocumentIdBytes in interface CreateDocumentRequestOrBuilder
        Returns:
        The bytes for documentId.

      • 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