com.google.cloud.discoveryengine.v1

Class PurgeDocumentsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<PurgeDocumentsRequest.Builder>

com.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.Builder

All Implemented Interfaces:

PurgeDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PurgeDocumentsRequest

public static final class PurgeDocumentsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<PurgeDocumentsRequest.Builder>
implements PurgeDocumentsRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest

Method Summary

Modifier and Type	Method and Description
PurgeDocumentsRequest	build()
PurgeDocumentsRequest	buildPartial()
PurgeDocumentsRequest.Builder	clear()
PurgeDocumentsRequest.Builder	clearErrorConfig() The desired location of errors incurred during the purge.
PurgeDocumentsRequest.Builder	clearFilter() Required.
PurgeDocumentsRequest.Builder	clearForce() Actually performs the purge.
PurgeDocumentsRequest.Builder	clearGcsSource() Cloud Storage location for the input content.
PurgeDocumentsRequest.Builder	clearInlineSource() Inline source for the input content for purge.
PurgeDocumentsRequest.Builder	clearParent() Required.
PurgeDocumentsRequest.Builder	clearSource()
PurgeDocumentsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
PurgeErrorConfig	getErrorConfig() The desired location of errors incurred during the purge.
PurgeErrorConfig.Builder	getErrorConfigBuilder() 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.
GcsSource.Builder	getGcsSourceBuilder() 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.InlineSource.Builder	getInlineSourceBuilder() 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.
PurgeDocumentsRequest.SourceCase	getSourceCase()
boolean	hasErrorConfig() The desired location of errors incurred during the purge.
boolean	hasGcsSource() Cloud Storage location for the input content.
boolean	hasInlineSource() Inline source for the input content for purge.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
PurgeDocumentsRequest.Builder	mergeErrorConfig(PurgeErrorConfig value) The desired location of errors incurred during the purge.
PurgeDocumentsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PurgeDocumentsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
PurgeDocumentsRequest.Builder	mergeFrom(PurgeDocumentsRequest other)
PurgeDocumentsRequest.Builder	mergeGcsSource(GcsSource value) Cloud Storage location for the input content.
PurgeDocumentsRequest.Builder	mergeInlineSource(PurgeDocumentsRequest.InlineSource value) Inline source for the input content for purge.
PurgeDocumentsRequest.Builder	setErrorConfig(PurgeErrorConfig.Builder builderForValue) The desired location of errors incurred during the purge.
PurgeDocumentsRequest.Builder	setErrorConfig(PurgeErrorConfig value) The desired location of errors incurred during the purge.
PurgeDocumentsRequest.Builder	setFilter(String value) Required.
PurgeDocumentsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Required.
PurgeDocumentsRequest.Builder	setForce(boolean value) Actually performs the purge.
PurgeDocumentsRequest.Builder	setGcsSource(GcsSource.Builder builderForValue) Cloud Storage location for the input content.
PurgeDocumentsRequest.Builder	setGcsSource(GcsSource value) Cloud Storage location for the input content.
PurgeDocumentsRequest.Builder	setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue) Inline source for the input content for purge.
PurgeDocumentsRequest.Builder	setInlineSource(PurgeDocumentsRequest.InlineSource value) Inline source for the input content for purge.
PurgeDocumentsRequest.Builder	setParent(String value) Required.
PurgeDocumentsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<PurgeDocumentsRequest.Builder>

clear

public PurgeDocumentsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<PurgeDocumentsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PurgeDocumentsRequest.Builder>

getDefaultInstanceForType

public PurgeDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PurgeDocumentsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PurgeDocumentsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public PurgeDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeDocumentsRequest.Builder>

mergeFrom

public PurgeDocumentsRequest.Builder mergeFrom(PurgeDocumentsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PurgeDocumentsRequest.Builder>

mergeFrom

public PurgeDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeDocumentsRequest.Builder>

Throws:

IOException

getSourceCase

public PurgeDocumentsRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface PurgeDocumentsRequestOrBuilder

clearSource

public PurgeDocumentsRequest.Builder clearSource()

hasGcsSource

public boolean hasGcsSource()

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

.google.cloud.discoveryengine.v1.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.v1.Document.id] per line.
 

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

Specified by:

getGcsSource in interface PurgeDocumentsRequestOrBuilder

Returns:

The gcsSource.

setGcsSource

public PurgeDocumentsRequest.Builder setGcsSource(GcsSource value)

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

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

setGcsSource

public PurgeDocumentsRequest.Builder setGcsSource(GcsSource.Builder builderForValue)

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

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

mergeGcsSource

public PurgeDocumentsRequest.Builder mergeGcsSource(GcsSource value)

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

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

clearGcsSource

public PurgeDocumentsRequest.Builder clearGcsSource()

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

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

getGcsSourceBuilder

public GcsSource.Builder getGcsSourceBuilder()

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

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

getGcsSourceOrBuilder

public GcsSourceOrBuilder getGcsSourceOrBuilder()

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

.google.cloud.discoveryengine.v1.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.v1.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.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;

Specified by:

getInlineSource in interface PurgeDocumentsRequestOrBuilder

Returns:

The inlineSource.

setInlineSource

public PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource value)

 Inline source for the input content for purge.
 

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

setInlineSource

public PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue)

 Inline source for the input content for purge.
 

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

mergeInlineSource

public PurgeDocumentsRequest.Builder mergeInlineSource(PurgeDocumentsRequest.InlineSource value)

 Inline source for the input content for purge.
 

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

clearInlineSource

public PurgeDocumentsRequest.Builder clearInlineSource()

 Inline source for the input content for purge.
 

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

getInlineSourceBuilder

public PurgeDocumentsRequest.InlineSource.Builder getInlineSourceBuilder()

 Inline source for the input content for purge.
 

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

getInlineSourceOrBuilder

public PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 Inline source for the input content for purge.
 

.google.cloud.discoveryengine.v1.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.

setParent

public PurgeDocumentsRequest.Builder setParent(String value)

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

Parameters:

value - The parent to set.

Returns:

This builder for chaining.

clearParent

public PurgeDocumentsRequest.Builder clearParent()

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

Returns:

This builder for chaining.

setParentBytes

public PurgeDocumentsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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.

setFilter

public PurgeDocumentsRequest.Builder setFilter(String value)

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

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public PurgeDocumentsRequest.Builder clearFilter()

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

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

Returns:

This builder for chaining.

setFilterBytes

public PurgeDocumentsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

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

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

hasErrorConfig

public boolean hasErrorConfig()

 The desired location of errors incurred during the purge.
 

.google.cloud.discoveryengine.v1.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.v1.PurgeErrorConfig error_config = 7;

Specified by:

getErrorConfig in interface PurgeDocumentsRequestOrBuilder

Returns:

The errorConfig.

setErrorConfig

public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig value)

 The desired location of errors incurred during the purge.
 

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

setErrorConfig

public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig.Builder builderForValue)

 The desired location of errors incurred during the purge.
 

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

mergeErrorConfig

public PurgeDocumentsRequest.Builder mergeErrorConfig(PurgeErrorConfig value)

 The desired location of errors incurred during the purge.
 

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

clearErrorConfig

public PurgeDocumentsRequest.Builder clearErrorConfig()

 The desired location of errors incurred during the purge.
 

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

getErrorConfigBuilder

public PurgeErrorConfig.Builder getErrorConfigBuilder()

 The desired location of errors incurred during the purge.
 

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

getErrorConfigOrBuilder

public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()

 The desired location of errors incurred during the purge.
 

.google.cloud.discoveryengine.v1.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.

setForce

public PurgeDocumentsRequest.Builder setForce(boolean value)

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

bool force = 3;

Parameters:

value - The force to set.

Returns:

This builder for chaining.

clearForce

public PurgeDocumentsRequest.Builder clearForce()

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

bool force = 3;

Returns:

This builder for chaining.