Class: Google::Cloud::Talent::V4beta1::Tenant

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/talent/v4beta1/tenant.rb

Overview

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.

Defined Under Namespace

Modules: DataUsageType

Instance Attribute Summary collapse

Instance Attribute Details

#external_id ⇒ ::String

Returns 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.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/talent/v4beta1/tenant.rb', line 60

class Tenant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents how user data owned by the tenant is used.
  module DataUsageType
    # Default value.
    DATA_USAGE_TYPE_UNSPECIFIED = 0

    # Data owned by this tenant is used to improve search/recommendation
    # quality across tenants.
    AGGREGATED = 1

    # Data owned by this tenant is used to improve search/recommendation
    # quality for this tenant only.
    ISOLATED = 2
  end
end

#keyword_searchable_profile_custom_attributes ⇒ ::Array<::String>

Returns 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.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/talent/v4beta1/tenant.rb', line 60

class Tenant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents how user data owned by the tenant is used.
  module DataUsageType
    # Default value.
    DATA_USAGE_TYPE_UNSPECIFIED = 0

    # Data owned by this tenant is used to improve search/recommendation
    # quality across tenants.
    AGGREGATED = 1

    # Data owned by this tenant is used to improve search/recommendation
    # quality for this tenant only.
    ISOLATED = 2
  end
end

#name ⇒ ::String

Returns 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".



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/talent/v4beta1/tenant.rb', line 60

class Tenant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents how user data owned by the tenant is used.
  module DataUsageType
    # Default value.
    DATA_USAGE_TYPE_UNSPECIFIED = 0

    # Data owned by this tenant is used to improve search/recommendation
    # quality across tenants.
    AGGREGATED = 1

    # Data owned by this tenant is used to improve search/recommendation
    # quality for this tenant only.
    ISOLATED = 2
  end
end

#usage_type ⇒ ::Google::Cloud::Talent::V4beta1::Tenant::DataUsageType

Returns 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.

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/talent/v4beta1/tenant.rb', line 60

class Tenant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents how user data owned by the tenant is used.
  module DataUsageType
    # Default value.
    DATA_USAGE_TYPE_UNSPECIFIED = 0

    # Data owned by this tenant is used to improve search/recommendation
    # quality across tenants.
    AGGREGATED = 1

    # Data owned by this tenant is used to improve search/recommendation
    # quality for this tenant only.
    ISOLATED = 2
  end
end