Reference documentation and code samples for the Google Cloud Channel V1 Client class CloudIdentityInfo.
Cloud Identity information for the Cloud Channel Customer.
Generated from protobuf message google.cloud.channel.v1.CloudIdentityInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ customer_type |
int
CustomerType indicates verification type needed for using services. |
↳ primary_domain |
string
Output only. The primary domain name. |
↳ is_domain_verified |
bool
Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. |
↳ alternate_email |
string
The alternate email. |
↳ phone_number |
string
Phone number associated with the Cloud Identity. |
↳ language_code |
string
Language code. |
↳ admin_console_uri |
string
Output only. URI of Customer's Admin console dashboard. |
↳ edu_data |
Google\Cloud\Channel\V1\EduData
Edu information about the customer. |
getCustomerType
CustomerType indicates verification type needed for using services.
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo.CustomerType customer_type = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setCustomerType
CustomerType indicates verification type needed for using services.
Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo.CustomerType customer_type = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrimaryDomain
Output only. The primary domain name.
Generated from protobuf field string primary_domain = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setPrimaryDomain
Output only. The primary domain name.
Generated from protobuf field string primary_domain = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIsDomainVerified
Output only. Whether the domain is verified.
This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
Generated from protobuf field bool is_domain_verified = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
bool | |
setIsDomainVerified
Output only. Whether the domain is verified.
This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
Generated from protobuf field bool is_domain_verified = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlternateEmail
The alternate email.
Generated from protobuf field string alternate_email = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setAlternateEmail
The alternate email.
Generated from protobuf field string alternate_email = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPhoneNumber
Phone number associated with the Cloud Identity.
Generated from protobuf field string phone_number = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setPhoneNumber
Phone number associated with the Cloud Identity.
Generated from protobuf field string phone_number = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
Language code.
Generated from protobuf field string language_code = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Language code.
Generated from protobuf field string language_code = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdminConsoleUri
Output only. URI of Customer's Admin console dashboard.
Generated from protobuf field string admin_console_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setAdminConsoleUri
Output only. URI of Customer's Admin console dashboard.
Generated from protobuf field string admin_console_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEduData
Edu information about the customer.
Generated from protobuf field .google.cloud.channel.v1.EduData edu_data = 22;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\EduData|null | |
hasEduData
clearEduData
setEduData
Edu information about the customer.
Generated from protobuf field .google.cloud.channel.v1.EduData edu_data = 22;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\EduData
|
| Returns | |
|---|---|
| Type | Description |
$this | |