com.google.cloud.discoveryengine.v1alpha

Class PurgeDocumentsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest

All Implemented Interfaces:

PurgeDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PurgeDocumentsRequest
extends com.google.protobuf.GeneratedMessageV3
implements PurgeDocumentsRequestOrBuilder

 Request message for
 [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments]
 method.
 

Protobuf type google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurgeDocumentsRequest.Builder Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.
static class	PurgeDocumentsRequest.InlineSource The inline source for the input config for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.
static interface	PurgeDocumentsRequest.InlineSourceOrBuilder
static class	PurgeDocumentsRequest.SourceCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CONFIG_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	FORCE_FIELD_NUMBER
static int	GCS_SOURCE_FIELD_NUMBER
static int	INLINE_SOURCE_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
static PurgeDocumentsRequest	getDefaultInstance()
PurgeDocumentsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
PurgeErrorConfig	getErrorConfig() The desired location of errors incurred during the purge.
PurgeErrorConfigOrBuilder	getErrorConfigOrBuilder() The desired location of errors incurred during the purge.
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
boolean	getForce() Actually performs the purge.
GcsSource	getGcsSource() Cloud Storage location for the input content.
GcsSourceOrBuilder	getGcsSourceOrBuilder() Cloud Storage location for the input content.
PurgeDocumentsRequest.InlineSource	getInlineSource() Inline source for the input content for purge.
PurgeDocumentsRequest.InlineSourceOrBuilder	getInlineSourceOrBuilder() Inline source for the input content for purge.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<PurgeDocumentsRequest>	getParserForType()
int	getSerializedSize()
PurgeDocumentsRequest.SourceCase	getSourceCase()
boolean	hasErrorConfig() The desired location of errors incurred during the purge.
boolean	hasGcsSource() Cloud Storage location for the input content.
int	hashCode()
boolean	hasInlineSource() Inline source for the input content for purge.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PurgeDocumentsRequest.Builder	newBuilder()
static PurgeDocumentsRequest.Builder	newBuilder(PurgeDocumentsRequest prototype)
PurgeDocumentsRequest.Builder	newBuilderForType()
protected PurgeDocumentsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PurgeDocumentsRequest	parseDelimitedFrom(InputStream input)
static PurgeDocumentsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeDocumentsRequest	parseFrom(byte[] data)
static PurgeDocumentsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeDocumentsRequest	parseFrom(ByteBuffer data)
static PurgeDocumentsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeDocumentsRequest	parseFrom(com.google.protobuf.ByteString data)
static PurgeDocumentsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeDocumentsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PurgeDocumentsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeDocumentsRequest	parseFrom(InputStream input)
static PurgeDocumentsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PurgeDocumentsRequest>	parser()
PurgeDocumentsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

INLINE_SOURCE_FIELD_NUMBER

public static final int INLINE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_CONFIG_FIELD_NUMBER

public static final int ERROR_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSourceCase

public PurgeDocumentsRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface PurgeDocumentsRequestOrBuilder

hasGcsSource

public boolean hasGcsSource()

 Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
 

.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;

Specified by:

hasGcsSource in interface PurgeDocumentsRequestOrBuilder

Returns:

Whether the gcsSource field is set.

getGcsSource

public GcsSource getGcsSource()

 Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
 

.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;

Specified by:

getGcsSource in interface PurgeDocumentsRequestOrBuilder

Returns:

The gcsSource.

getGcsSourceOrBuilder

public GcsSourceOrBuilder getGcsSourceOrBuilder()

 Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
 

.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;

Specified by:

getGcsSourceOrBuilder in interface PurgeDocumentsRequestOrBuilder

hasInlineSource

public boolean hasInlineSource()

 Inline source for the input content for purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Specified by:

hasInlineSource in interface PurgeDocumentsRequestOrBuilder

Returns:

Whether the inlineSource field is set.

getInlineSource

public PurgeDocumentsRequest.InlineSource getInlineSource()

 Inline source for the input content for purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Specified by:

getInlineSource in interface PurgeDocumentsRequestOrBuilder

Returns:

The inlineSource.

getInlineSourceOrBuilder

public PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 Inline source for the input content for purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Specified by:

getInlineSourceOrBuilder in interface PurgeDocumentsRequestOrBuilder

getParent

public String getParent()

 Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface PurgeDocumentsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface PurgeDocumentsRequestOrBuilder

Returns:

The bytes for parent.

getFilter

public String getFilter()

 Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilter in interface PurgeDocumentsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilterBytes in interface PurgeDocumentsRequestOrBuilder

Returns:

The bytes for filter.

hasErrorConfig

public boolean hasErrorConfig()

 The desired location of errors incurred during the purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Specified by:

hasErrorConfig in interface PurgeDocumentsRequestOrBuilder

Returns:

Whether the errorConfig field is set.

getErrorConfig

public PurgeErrorConfig getErrorConfig()

 The desired location of errors incurred during the purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Specified by:

getErrorConfig in interface PurgeDocumentsRequestOrBuilder

Returns:

The errorConfig.

getErrorConfigOrBuilder

public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()

 The desired location of errors incurred during the purge.
 

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Specified by:

getErrorConfigOrBuilder in interface PurgeDocumentsRequestOrBuilder

getForce

public boolean getForce()

 Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any documents.
 

bool force = 3;

Specified by:

getForce in interface PurgeDocumentsRequestOrBuilder

Returns:

The force.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 PurgeDocumentsRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeDocumentsRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeDocumentsRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeDocumentsRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PurgeDocumentsRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static PurgeDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public PurgeDocumentsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PurgeDocumentsRequest.Builder newBuilder()

newBuilder

public static PurgeDocumentsRequest.Builder newBuilder(PurgeDocumentsRequest prototype)

toBuilder

public PurgeDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PurgeDocumentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PurgeDocumentsRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PurgeDocumentsRequest> 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.GeneratedMessageV3

getDefaultInstanceForType

public PurgeDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder