Class Tenant (2.7.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

Implements

TenantOrBuilder

Static Fields

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER

public static final int KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

USAGE_TYPE_FIELD_NUMBER

public static final int USAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Tenant getDefaultInstance()
Returns
TypeDescription
Tenant

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Tenant.Builder newBuilder()
Returns
TypeDescription
Tenant.Builder

newBuilder(Tenant prototype)

public static Tenant.Builder newBuilder(Tenant prototype)
Parameter
NameDescription
prototypeTenant
Returns
TypeDescription
Tenant.Builder

parseDelimitedFrom(InputStream input)

public static Tenant parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Tenant parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Tenant parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Tenant parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Tenant parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Tenant parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Tenant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tenant
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Tenant> parser()
Returns
TypeDescription
Parser<Tenant>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Tenant getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Tenant> getParserForType()
Returns
TypeDescription
Parser<Tenant>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for usageType.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Tenant.Builder newBuilderForType()
Returns
TypeDescription
Tenant.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Tenant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Tenant.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Tenant.Builder toBuilder()
Returns
TypeDescription
Tenant.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException