Interface TenantOrBuilder (2.23.0)

Version 2.23.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

public interface TenantOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExternalId()

public abstract String getExternalId()

Required. Client side tenant identifier, used to uniquely identify the tenant.

The maximum number of allowed characters is 255.

string external_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The externalId.

getExternalIdBytes()

public abstract ByteString getExternalIdBytes()

Required. Client side tenant identifier, used to uniquely identify the tenant.

The maximum number of allowed characters is 255.

string external_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for externalId.

getKeywordSearchableProfileCustomAttributes(int index)

public abstract String getKeywordSearchableProfileCustomAttributes(int index)

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.

repeated string keyword_searchable_profile_custom_attributes = 4;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The keywordSearchableProfileCustomAttributes at the given index.

getKeywordSearchableProfileCustomAttributesBytes(int index)

public abstract ByteString getKeywordSearchableProfileCustomAttributesBytes(int index)

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.

repeated string keyword_searchable_profile_custom_attributes = 4;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the keywordSearchableProfileCustomAttributes at the given index.

getKeywordSearchableProfileCustomAttributesCount()

public abstract int getKeywordSearchableProfileCustomAttributesCount()

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.

repeated string keyword_searchable_profile_custom_attributes = 4;

Returns
Type	Description
int	The count of keywordSearchableProfileCustomAttributes.

getKeywordSearchableProfileCustomAttributesList()

public abstract List<String> getKeywordSearchableProfileCustomAttributesList()

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.

repeated string keyword_searchable_profile_custom_attributes = 4;

Returns
Type	Description
List<String>	A list containing the keywordSearchableProfileCustomAttributes.

getName()

public abstract String 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 name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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 name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getUsageType()

public abstract Tenant.DataUsageType 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.

.google.cloud.talent.v4beta1.Tenant.DataUsageType usage_type = 3;

Returns
Type	Description
Tenant.DataUsageType	The usageType.

getUsageTypeValue()

public abstract int getUsageTypeValue()

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.

.google.cloud.talent.v4beta1.Tenant.DataUsageType usage_type = 3;

Returns
Type	Description
int	The enum numeric value on the wire for usageType.