Package com.google.cloud.discoveryengine.v1

Interface CreateDocumentRequestOrBuilder

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

    • Method Detail

      • getParent

        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) = { ... }
        Returns:
        The parent.

      • getParentBytes

        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) = { ... }
        Returns:
        The bytes for parent.

      • hasDocument

        boolean hasDocument()
         Required. The [Document][google.cloud.discoveryengine.v1.Document] to
 create.
        .google.cloud.discoveryengine.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the document field is set.

      • getDocument

        Document getDocument()
         Required. The [Document][google.cloud.discoveryengine.v1.Document] to
 create.
        .google.cloud.discoveryengine.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The document.

      • getDocumentOrBuilder

        DocumentOrBuilder getDocumentOrBuilder()
         Required. The [Document][google.cloud.discoveryengine.v1.Document] to
 create.
        .google.cloud.discoveryengine.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

      • getDocumentId

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

 If the caller does not have permission to create the
 [Document][google.cloud.discoveryengine.v1.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.v1.Document]s with the same
 [parent][google.cloud.discoveryengine.v1.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];
        Returns:
        The documentId.

      • getDocumentIdBytes

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

 If the caller does not have permission to create the
 [Document][google.cloud.discoveryengine.v1.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.v1.Document]s with the same
 [parent][google.cloud.discoveryengine.v1.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];
        Returns:
        The bytes for documentId.