com.google.cloud.discoveryengine.v1

Class PurgeIdentityMappingsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest

All Implemented Interfaces:

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

@Generated
public final class PurgeIdentityMappingsRequest
extends com.google.protobuf.GeneratedMessage
implements PurgeIdentityMappingsRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurgeIdentityMappingsRequest.Builder Request message for [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] Protobuf type google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest
static class	PurgeIdentityMappingsRequest.InlineSource The inline source to purge identity mapping entries from.
static interface	PurgeIdentityMappingsRequest.InlineSourceOrBuilder
static class	PurgeIdentityMappingsRequest.SourceCase

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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	FILTER_FIELD_NUMBER
static int	FORCE_FIELD_NUMBER
static int	IDENTITY_MAPPING_STORE_FIELD_NUMBER
static int	INLINE_SOURCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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 PurgeIdentityMappingsRequest	getDefaultInstance()
PurgeIdentityMappingsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.InlineSourceOrBuilder	getInlineSourceOrBuilder() The inline source to purge identity mapping entries from.
com.google.protobuf.Parser<PurgeIdentityMappingsRequest>	getParserForType()
int	getSerializedSize()
PurgeIdentityMappingsRequest.SourceCase	getSourceCase()
boolean	hasForce() Actually performs the purge.
int	hashCode()
boolean	hasInlineSource() The inline source to purge identity mapping entries from.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PurgeIdentityMappingsRequest.Builder	newBuilder()
static PurgeIdentityMappingsRequest.Builder	newBuilder(PurgeIdentityMappingsRequest prototype)
PurgeIdentityMappingsRequest.Builder	newBuilderForType()
protected PurgeIdentityMappingsRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static PurgeIdentityMappingsRequest	parseDelimitedFrom(InputStream input)
static PurgeIdentityMappingsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeIdentityMappingsRequest	parseFrom(byte[] data)
static PurgeIdentityMappingsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeIdentityMappingsRequest	parseFrom(ByteBuffer data)
static PurgeIdentityMappingsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeIdentityMappingsRequest	parseFrom(com.google.protobuf.ByteString data)
static PurgeIdentityMappingsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeIdentityMappingsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PurgeIdentityMappingsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PurgeIdentityMappingsRequest	parseFrom(InputStream input)
static PurgeIdentityMappingsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PurgeIdentityMappingsRequest>	parser()
PurgeIdentityMappingsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

INLINE_SOURCE_FIELD_NUMBER

public static final int INLINE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

IDENTITY_MAPPING_STORE_FIELD_NUMBER

public static final int IDENTITY_MAPPING_STORE_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER

See Also:

Constant Field Values

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

getSourceCase

public PurgeIdentityMappingsRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface PurgeIdentityMappingsRequestOrBuilder

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PurgeIdentityMappingsRequest parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PurgeIdentityMappingsRequest parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public PurgeIdentityMappingsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PurgeIdentityMappingsRequest.Builder newBuilder()

newBuilder

public static PurgeIdentityMappingsRequest.Builder newBuilder(PurgeIdentityMappingsRequest prototype)

toBuilder

public PurgeIdentityMappingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PurgeIdentityMappingsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static PurgeIdentityMappingsRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PurgeIdentityMappingsRequest> 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.GeneratedMessage

getDefaultInstanceForType

public PurgeIdentityMappingsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder