Class PurgeDocumentsResponse (0.38.0)

public final class PurgeDocumentsResponse extends GeneratedMessageV3 implements PurgeDocumentsResponseOrBuilder

Response message for 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.v1.PurgeDocumentsResponse

Static Fields

PURGE_COUNT_FIELD_NUMBER

public static final int PURGE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PURGE_SAMPLE_FIELD_NUMBER

public static final int PURGE_SAMPLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurgeDocumentsResponse getDefaultInstance()
Returns
Type Description
PurgeDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PurgeDocumentsResponse.Builder newBuilder()
Returns
Type Description
PurgeDocumentsResponse.Builder

newBuilder(PurgeDocumentsResponse prototype)

public static PurgeDocumentsResponse.Builder newBuilder(PurgeDocumentsResponse prototype)
Parameter
Name Description
prototype PurgeDocumentsResponse
Returns
Type Description
PurgeDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

public static PurgeDocumentsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PurgeDocumentsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeDocumentsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeDocumentsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PurgeDocumentsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PurgeDocumentsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PurgeDocumentsResponse> parser()
Returns
Type Description
Parser<PurgeDocumentsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PurgeDocumentsResponse getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsResponse

getParserForType()

public Parser<PurgeDocumentsResponse> getParserForType()
Returns
Type Description
Parser<PurgeDocumentsResponse>
Overrides

getPurgeCount()

public long getPurgeCount()

The total count of documents purged as a result of the operation.

int64 purge_count = 1;

Returns
Type Description
long

The purgeCount.

getPurgeSample(int index)

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) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The purgeSample at the given index.

getPurgeSampleBytes(int index)

public 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the purgeSample at the given index.

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) = { ... }

Returns
Type Description
int

The count of purgeSample.

getPurgeSampleList()

public 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) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the purgeSample.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PurgeDocumentsResponse.Builder newBuilderForType()
Returns
Type Description
PurgeDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PurgeDocumentsResponse.Builder toBuilder()
Returns
Type Description
PurgeDocumentsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException