Class Tenant.Builder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 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 static final class Tenant.Builder extends GeneratedMessageV3.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

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tenant.Builder

Implements

TenantOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Tenant.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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.

clearField(Descriptors.FieldDescriptor field)

public Tenant.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public Tenant.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

clone()

public Tenant.Builder clone()

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Tenant getDefaultInstanceForType()

Returns
Type	Description
Tenant

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Tenant.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Tenant.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Tenant.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.

setField(Descriptors.FieldDescriptor field, Object value)

public Tenant.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Tenant.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Tenant.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tenant.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.