Package com.google.cloud.discoveryengine.v1beta

Class PurgeDocumentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest
All Implemented Interfaces:
PurgeDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PurgeDocumentsRequest extends com.google.protobuf.GeneratedMessage implements PurgeDocumentsRequestOrBuilder
 Request message for
 [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest
See Also:

  • Field Details

  • 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

    • getSourceCase

      public PurgeDocumentsRequest.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface PurgeDocumentsRequestOrBuilder

    • hasGcsSource

      public boolean hasGcsSource()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;
      Specified by:
      hasGcsSource in interface PurgeDocumentsRequestOrBuilder
      Returns:
      Whether the gcsSource field is set.

    • getGcsSource

      public GcsSource getGcsSource()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;
      Specified by:
      getGcsSource in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The gcsSource.

    • getGcsSourceOrBuilder

      public GcsSourceOrBuilder getGcsSourceOrBuilder()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;
      Specified by:
      getGcsSourceOrBuilder in interface PurgeDocumentsRequestOrBuilder

    • hasInlineSource

      public boolean hasInlineSource()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;
      Specified by:
      hasInlineSource in interface PurgeDocumentsRequestOrBuilder
      Returns:
      Whether the inlineSource field is set.

    • getInlineSource

      public PurgeDocumentsRequest.InlineSource getInlineSource()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;
      Specified by:
      getInlineSource in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The inlineSource.

    • getInlineSourceOrBuilder

      public PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;
      Specified by:
      getInlineSourceOrBuilder in interface PurgeDocumentsRequestOrBuilder

    • 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 PurgeDocumentsRequestOrBuilder
      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 PurgeDocumentsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getFilter

      public String getFilter()
       Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFilter in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFilterBytes in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The bytes for filter.

    • hasErrorConfig

      public boolean hasErrorConfig()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;
      Specified by:
      hasErrorConfig in interface PurgeDocumentsRequestOrBuilder
      Returns:
      Whether the errorConfig field is set.

    • getErrorConfig

      public PurgeErrorConfig getErrorConfig()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;
      Specified by:
      getErrorConfig in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The errorConfig.

    • getErrorConfigOrBuilder

      public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;
      Specified by:
      getErrorConfigOrBuilder in interface PurgeDocumentsRequestOrBuilder

    • getForce

      public boolean getForce()
       Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any documents.
      bool force = 3;
      Specified by:
      getForce in interface PurgeDocumentsRequestOrBuilder
      Returns:
      The force.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PurgeDocumentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurgeDocumentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PurgeDocumentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PurgeDocumentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurgeDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PurgeDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static PurgeDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static PurgeDocumentsRequest.Builder newBuilder(PurgeDocumentsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected PurgeDocumentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PurgeDocumentsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PurgeDocumentsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<PurgeDocumentsRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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