Package com.google.cloud.discoveryengine.v1beta

Class UpdateDocumentRequest.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public UpdateDocumentRequest.Builder mergeFrom(UpdateDocumentRequest other)

    • isInitialized

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

    • mergeFrom

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

    • hasDocument

      public boolean hasDocument()
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDocument in interface UpdateDocumentRequestOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDocument in interface UpdateDocumentRequestOrBuilder
      Returns:
      The document.

    • setDocument

      public UpdateDocumentRequest.Builder setDocument(Document value)
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

    • setDocument

      public UpdateDocumentRequest.Builder setDocument(Document.Builder builderForValue)
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

    • mergeDocument

      public UpdateDocumentRequest.Builder mergeDocument(Document value)
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearDocument

      public UpdateDocumentRequest.Builder clearDocument()
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

    • getDocumentBuilder

      public Document.Builder getDocumentBuilder()
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       Required. The document to update/create.

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

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
      .google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

    • getAllowMissing

      public boolean getAllowMissing()
       If set to `true` and the
 [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
 new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
      bool allow_missing = 2;
      Specified by:
      getAllowMissing in interface UpdateDocumentRequestOrBuilder
      Returns:
      The allowMissing.

    • setAllowMissing

      public UpdateDocumentRequest.Builder setAllowMissing(boolean value)
       If set to `true` and the
 [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
 new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
      bool allow_missing = 2;
      Parameters:
      value - The allowMissing to set.
      Returns:
      This builder for chaining.

    • clearAllowMissing

      public UpdateDocumentRequest.Builder clearAllowMissing()
       If set to `true` and the
 [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
 new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
      bool allow_missing = 2;
      Returns:
      This builder for chaining.

    • hasUpdateMask

      public boolean hasUpdateMask()
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;
      Specified by:
      hasUpdateMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      public com.google.protobuf.FieldMask getUpdateMask()
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;
      Specified by:
      getUpdateMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      The updateMask.

    • setUpdateMask

      public UpdateDocumentRequest.Builder setUpdateMask(com.google.protobuf.FieldMask value)
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;

    • setUpdateMask

      public UpdateDocumentRequest.Builder setUpdateMask(com.google.protobuf.FieldMask.Builder builderForValue)
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;

    • mergeUpdateMask

      public UpdateDocumentRequest.Builder mergeUpdateMask(com.google.protobuf.FieldMask value)
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;

    • clearUpdateMask

      public UpdateDocumentRequest.Builder clearUpdateMask()
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;

    • getUpdateMaskBuilder

      public com.google.protobuf.FieldMask.Builder getUpdateMaskBuilder()
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;

    • getUpdateMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
       Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
      .google.protobuf.FieldMask update_mask = 3;
      Specified by:
      getUpdateMaskOrBuilder in interface UpdateDocumentRequestOrBuilder