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

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

Request message for IdentityMappingStoreService.CreateIdentityMappingStore

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ cmek_config_name string

Resource name of the CmekConfig to use for protecting this Identity Mapping Store.

↳ disable_cmek bool

Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

↳ parent string

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

↳ identity_mapping_store_id string

Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

↳ identity_mapping_store IdentityMappingStore

Required. The Identity Mapping Store to create.

getCmekConfigName

Resource name of the CmekConfig to use for protecting this Identity Mapping Store.

Returns
Type Description
string

hasCmekConfigName

setCmekConfigName

Resource name of the CmekConfig to use for protecting this Identity Mapping Store.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisableCmek

Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

Returns
Type Description
bool

hasDisableCmek

setDisableCmek

Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

Parameter
Name Description
var bool
Returns
Type Description
$this

getParent

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getIdentityMappingStoreId

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

Returns
Type Description
string

setIdentityMappingStoreId

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getIdentityMappingStore

Required. The Identity Mapping Store to create.

Returns
Type Description
IdentityMappingStore|null

hasIdentityMappingStore

clearIdentityMappingStore

setIdentityMappingStore

Required. The Identity Mapping Store to create.

Parameter
Name Description
var IdentityMappingStore
Returns
Type Description
$this

getCmekOptions

Returns
Type Description
string

static::build

Parameters
Name Description
parent string

Required. The parent collection resource name, such as projects/{project}/locations/{location}. Please see IdentityMappingStoreServiceClient::locationName() for help formatting this field.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

Returns
Type Description
CreateIdentityMappingStoreRequest