Class PurgeDocumentsResponse.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
- com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.Builder
-
- All Implemented Interfaces:
PurgeDocumentsResponseOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- PurgeDocumentsResponse
public static final class PurgeDocumentsResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder> 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 typegoogle.cloud.discoveryengine.v1beta.PurgeDocumentsResponse
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PurgeDocumentsResponse.Builder
addAllPurgeSample(Iterable<String> values)
A sample of document names that will be deleted.PurgeDocumentsResponse.Builder
addPurgeSample(String value)
A sample of document names that will be deleted.PurgeDocumentsResponse.Builder
addPurgeSampleBytes(com.google.protobuf.ByteString value)
A sample of document names that will be deleted.PurgeDocumentsResponse.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PurgeDocumentsResponse
build()
PurgeDocumentsResponse
buildPartial()
PurgeDocumentsResponse.Builder
clear()
PurgeDocumentsResponse.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PurgeDocumentsResponse.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PurgeDocumentsResponse.Builder
clearPurgeCount()
The total count of documents purged as a result of the operation.PurgeDocumentsResponse.Builder
clearPurgeSample()
A sample of document names that will be deleted.PurgeDocumentsResponse.Builder
clone()
PurgeDocumentsResponse
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
PurgeDocumentsResponse.Builder
mergeFrom(PurgeDocumentsResponse other)
PurgeDocumentsResponse.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PurgeDocumentsResponse.Builder
mergeFrom(com.google.protobuf.Message other)
PurgeDocumentsResponse.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PurgeDocumentsResponse.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PurgeDocumentsResponse.Builder
setPurgeCount(long value)
The total count of documents purged as a result of the operation.PurgeDocumentsResponse.Builder
setPurgeSample(int index, String value)
A sample of document names that will be deleted.PurgeDocumentsResponse.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
PurgeDocumentsResponse.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
clear
public PurgeDocumentsResponse.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
getDefaultInstanceForType
public PurgeDocumentsResponse getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public PurgeDocumentsResponse build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public PurgeDocumentsResponse buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public PurgeDocumentsResponse.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
setField
public PurgeDocumentsResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
clearField
public PurgeDocumentsResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
clearOneof
public PurgeDocumentsResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
setRepeatedField
public PurgeDocumentsResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
addRepeatedField
public PurgeDocumentsResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
mergeFrom
public PurgeDocumentsResponse.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<PurgeDocumentsResponse.Builder>
-
mergeFrom
public PurgeDocumentsResponse.Builder mergeFrom(PurgeDocumentsResponse other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
mergeFrom
public PurgeDocumentsResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<PurgeDocumentsResponse.Builder>
- Throws:
IOException
-
getPurgeCount
public long getPurgeCount()
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
- Specified by:
getPurgeCount
in interfacePurgeDocumentsResponseOrBuilder
- Returns:
- The purgeCount.
-
setPurgeCount
public PurgeDocumentsResponse.Builder setPurgeCount(long value)
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
- Parameters:
value
- The purgeCount to set.- Returns:
- This builder for chaining.
-
clearPurgeCount
public PurgeDocumentsResponse.Builder clearPurgeCount()
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
- Returns:
- This builder for chaining.
-
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 interfacePurgeDocumentsResponseOrBuilder
- 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 interfacePurgeDocumentsResponseOrBuilder
- 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 interfacePurgeDocumentsResponseOrBuilder
- 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 interfacePurgeDocumentsResponseOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the purgeSample at the given index.
-
setPurgeSample
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:
index
- The index to set the value at.value
- The purgeSample to set.- Returns:
- This builder for chaining.
-
addPurgeSample
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) = { ... }
- Parameters:
value
- The purgeSample to add.- Returns:
- This builder for chaining.
-
addAllPurgeSample
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) = { ... }
- Parameters:
values
- The purgeSample to add.- Returns:
- This builder for chaining.
-
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) = { ... }
- Returns:
- This builder for chaining.
-
addPurgeSampleBytes
public PurgeDocumentsResponse.Builder addPurgeSampleBytes(com.google.protobuf.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) = { ... }
- Parameters:
value
- The bytes of the purgeSample to add.- Returns:
- This builder for chaining.
-
setUnknownFields
public final PurgeDocumentsResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
mergeUnknownFields
public final PurgeDocumentsResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder>
-
-