Class PurgeIdentityMappingsRequest.Builder (0.60.0)
Stay organized with collections Save and categorize content based on your preferences.

public static final class PurgeIdentityMappingsRequest.Builder extends GeneratedMessageV3.Builder<PurgeIdentityMappingsRequest.Builder> implements PurgeIdentityMappingsRequestOrBuilder

Request message for IdentityMappingStoreService.PurgeIdentityMappings

Protobuf type google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeIdentityMappingsRequest.Builder

Implements

PurgeIdentityMappingsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PurgeIdentityMappingsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PurgeIdentityMappingsRequest build()

Returns
Type	Description
`PurgeIdentityMappingsRequest`

buildPartial()

public PurgeIdentityMappingsRequest buildPartial()

Returns
Type	Description
`PurgeIdentityMappingsRequest`

clear()

public PurgeIdentityMappingsRequest.Builder clear()

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public PurgeIdentityMappingsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
`PurgeIdentityMappingsRequest.Builder`	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
Type	Description
`PurgeIdentityMappingsRequest.Builder`	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
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

clearInlineSource()

public PurgeIdentityMappingsRequest.Builder clearInlineSource()

The inline source to purge identity mapping entries from.

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

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public PurgeIdentityMappingsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSource()

public PurgeIdentityMappingsRequest.Builder clearSource()

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

clone()

public PurgeIdentityMappingsRequest.Builder clone()

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public PurgeIdentityMappingsRequest getDefaultInstanceForType()

Returns
Type	Description
`PurgeIdentityMappingsRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public 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;

Returns
Type	Description
`ByteString`	The bytes for filter.

getForce()

public boolean getForce()

optional bool force = 4;

Returns
Type	Description
`boolean`	The force.

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

Returns
Type	Description
`String`	The identityMappingStore.

getIdentityMappingStoreBytes()

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

Returns
Type	Description
`ByteString`	The bytes for identityMappingStore.

getInlineSource()

public PurgeIdentityMappingsRequest.InlineSource getInlineSource()

The inline source to purge identity mapping entries from.

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

Returns
Type	Description
`PurgeIdentityMappingsRequest.InlineSource`	The inlineSource.

getInlineSourceBuilder()

public PurgeIdentityMappingsRequest.InlineSource.Builder getInlineSourceBuilder()

The inline source to purge identity mapping entries from.

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

Returns
Type	Description
`PurgeIdentityMappingsRequest.InlineSource.Builder`

getInlineSourceOrBuilder()

public PurgeIdentityMappingsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

The inline source to purge identity mapping entries from.

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

Returns
Type	Description
`PurgeIdentityMappingsRequest.InlineSourceOrBuilder`

getSourceCase()

public PurgeIdentityMappingsRequest.SourceCase getSourceCase()

Returns
Type	Description
`PurgeIdentityMappingsRequest.SourceCase`

hasForce()

public boolean hasForce()

optional bool force = 4;

Returns
Type	Description
`boolean`	Whether the force field is set.

hasInlineSource()

public boolean hasInlineSource()

The inline source to purge identity mapping entries from.

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

Returns
Type	Description
`boolean`	Whether the inlineSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(PurgeIdentityMappingsRequest other)

public PurgeIdentityMappingsRequest.Builder mergeFrom(PurgeIdentityMappingsRequest other)

Parameter
Name	Description
`other`	`PurgeIdentityMappingsRequest`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PurgeIdentityMappingsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PurgeIdentityMappingsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

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;

Parameter
Name	Description
`value`	`PurgeIdentityMappingsRequest.InlineSource`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurgeIdentityMappingsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public PurgeIdentityMappingsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

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;

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

setForce(boolean value)

public PurgeIdentityMappingsRequest.Builder setForce(boolean value)

optional bool force = 4;

Parameter
Name	Description
`value`	`boolean` The force to set.

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

setIdentityMappingStore(String value)

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

Parameter
Name	Description
`value`	`String` The identityMappingStore to set.

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

setIdentityMappingStoreBytes(ByteString value)

public PurgeIdentityMappingsRequest.Builder setIdentityMappingStoreBytes(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) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for identityMappingStore to set.

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`	This builder for chaining.

setInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

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;

Parameter
Name	Description
`value`	`PurgeIdentityMappingsRequest.InlineSource`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

setInlineSource(PurgeIdentityMappingsRequest.InlineSource.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`PurgeIdentityMappingsRequest.InlineSource.Builder`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PurgeIdentityMappingsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PurgeIdentityMappingsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PurgeIdentityMappingsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

Class PurgeIdentityMappingsRequest.Builder (0.60.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

getDescriptor()

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

buildPartial()

clear()

clearField(Descriptors.FieldDescriptor field)

clearFilter()

clearForce()

clearIdentityMappingStore()

clearInlineSource()

clearOneof(Descriptors.OneofDescriptor oneof)

clearSource()

clone()

getDefaultInstanceForType()

getDescriptorForType()

getFilter()

getFilterBytes()

getForce()

getIdentityMappingStore()

getIdentityMappingStoreBytes()

getInlineSource()

getInlineSourceBuilder()

getInlineSourceOrBuilder()

getSourceCase()

hasForce()

hasInlineSource()

internalGetFieldAccessorTable()

isInitialized()

mergeFrom(PurgeIdentityMappingsRequest other)

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

mergeFrom(Message other)

mergeInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

setFilterBytes(ByteString value)

setForce(boolean value)

setIdentityMappingStore(String value)

setIdentityMappingStoreBytes(ByteString value)

setInlineSource(PurgeIdentityMappingsRequest.InlineSource value)

setInlineSource(PurgeIdentityMappingsRequest.InlineSource.Builder builderForValue)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

Class PurgeIdentityMappingsRequest.Builder (0.60.0)
Stay organized with collections Save and categorize content based on your preferences.