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 message google.cloud.discoveryengine.v1.IdentityMappingStore
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__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: |
↳ 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. |
↳ cmek_config |
CmekConfig
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.
Returns | |
---|---|
Type | Description |
CmekConfig|null |
hasCmekConfig
clearCmekConfig
setCmekConfig
Output only. CMEK-related information for the Identity Mapping Store.
Parameter | |
---|---|
Name | Description |
var |
CmekConfig
|
Returns | |
---|---|
Type | Description |
$this |