Package com.google.cloud.discoveryengine.v1beta

Interface PurgeDocumentsResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PurgeDocumentsResponse, PurgeDocumentsResponse.Builder
@Generated public interface PurgeDocumentsResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getPurgeCount()
    The total count of documents purged as a result of the operation.
    String
    getPurgeSample(int index)
    A sample of document names that will be deleted.
    com.google.protobuf.ByteString
    getPurgeSampleBytes(int index)
    A sample of document names that will be deleted.
    int
    getPurgeSampleCount()
    A sample of document names that will be deleted.
    List<String>
    getPurgeSampleList()
    A sample of document names that will be deleted.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPurgeCount

      long getPurgeCount()
       The total count of documents purged as a result of the operation.
      int64 purge_count = 1;
      Returns:
      The purgeCount.

    • getPurgeSampleList

      List<String> getPurgeSampleList()
       A sample of document names that will be deleted. Only populated if `force`
 is set to false. A max of 100 names will be returned and the names are
 chosen at random.
      repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the purgeSample.

    • getPurgeSampleCount

      int getPurgeSampleCount()
       A sample of document names that will be deleted. Only populated if `force`
 is set to false. A max of 100 names will be returned and the names are
 chosen at random.
      repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of purgeSample.

    • getPurgeSample

      String getPurgeSample(int index)
       A sample of document names that will be deleted. Only populated if `force`
 is set to false. A max of 100 names will be returned and the names are
 chosen at random.
      repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The purgeSample at the given index.

    • getPurgeSampleBytes

      com.google.protobuf.ByteString getPurgeSampleBytes(int index)
       A sample of document names that will be deleted. Only populated if `force`
 is set to false. A max of 100 names will be returned and the names are
 chosen at random.
      repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the purgeSample at the given index.