Package com.google.cloud.discoveryengine.v1beta

Class CreateDocumentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CreateDocumentRequest.Builder>
com.google.cloud.discoveryengine.v1beta.CreateDocumentRequest.Builder
All Implemented Interfaces:
CreateDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CreateDocumentRequest
public static final class CreateDocumentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilder
 Request message for
 [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.CreateDocumentRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CreateDocumentRequest.Builder>

    • clear

      public CreateDocumentRequest.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.GeneratedMessage.Builder<CreateDocumentRequest.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.GeneratedMessage.Builder<CreateDocumentRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public CreateDocumentRequest.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<CreateDocumentRequest.Builder>

    • mergeFrom

      public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)

    • isInitialized

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

    • mergeFrom

      public CreateDocumentRequest.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<CreateDocumentRequest.Builder>
      Throws:
      IOException

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

    • setParent

      public CreateDocumentRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public CreateDocumentRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public CreateDocumentRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

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

    • setDocument

      public CreateDocumentRequest.Builder setDocument(Document value)
       Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
      .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

    • setDocument

      public CreateDocumentRequest.Builder setDocument(Document.Builder builderForValue)
       Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
      .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeDocument

      public CreateDocumentRequest.Builder mergeDocument(Document value)
       Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
      .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearDocument

      public CreateDocumentRequest.Builder clearDocument()
       Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
      .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

    • getDocumentBuilder

      public Document.Builder getDocumentBuilder()
       Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
 create.
      .google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

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

    • setDocumentId

      public CreateDocumentRequest.Builder setDocumentId(String value)
       Required. The ID to use for the
 [Document][google.cloud.discoveryengine.v1beta.Document], which becomes 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];
      Parameters:
      value - The documentId to set.
      Returns:
      This builder for chaining.

    • clearDocumentId

      public CreateDocumentRequest.Builder clearDocumentId()
       Required. The ID to use for the
 [Document][google.cloud.discoveryengine.v1beta.Document], which becomes 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];
      Returns:
      This builder for chaining.

    • setDocumentIdBytes

      public CreateDocumentRequest.Builder setDocumentIdBytes(com.google.protobuf.ByteString value)
       Required. The ID to use for the
 [Document][google.cloud.discoveryengine.v1beta.Document], which becomes 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];
      Parameters:
      value - The bytes for documentId to set.
      Returns:
      This builder for chaining.