Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IdentityMappingStore.
Identity Mapping Store which contains Identity Mapping Entries.
Generated from protobuf messagegoogle.cloud.discoveryengine.v1.IdentityMappingStore
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. The full resource name of the identity mapping store. Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
↳ kms_key_name
string
Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.
Output only. CMEK-related information for the Identity Mapping Store.
getName
Immutable. The full resource name of the identity mapping store.
Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
Returns
Type
Description
string
setName
Immutable. The full resource name of the identity mapping store.
Format:projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getKmsKeyName
Input only. The KMS key to be used to protect this Identity Mapping Store
at creation time.
Must be set for requests that need to comply with CMEK Org Policy
protections.
If this field is set and processed successfully, the Identity Mapping Store
will be protected by the KMS key, as indicated in the cmek_config field.
Returns
Type
Description
string
setKmsKeyName
Input only. The KMS key to be used to protect this Identity Mapping Store
at creation time.
Must be set for requests that need to comply with CMEK Org Policy
protections.
If this field is set and processed successfully, the Identity Mapping Store
will be protected by the KMS key, as indicated in the cmek_config field.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCmekConfig
Output only. CMEK-related information for the Identity Mapping Store.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class IdentityMappingStore (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingStore)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.IdentityMappingStore)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.IdentityMappingStore)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.IdentityMappingStore)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.IdentityMappingStore)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.IdentityMappingStore)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.IdentityMappingStore)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.IdentityMappingStore)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.IdentityMappingStore)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.IdentityMappingStore)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.IdentityMappingStore)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.IdentityMappingStore)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.IdentityMappingStore)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.IdentityMappingStore)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.IdentityMappingStore)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.IdentityMappingStore)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.IdentityMappingStore) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IdentityMappingStore.\n\nIdentity Mapping Store which contains Identity Mapping Entries.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.IdentityMappingStore`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nImmutable. The full resource name of the identity mapping store.\n\nFormat:\n`projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.\nThis field must be a UTF-8 encoded string with a length limit of 1024\ncharacters.\n\n### setName\n\nImmutable. The full resource name of the identity mapping store.\n\nFormat:\n`projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.\nThis field must be a UTF-8 encoded string with a length limit of 1024\ncharacters.\n\n### getKmsKeyName\n\nInput only. The KMS key to be used to protect this Identity Mapping Store\nat creation time.\n\nMust be set for requests that need to comply with CMEK Org Policy\nprotections.\nIf this field is set and processed successfully, the Identity Mapping Store\nwill be protected by the KMS key, as indicated in the cmek_config field.\n\n### setKmsKeyName\n\nInput only. The KMS key to be used to protect this Identity Mapping Store\nat creation time.\n\nMust be set for requests that need to comply with CMEK Org Policy\nprotections.\nIf this field is set and processed successfully, the Identity Mapping Store\nwill be protected by the KMS key, as indicated in the cmek_config field.\n\n### getCmekConfig\n\nOutput only. CMEK-related information for the Identity Mapping Store.\n\n### hasCmekConfig\n\n### clearCmekConfig\n\n### setCmekConfig\n\nOutput only. CMEK-related information for the Identity Mapping Store."]]
