Google Cloud Channel V1 Client - Class ImportCustomerRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Channel V1 Client class ImportCustomerRequest.

Request message for CloudChannelService.ImportCustomer

Generated from protobuf message google.cloud.channel.v1.ImportCustomerRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ domain`	`string` Required. Customer domain.
`↳ cloud_identity_id`	`string` Required. Customer's Cloud Identity ID
`↳ parent`	`string` Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
`↳ auth_token`	`string` Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
`↳ overwrite_if_exists`	`bool` Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain.
`↳ channel_partner_id`	`string` Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.
`↳ customer`	`string` Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}

getDomain

Required. Customer domain.

Generated from protobuf field string domain = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

hasDomain

setDomain

Required. Customer domain.

Generated from protobuf field string domain = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCloudIdentityId

Required. Customer's Cloud Identity ID

Generated from protobuf field string cloud_identity_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

hasCloudIdentityId

setCloudIdentityId

Required. Customer's Cloud Identity ID

Generated from protobuf field string cloud_identity_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParent

Required. The resource name of the reseller's account.

Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setParent

Required. The resource name of the reseller's account.

Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAuthToken

Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization.

See https://support.google.com/a/answer/7643790 for more details.

Generated from protobuf field string auth_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setAuthToken

See https://support.google.com/a/answer/7643790 for more details.

Generated from protobuf field string auth_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOverwriteIfExists

Required. Choose to overwrite an existing customer if found.

This must be set to true if there is an existing customer with a conflicting region code or domain.

Generated from protobuf field bool overwrite_if_exists = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`bool`

setOverwriteIfExists

Required. Choose to overwrite an existing customer if found.

This must be set to true if there is an existing customer with a conflicting region code or domain.

Generated from protobuf field bool overwrite_if_exists = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getChannelPartnerId

Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.

Generated from protobuf field string channel_partner_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setChannelPartnerId

Generated from protobuf field string channel_partner_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomer

Optional. Specifies the customer that will receive imported Cloud Identity information.

Format: accounts/{account_id}/customers/{customer_id}

Generated from protobuf field string customer = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setCustomer

Optional. Specifies the customer that will receive imported Cloud Identity information.

Format: accounts/{account_id}/customers/{customer_id}

Generated from protobuf field string customer = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomerIdentity

Returns
Type	Description
`string`