public static final class PurgeDocumentsResponse.Builder extends GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder> 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllPurgeSample(Iterable<String> values)
public PurgeDocumentsResponse.Builder addAllPurgeSample(Iterable<String> values)
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) = { ... }
addPurgeSample(String value)
public PurgeDocumentsResponse.Builder addPurgeSample(String value)
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 |
value | String
The purgeSample to add.
|
addPurgeSampleBytes(ByteString value)
public PurgeDocumentsResponse.Builder addPurgeSampleBytes(ByteString value)
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 |
value | ByteString
The bytes of the purgeSample to add.
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PurgeDocumentsResponse build()
buildPartial()
public PurgeDocumentsResponse buildPartial()
clear()
public PurgeDocumentsResponse.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearPurgeCount()
public PurgeDocumentsResponse.Builder clearPurgeCount()
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
clearPurgeSample()
public PurgeDocumentsResponse.Builder clearPurgeSample()
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) = { ... }
clone()
public PurgeDocumentsResponse.Builder clone()
Overrides
getDefaultInstanceForType()
public PurgeDocumentsResponse getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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) = { ... }
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PurgeDocumentsResponse other)
public PurgeDocumentsResponse.Builder mergeFrom(PurgeDocumentsResponse other)
public PurgeDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PurgeDocumentsResponse.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setPurgeCount(long value)
public PurgeDocumentsResponse.Builder setPurgeCount(long value)
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
| Parameter |
|---|
| Name | Description |
value | long
The purgeCount to set.
|
setPurgeSample(int index, String value)
public PurgeDocumentsResponse.Builder setPurgeSample(int index, String value)
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 |
|---|
| Name | Description |
index | int
The index to set the value at.
|
value | String
The purgeSample to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeDocumentsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
