Class Tenant

  • All Implemented Interfaces:
    TenantOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Tenant
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Tenant.Builder
      A Tenant resource represents a tenant in the service.
      static class  Tenant.DataUsageType
      Enum that represents how user data owned by the tenant is used.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static Tenant getDefaultInstance()  
      Tenant getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getExternalId()
      Required.
      com.google.protobuf.ByteString getExternalIdBytes()
      Required.
      String getKeywordSearchableProfileCustomAttributes​(int index)
      A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding `string_values` are used in keyword searches.
      com.google.protobuf.ByteString getKeywordSearchableProfileCustomAttributesBytes​(int index)
      A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding `string_values` are used in keyword searches.
      int getKeywordSearchableProfileCustomAttributesCount()
      A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding `string_values` are used in keyword searches.
      com.google.protobuf.ProtocolStringList getKeywordSearchableProfileCustomAttributesList()
      A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding `string_values` are used in keyword searches.
      String getName()
      Required during tenant update.
      com.google.protobuf.ByteString getNameBytes()
      Required during tenant update.
      com.google.protobuf.Parser<Tenant> getParserForType()  
      int getSerializedSize()  
      Tenant.DataUsageType getUsageType()
      Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.
      int getUsageTypeValue()
      Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Tenant.Builder newBuilder()  
      static Tenant.Builder newBuilder​(Tenant prototype)  
      Tenant.Builder newBuilderForType()  
      protected Tenant.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Tenant parseDelimitedFrom​(InputStream input)  
      static Tenant parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tenant parseFrom​(byte[] data)  
      static Tenant parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tenant parseFrom​(com.google.protobuf.ByteString data)  
      static Tenant parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tenant parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Tenant parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tenant parseFrom​(InputStream input)  
      static Tenant parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tenant parseFrom​(ByteBuffer data)  
      static Tenant parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Tenant> parser()  
      Tenant.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • EXTERNAL_ID_FIELD_NUMBER

        public static final int EXTERNAL_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • USAGE_TYPE_FIELD_NUMBER

        public static final int USAGE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER

        public static final int KEYWORD_SEARCHABLE_PROFILE_CUSTOM_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        getName in interface TenantOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface TenantOrBuilder
        Returns:
        The bytes for name.
      • 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];
        Specified by:
        getExternalId in interface TenantOrBuilder
        Returns:
        The externalId.
      • getExternalIdBytes

        public com.google.protobuf.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];
        Specified by:
        getExternalIdBytes in interface TenantOrBuilder
        Returns:
        The bytes for externalId.
      • 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][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED]
         if it's unset.
         
        .google.cloud.talent.v4beta1.Tenant.DataUsageType usage_type = 3;
        Specified by:
        getUsageTypeValue in interface TenantOrBuilder
        Returns:
        The enum numeric value on the wire for usageType.
      • 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][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED]
         if it's unset.
         
        .google.cloud.talent.v4beta1.Tenant.DataUsageType usage_type = 3;
        Specified by:
        getUsageType in interface TenantOrBuilder
        Returns:
        The usageType.
      • getKeywordSearchableProfileCustomAttributesList

        public com.google.protobuf.ProtocolStringList getKeywordSearchableProfileCustomAttributesList()
         A list of keys of filterable
         [Profile.custom_attributes][google.cloud.talent.v4beta1.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;
        Specified by:
        getKeywordSearchableProfileCustomAttributesList in interface TenantOrBuilder
        Returns:
        A list containing the keywordSearchableProfileCustomAttributes.
      • getKeywordSearchableProfileCustomAttributesCount

        public int getKeywordSearchableProfileCustomAttributesCount()
         A list of keys of filterable
         [Profile.custom_attributes][google.cloud.talent.v4beta1.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;
        Specified by:
        getKeywordSearchableProfileCustomAttributesCount in interface TenantOrBuilder
        Returns:
        The count of keywordSearchableProfileCustomAttributes.
      • getKeywordSearchableProfileCustomAttributes

        public String getKeywordSearchableProfileCustomAttributes​(int index)
         A list of keys of filterable
         [Profile.custom_attributes][google.cloud.talent.v4beta1.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;
        Specified by:
        getKeywordSearchableProfileCustomAttributes in interface TenantOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The keywordSearchableProfileCustomAttributes at the given index.
      • getKeywordSearchableProfileCustomAttributesBytes

        public com.google.protobuf.ByteString getKeywordSearchableProfileCustomAttributesBytes​(int index)
         A list of keys of filterable
         [Profile.custom_attributes][google.cloud.talent.v4beta1.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;
        Specified by:
        getKeywordSearchableProfileCustomAttributesBytes in interface TenantOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keywordSearchableProfileCustomAttributes at the given index.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Tenant parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Tenant parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Tenant.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Tenant.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Tenant.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Tenant getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Tenant> parser()
      • getParserForType

        public com.google.protobuf.Parser<Tenant> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Tenant getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder