Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 Client class Tenant.
A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups.
Generated from protobuf message google.cloud.talent.v4beta1.Tenant
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
↳ external_id
string
Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.
↳ usage_type
int
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants. Defaults behavior is DataUsageType.ISOLATED if it's unset.
↳ keyword_searchable_profile_custom_attributes
array
A list of keys of filterable Profile.custom_attributes
, whose corresponding string_values
are used in keyword searches. Profiles with string_values
under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and must be surrounded by quotes.
getName
Required during tenant update.
The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
string
setName
Required during tenant update.
The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
var
string
$this
getExternalId
Required. Client side tenant identifier, used to uniquely identify the tenant.
The maximum number of allowed characters is 255.
string
setExternalId
Required. Client side tenant identifier, used to uniquely identify the tenant.
The maximum number of allowed characters is 255.
var
string
$this
getUsageType
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.
Defaults behavior is DataUsageType.ISOLATED if it's unset.
int
setUsageType
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.
Defaults behavior is DataUsageType.ISOLATED if it's unset.
var
int
$this
getKeywordSearchableProfileCustomAttributes
A list of keys of filterable Profile.custom_attributes
,
whose corresponding string_values
are used in keyword searches. Profiles
with string_values
under these specified field keys are returned if any
of the values match the search keyword. Custom field values with
parenthesis, brackets and special symbols are not searchable as-is,
and must be surrounded by quotes.
setKeywordSearchableProfileCustomAttributes
A list of keys of filterable Profile.custom_attributes
,
whose corresponding string_values
are used in keyword searches. Profiles
with string_values
under these specified field keys are returned if any
of the values match the search keyword. Custom field values with
parenthesis, brackets and special symbols are not searchable as-is,
and must be surrounded by quotes.
var
string[]
$this
