Class: Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb

Overview

Request message for IdentityMappingStoreService.PurgeIdentityMappings

Defined Under Namespace

Classes: InlineSource

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

Returns:

  • (::String) —

    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.



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb', line 151

class PurgeIdentityMappingsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source to purge identity mapping entries from.
  # @!attribute [rw] identity_mapping_entries
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
  #     A maximum of 10000 entries can be purged at one time
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#force ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb', line 151

class PurgeIdentityMappingsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source to purge identity mapping entries from.
  # @!attribute [rw] identity_mapping_entries
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
  #     A maximum of 10000 entries can be purged at one time
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#identity_mapping_store ⇒ ::String

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

Returns:

  • (::String) —

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



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb', line 151

class PurgeIdentityMappingsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source to purge identity mapping entries from.
  # @!attribute [rw] identity_mapping_entries
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
  #     A maximum of 10000 entries can be purged at one time
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#inline_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource

Returns The inline source to purge identity mapping entries from.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb', line 151

class PurgeIdentityMappingsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source to purge identity mapping entries from.
  # @!attribute [rw] identity_mapping_entries
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
  #     A maximum of 10000 entries can be purged at one time
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end