Reference documentation and code samples for the Google Cloud Channel V1 Client class Customer.
Entity representing a customer of a reseller or distributor.
Generated from protobuf message google.cloud.channel.v1.Customer
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} |
↳ org_display_name |
string
Required. Name of the organization that the customer entity represents. |
↳ org_postal_address |
Google\Type\PostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. |
↳ primary_contact_info |
Google\Cloud\Channel\V1\ContactInfo
Primary contact info. |
↳ alternate_email |
string
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers. |
↳ domain |
string
Required. The customer's primary domain. Must match the primary contact email's domain. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the customer was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the customer was updated. |
↳ cloud_identity_id |
string
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. |
↳ language_code |
string
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
↳ cloud_identity_info |
Google\Cloud\Channel\V1\CloudIdentityInfo
Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. |
↳ channel_partner_id |
string
Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. |
getName
Output only. Resource name of the customer.
Format: accounts/{account_id}/customers/{customer_id}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the customer.
Format: accounts/{account_id}/customers/{customer_id}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrgDisplayName
Required. Name of the organization that the customer entity represents.
Generated from protobuf field string org_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setOrgDisplayName
Required. Name of the organization that the customer entity represents.
Generated from protobuf field string org_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrgPostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
Generated from protobuf field .google.type.PostalAddress org_postal_address = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Type\PostalAddress|null | |
hasOrgPostalAddress
clearOrgPostalAddress
setOrgPostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
Generated from protobuf field .google.type.PostalAddress org_postal_address = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\PostalAddress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrimaryContactInfo
Primary contact info.
Generated from protobuf field .google.cloud.channel.v1.ContactInfo primary_contact_info = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\ContactInfo|null | |
hasPrimaryContactInfo
clearPrimaryContactInfo
setPrimaryContactInfo
Primary contact info.
Generated from protobuf field .google.cloud.channel.v1.ContactInfo primary_contact_info = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\ContactInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlternateEmail
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
Generated from protobuf field string alternate_email = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setAlternateEmail
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
Generated from protobuf field string alternate_email = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDomain
Required. The customer's primary domain. Must match the primary contact email's domain.
Generated from protobuf field string domain = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDomain
Required. The customer's primary domain. Must match the primary contact email's domain.
Generated from protobuf field string domain = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the customer was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the customer was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when the customer was updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the customer was updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudIdentityId
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
Generated from protobuf field string cloud_identity_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setCloudIdentityId
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
Generated from protobuf field string cloud_identity_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Generated from protobuf field string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Generated from protobuf field string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudIdentityInfo
Output only. Cloud Identity information for the customer.
Populated only if a Cloud Identity account exists for this customer.
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo cloud_identity_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\CloudIdentityInfo|null | |
hasCloudIdentityInfo
clearCloudIdentityInfo
setCloudIdentityInfo
Output only. Cloud Identity information for the customer.
Populated only if a Cloud Identity account exists for this customer.
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo cloud_identity_info = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\CloudIdentityInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChannelPartnerId
Cloud Identity ID of the customer's channel partner.
Populated only if a channel partner exists for this customer.
Generated from protobuf field string channel_partner_id = 13;
| Returns | |
|---|---|
| Type | Description |
string | |
setChannelPartnerId
Cloud Identity ID of the customer's channel partner.
Populated only if a channel partner exists for this customer.
Generated from protobuf field string channel_partner_id = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |