legacy-libs/google-proto-files/google/cloud/talent/v4beta1/tenant.proto

   1 // Copyright 2019 Google LLC.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14 //
  15
  16 syntax = "proto3";
  17
  18 package google.cloud.talent.v4beta1;
  19
  20 import "google/api/annotations.proto";
  21 import "google/cloud/talent/v4beta1/common.proto";
  22
  23 option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
  24 option java_multiple_files = true;
  25 option java_outer_classname = "TenantResourceProto";
  26 option java_package = "com.google.cloud.talent.v4beta1";
  27 option objc_class_prefix = "CTS";
  28
  29 // A Tenant resource represents a tenant in the service. A tenant is a group or
  30 // entity that shares common access with specific privileges for resources like
  31 // profiles. Customer may create multiple tenants to provide data isolation for
  32 // different groups.
  33 message Tenant {
  34   // Enum that represents how user data owned by the tenant is used.
  35   enum DataUsageType {
  36     // Default value.
  37     DATA_USAGE_TYPE_UNSPECIFIED = 0;
  38
  39     // Data owned by this tenant is used to improve search/recommendation
  40     // quality across tenants.
  41     AGGREGATED = 1;
  42
  43     // Data owned by this tenant is used to improve search/recommendation
  44     // quality for this tenant only.
  45     ISOLATED = 2;
  46   }
  47
  48   // Required during tenant update.
  49   //
  50   // The resource name for a tenant. This is generated by the service when a
  51   // tenant is created.
  52   //
  53   // The format is "projects/{project_id}/tenants/{tenant_id}", for example,
  54   // "projects/api-test-project/tenants/foo".
  55   string name = 1;
  56
  57   // Required.
  58   //
  59   // Client side tenant identifier, used to uniquely identify the tenant.
  60   //
  61   // The maximum number of allowed characters is 255.
  62   string external_id = 2;
  63
  64   // Optional.
  65   //
  66   // Indicates whether data owned by this tenant may be used to provide product
  67   // improvements across other tenants.
  68   //
  69   // Defaults behavior is
  70   // [DataUsageType.ISOLATED][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED]
  71   // if it's unset.
  72   DataUsageType usage_type = 3;
  73 }