Google Cloud Discovery Engine V1 Client - Class PurgeIdentityMappingsRequest (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeIdentityMappingsRequest.

Request message for IdentityMappingStoreService.PurgeIdentityMappings

Generated from protobuf message google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ inline_source`	`PurgeIdentityMappingsRequest\InlineSource` The inline source to purge identity mapping entries from.
`↳ identity_mapping_store`	`string` Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`↳ filter`	`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.
`↳ force`	`bool` 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.

getInlineSource

The inline source to purge identity mapping entries from.

Returns
Type	Description
`PurgeIdentityMappingsRequest\InlineSource\|null`

hasInlineSource

setInlineSource

The inline source to purge identity mapping entries from.

Parameter
Name	Description
`var`	`PurgeIdentityMappingsRequest\InlineSource`

Returns
Type	Description
`$this`

getIdentityMappingStore

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

Returns
Type	Description
`string`

setIdentityMappingStore

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

setFilter