Class Tenant (2.43.0) 

public final class Tenant extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Tenant

Implements

TenantOrBuilder

Static Fields

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
Type Description
int

KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER

public static final int KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

USAGE_TYPE_FIELD_NUMBER

public static final int USAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Tenant getDefaultInstance()
Returns
Type Description
Tenant

getDescriptor()

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

newBuilder()

public static Tenant.Builder newBuilder()
Returns
Type Description
Tenant.Builder

newBuilder(Tenant prototype)

public static Tenant.Builder newBuilder(Tenant prototype)
Parameter
Name Description
prototype Tenant
Returns
Type Description
Tenant.Builder

parseDelimitedFrom(InputStream input)

public static Tenant parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Tenant parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Tenant parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Tenant parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Tenant parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Tenant parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tenant
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Tenant> parser()
Returns
Type Description
Parser<Tenant>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Tenant getDefaultInstanceForType()
Returns
Type Description
Tenant

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.

getParserForType()

public Parser<Tenant> getParserForType()
Returns
Type Description
Parser<Tenant>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Tenant.Builder newBuilderForType()
Returns
Type Description
Tenant.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Tenant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Tenant.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Tenant.Builder toBuilder()
Returns
Type Description
Tenant.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException