com.google.cloud.discoveryengine.v1

Class PurgeIdentityMappingsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PurgeIdentityMappingsRequest

public static final class PurgeIdentityMappingsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<PurgeIdentityMappingsRequest.Builder>
implements PurgeIdentityMappingsRequestOrBuilder

 Request message for
 [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]
 

Protobuf type google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest

Method Summary

Modifier and Type	Method and Description
PurgeIdentityMappingsRequest	build()
PurgeIdentityMappingsRequest	buildPartial()
PurgeIdentityMappingsRequest.Builder	clear()
PurgeIdentityMappingsRequest.Builder	clearFilter() Filter matching identity mappings to purge.
PurgeIdentityMappingsRequest.Builder	clearForce() Actually performs the purge.
PurgeIdentityMappingsRequest.Builder	clearIdentityMappingStore() Required.
PurgeIdentityMappingsRequest.Builder	clearInlineSource() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.Builder	clearSource()
PurgeIdentityMappingsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Filter matching identity mappings to purge.
com.google.protobuf.ByteString	getFilterBytes() Filter matching identity mappings to purge.
boolean	getForce() Actually performs the purge.
String	getIdentityMappingStore() Required.
com.google.protobuf.ByteString	getIdentityMappingStoreBytes() Required.
PurgeIdentityMappingsRequest.InlineSource	getInlineSource() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.InlineSource.Builder	getInlineSourceBuilder() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.InlineSourceOrBuilder	getInlineSourceOrBuilder() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.SourceCase	getSourceCase()
boolean	hasForce() Actually performs the purge.
boolean	hasInlineSource() The inline source to purge identity mapping entries from.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
PurgeIdentityMappingsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PurgeIdentityMappingsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
PurgeIdentityMappingsRequest.Builder	mergeFrom(PurgeIdentityMappingsRequest other)
PurgeIdentityMappingsRequest.Builder	mergeInlineSource(PurgeIdentityMappingsRequest.InlineSource value) The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.Builder	setFilter(String value) Filter matching identity mappings to purge.
PurgeIdentityMappingsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Filter matching identity mappings to purge.
PurgeIdentityMappingsRequest.Builder	setForce(boolean value) Actually performs the purge.
PurgeIdentityMappingsRequest.Builder	setIdentityMappingStore(String value) Required.
PurgeIdentityMappingsRequest.Builder	setIdentityMappingStoreBytes(com.google.protobuf.ByteString value) Required.
PurgeIdentityMappingsRequest.Builder	setInlineSource(PurgeIdentityMappingsRequest.InlineSource.Builder builderForValue) The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.Builder	setInlineSource(PurgeIdentityMappingsRequest.InlineSource value) The inline source to purge identity mapping entries from.

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

clear

public PurgeIdentityMappingsRequest.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<PurgeIdentityMappingsRequest.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<PurgeIdentityMappingsRequest.Builder>

getDefaultInstanceForType

public PurgeIdentityMappingsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PurgeIdentityMappingsRequest build()

Specified by:

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

Specified by:

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

buildPartial

public PurgeIdentityMappingsRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public PurgeIdentityMappingsRequest.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<PurgeIdentityMappingsRequest.Builder>

mergeFrom

public PurgeIdentityMappingsRequest.Builder mergeFrom(PurgeIdentityMappingsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public PurgeIdentityMappingsRequest.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<PurgeIdentityMappingsRequest.Builder>

Throws:

IOException

getSourceCase

public PurgeIdentityMappingsRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface PurgeIdentityMappingsRequestOrBuilder

clearSource

public PurgeIdentityMappingsRequest.Builder clearSource()

hasInlineSource

public boolean hasInlineSource()

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Specified by:

hasInlineSource in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

Whether the inlineSource field is set.

getInlineSource

public PurgeIdentityMappingsRequest.InlineSource getInlineSource()

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Specified by:

getInlineSource in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The inlineSource.

setInlineSource

public PurgeIdentityMappingsRequest.Builder setInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

setInlineSource

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

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

mergeInlineSource

public PurgeIdentityMappingsRequest.Builder mergeInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

clearInlineSource

public PurgeIdentityMappingsRequest.Builder clearInlineSource()

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

getInlineSourceBuilder

public PurgeIdentityMappingsRequest.InlineSource.Builder getInlineSourceBuilder()

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

getInlineSourceOrBuilder

public PurgeIdentityMappingsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 The inline source to purge identity mapping entries from.
 

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Specified by:

getInlineSourceOrBuilder in interface PurgeIdentityMappingsRequestOrBuilder

getIdentityMappingStore

public String getIdentityMappingStore()

 Required. The name of the Identity Mapping Store to purge Identity Mapping
 Entries from. Format:
 `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
 

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

Specified by:

getIdentityMappingStore in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The identityMappingStore.

getIdentityMappingStoreBytes

public com.google.protobuf.ByteString getIdentityMappingStoreBytes()

 Required. The name of the Identity Mapping Store to purge Identity Mapping
 Entries from. Format:
 `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
 

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

Specified by:

getIdentityMappingStoreBytes in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The bytes for identityMappingStore.

setIdentityMappingStore

public PurgeIdentityMappingsRequest.Builder setIdentityMappingStore(String value)

 Required. The name of the Identity Mapping Store to purge Identity Mapping
 Entries from. Format:
 `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
 

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

Parameters:

value - The identityMappingStore to set.

Returns:

This builder for chaining.

clearIdentityMappingStore

public PurgeIdentityMappingsRequest.Builder clearIdentityMappingStore()

 Required. The name of the Identity Mapping Store to purge Identity Mapping
 Entries from. Format:
 `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
 

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

Returns:

This builder for chaining.

setIdentityMappingStoreBytes

public PurgeIdentityMappingsRequest.Builder setIdentityMappingStoreBytes(com.google.protobuf.ByteString value)

 Required. The name of the Identity Mapping Store to purge Identity Mapping
 Entries from. Format:
 `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
 

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

Parameters:

value - The bytes for identityMappingStore to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

 Filter matching identity mappings to purge.
 The eligible field for filtering is:
 * `update_time`: in ISO 8601 "zulu" format.
 * `external_id`

 Examples:

 * Deleting all identity mappings updated in a time range:
 `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
 "2012-04-23T18:30:43.511Z"`
 * Deleting all identity mappings for a given external_id:
 `external_id = "id1"`
 * Deleting all identity mappings inside an identity mapping store:
 `*`

 The filtering fields are assumed to have an implicit AND.
 Should not be used with source. An error will be thrown, if both are
 provided.
 

string filter = 3;

Specified by:

getFilter in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Filter matching identity mappings to purge.
 The eligible field for filtering is:
 * `update_time`: in ISO 8601 "zulu" format.
 * `external_id`

 Examples:

 * Deleting all identity mappings updated in a time range:
 `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
 "2012-04-23T18:30:43.511Z"`
 * Deleting all identity mappings for a given external_id:
 `external_id = "id1"`
 * Deleting all identity mappings inside an identity mapping store:
 `*`

 The filtering fields are assumed to have an implicit AND.
 Should not be used with source. An error will be thrown, if both are
 provided.
 

string filter = 3;

Specified by:

getFilterBytes in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public PurgeIdentityMappingsRequest.Builder setFilter(String value)

 Filter matching identity mappings to purge.
 The eligible field for filtering is:
 * `update_time`: in ISO 8601 "zulu" format.
 * `external_id`

 Examples:

 * Deleting all identity mappings updated in a time range:
 `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
 "2012-04-23T18:30:43.511Z"`
 * Deleting all identity mappings for a given external_id:
 `external_id = "id1"`
 * Deleting all identity mappings inside an identity mapping store:
 `*`

 The filtering fields are assumed to have an implicit AND.
 Should not be used with source. An error will be thrown, if both are
 provided.
 

string filter = 3;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public PurgeIdentityMappingsRequest.Builder clearFilter()

 Filter matching identity mappings to purge.
 The eligible field for filtering is:
 * `update_time`: in ISO 8601 "zulu" format.
 * `external_id`

 Examples:

 * Deleting all identity mappings updated in a time range:
 `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
 "2012-04-23T18:30:43.511Z"`
 * Deleting all identity mappings for a given external_id:
 `external_id = "id1"`
 * Deleting all identity mappings inside an identity mapping store:
 `*`

 The filtering fields are assumed to have an implicit AND.
 Should not be used with source. An error will be thrown, if both are
 provided.
 

string filter = 3;

Returns:

This builder for chaining.

setFilterBytes

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

 Filter matching identity mappings to purge.
 The eligible field for filtering is:
 * `update_time`: in ISO 8601 "zulu" format.
 * `external_id`

 Examples:

 * Deleting all identity mappings updated in a time range:
 `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
 "2012-04-23T18:30:43.511Z"`
 * Deleting all identity mappings for a given external_id:
 `external_id = "id1"`
 * Deleting all identity mappings inside an identity mapping store:
 `*`

 The filtering fields are assumed to have an implicit AND.
 Should not be used with source. An error will be thrown, if both are
 provided.
 

string filter = 3;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

hasForce

public boolean hasForce()

 Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any identity mappings. This field is
 only supported for purge with filter. For input source this field is
 ignored and data will be purged regardless of the value of this field.
 

optional bool force = 4;

Specified by:

hasForce in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

Whether the force field is set.

getForce

public boolean getForce()

 Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any identity mappings. This field is
 only supported for purge with filter. For input source this field is
 ignored and data will be purged regardless of the value of this field.
 

optional bool force = 4;

Specified by:

getForce in interface PurgeIdentityMappingsRequestOrBuilder

Returns:

The force.

setForce

public PurgeIdentityMappingsRequest.Builder setForce(boolean value)

 Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any identity mappings. This field is
 only supported for purge with filter. For input source this field is
 ignored and data will be purged regardless of the value of this field.
 

optional bool force = 4;

Parameters:

value - The force to set.

Returns:

This builder for chaining.

clearForce

public PurgeIdentityMappingsRequest.Builder clearForce()

 Actually performs the purge. If `force` is set to false, return the
 expected purge count without deleting any identity mappings. This field is
 only supported for purge with filter. For input source this field is
 ignored and data will be purged regardless of the value of this field.
 

optional bool force = 4;

Returns:

This builder for chaining.