Class Tenant.Builder (2.84.0) 

public static final class Tenant.Builder extends GeneratedMessage.Builder<Tenant.Builder> implements TenantOrBuilder

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.

Protobuf type google.cloud.talent.v4beta1.Tenant

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Tenant.Builder

Implements

TenantOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllKeywordSearchableProfileCustomAttributes(Iterable<String> values)

public Tenant.Builder addAllKeywordSearchableProfileCustomAttributes(Iterable<String> values)

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
values Iterable<String>

The keywordSearchableProfileCustomAttributes to add.
Returns
Type Description
Tenant.Builder

This builder for chaining.

addKeywordSearchableProfileCustomAttributes(String value)

public Tenant.Builder addKeywordSearchableProfileCustomAttributes(String value)

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
value String

The keywordSearchableProfileCustomAttributes to add.
Returns
Type Description
Tenant.Builder

This builder for chaining.

addKeywordSearchableProfileCustomAttributesBytes(ByteString value)

public Tenant.Builder addKeywordSearchableProfileCustomAttributesBytes(ByteString value)

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
value ByteString

The bytes of the keywordSearchableProfileCustomAttributes to add.
Returns
Type Description
Tenant.Builder

This builder for chaining.

build()

public Tenant build()
Returns
Type Description
Tenant

buildPartial()

public Tenant buildPartial()
Returns
Type Description
Tenant

clear()

public Tenant.Builder clear()
Returns
Type Description
Tenant.Builder
Overrides

clearExternalId()

public Tenant.Builder clearExternalId()

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
Tenant.Builder

This builder for chaining.

clearKeywordSearchableProfileCustomAttributes()

public Tenant.Builder clearKeywordSearchableProfileCustomAttributes()

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
Tenant.Builder

This builder for chaining.

clearName()

public Tenant.Builder clearName()

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
Tenant.Builder

This builder for chaining.

clearUsageType()

public Tenant.Builder clearUsageType()

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

This builder for chaining.

getDefaultInstanceForType()

public Tenant getDefaultInstanceForType()
Returns
Type Description
Tenant

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExternalId()

public 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the keywordSearchableProfileCustomAttributes.

getName()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Tenant other)

public Tenant.Builder mergeFrom(Tenant other)
Parameter
Name Description
other Tenant
Returns
Type Description
Tenant.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tenant.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Tenant.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Tenant.Builder
Overrides

setExternalId(String value)

public Tenant.Builder setExternalId(String value)

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];

Parameter
Name Description
value String

The externalId to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setExternalIdBytes(ByteString value)

public Tenant.Builder setExternalIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for externalId to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setKeywordSearchableProfileCustomAttributes(int index, String value)

public Tenant.Builder setKeywordSearchableProfileCustomAttributes(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The keywordSearchableProfileCustomAttributes to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setName(String value)

public Tenant.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Tenant.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setUsageType(Tenant.DataUsageType value)

public Tenant.Builder setUsageType(Tenant.DataUsageType value)

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;

Parameter
Name Description
value Tenant.DataUsageType

The usageType to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.

setUsageTypeValue(int value)

public Tenant.Builder setUsageTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for usageType to set.
Returns
Type Description
Tenant.Builder

This builder for chaining.