Cloud Talent Solution V4beta1 API - Class Google::Cloud::Talent::V4beta1::Tenant (v0.12.0)

Reference documentation and code samples for the Cloud Talent Solution V4beta1 API class Google::Cloud::Talent::V4beta1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#external_id

def external_id() -> ::String
Returns
  • (::String) — Required. Client side tenant identifier, used to uniquely identify the tenant.

    The maximum number of allowed characters is 255.

#external_id=

def external_id=(value) -> ::String
Parameter
  • value (::String) — Required. Client side tenant identifier, used to uniquely identify the tenant.

    The maximum number of allowed characters is 255.

Returns
  • (::String) — Required. Client side tenant identifier, used to uniquely identify the tenant.

    The maximum number of allowed characters is 255.

#keyword_searchable_profile_custom_attributes

def keyword_searchable_profile_custom_attributes() -> ::Array<::String>
Returns
  • (::Array<::String>) — A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.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.

#keyword_searchable_profile_custom_attributes=

def keyword_searchable_profile_custom_attributes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.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.
Returns
  • (::Array<::String>) — A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.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.

#name

def name() -> ::String
Returns
  • (::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".

#name=

def name=(value) -> ::String
Parameter
  • value (::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".

Returns
  • (::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".

#usage_type

def usage_type() -> ::Google::Cloud::Talent::V4beta1::Tenant::DataUsageType
Returns

#usage_type=

def usage_type=(value) -> ::Google::Cloud::Talent::V4beta1::Tenant::DataUsageType
Parameter
Returns