Package com.google.cloud.discoveryengine.v1beta

Class PurgeDocumentsResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse
All Implemented Interfaces:
PurgeDocumentsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PurgeDocumentsResponse extends com.google.protobuf.GeneratedMessage implements PurgeDocumentsResponseOrBuilder
 Response message for
 [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
 method. If the long running operation is successfully done, then this message
 is returned by the google.longrunning.Operations.response field.
Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PurgeDocumentsResponse.Builder
    Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PURGE_COUNT_FIELD_NUMBER
     
    static final int
    PURGE_SAMPLE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static PurgeDocumentsResponse
    getDefaultInstance()
     
    PurgeDocumentsResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<PurgeDocumentsResponse>
    getParserForType()
     
    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.
    com.google.protobuf.ProtocolStringList
    getPurgeSampleList()
    A sample of document names that will be deleted.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PurgeDocumentsResponse.Builder
    newBuilder()
     
    static PurgeDocumentsResponse.Builder
    newBuilder(PurgeDocumentsResponse prototype)
     
    PurgeDocumentsResponse.Builder
    newBuilderForType()
     
    protected PurgeDocumentsResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PurgeDocumentsResponse
    parseDelimitedFrom(InputStream input)
     
    static PurgeDocumentsResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeDocumentsResponse
    parseFrom(byte[] data)
     
    static PurgeDocumentsResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeDocumentsResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static PurgeDocumentsResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeDocumentsResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PurgeDocumentsResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeDocumentsResponse
    parseFrom(InputStream input)
     
    static PurgeDocumentsResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PurgeDocumentsResponse
    parseFrom(ByteBuffer data)
     
    static PurgeDocumentsResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PurgeDocumentsResponse>
    parser()
     
    PurgeDocumentsResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PURGE_COUNT_FIELD_NUMBER

      public static final int PURGE_COUNT_FIELD_NUMBER
      See Also:

    • PURGE_SAMPLE_FIELD_NUMBER

      public static final int PURGE_SAMPLE_FIELD_NUMBER
      See Also:

  • 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

    • getPurgeCount

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

    • getPurgeSampleList

      public com.google.protobuf.ProtocolStringList 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) = { ... }
      Specified by:
      getPurgeSampleList in interface PurgeDocumentsResponseOrBuilder
      Returns:
      A list containing the purgeSample.

    • getPurgeSampleCount

      public 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) = { ... }
      Specified by:
      getPurgeSampleCount in interface PurgeDocumentsResponseOrBuilder
      Returns:
      The count of purgeSample.

    • getPurgeSample

      public 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) = { ... }
      Specified by:
      getPurgeSample in interface PurgeDocumentsResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The purgeSample at the given index.

    • getPurgeSampleBytes

      public 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) = { ... }
      Specified by:
      getPurgeSampleBytes in interface PurgeDocumentsResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the purgeSample at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PurgeDocumentsResponse.Builder newBuilder()

    • newBuilder

      public static PurgeDocumentsResponse.Builder newBuilder(PurgeDocumentsResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PurgeDocumentsResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PurgeDocumentsResponse> 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 PurgeDocumentsResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder