REST Resource: customers.policySchemas

{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string,
  "supportedPlatforms": [
    enum (Platform)
  ]
}

string

Формат: name=customers/{customer}/policySchemas/{schema_namespace}

string

Только вывод. Описание схемы политики для потребления пользователями.

object ( AdditionalTargetKeyName )

Только вывод. Дополнительные имена ключей, которые будут использоваться для определения цели значения политики. При указании policyTargetKey каждый из указанных здесь дополнительных ключей должен быть включен в карту additionalTargetKeys .

object ( FileDescriptorProto )

Определение схемы с использованием протодескриптора.

object ( PolicySchemaFieldDescription )

Только вывод. Подробное описание каждого поля, входящего в схему. Поля рекомендуется отображать в этом списке по порядку, а не по номеру поля.

string

Только вывод. Особые ограничения доступа, связанные с этой политикой.

object ( PolicySchemaNoticeDescription )

Только вывод. Специальные уведомления, связанные с установкой определенных значений в определенных полях схемы.

string

Только вывод. URI соответствующей статьи поддержки для этой схемы.

string

Только вывод. Полное имя схемы политики. Это значение используется для заполнения поля policySchema в PolicyValue при вызове BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies или BatchDeleteGroupPolicies .

enum ( TargetResource )

Только вывод. Информация о применимых целевых ресурсах для политики.

object ( PolicyApiLifecycle )

Только вывод. Текущая информация о жизненном цикле.

string

Название категории, к которой относится настройка.

enum ( Platform )

Только вывод. Список указывает, что политика будет применяться только к устройствам/пользователям на этих платформах.

{
  "key": string,
  "keyDescription": string
}

string

Ключевое имя.

string

Ключевое описание.

{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}

string

имя файла относительно корня исходного дерева

string

например, «foo», «foo.bar» и т. д.

object ( DescriptorProto )

Все определения верхнего уровня в этом файле.

object ( EnumDescriptorProto )

string

Синтаксис прото-файла. Поддерживаемые значения: «proto2», «proto3» и «editions».

Если присутствует edition , это значение должно быть «выпуски».

{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}

string

object ( FieldDescriptorProto )

object ( DescriptorProto )

object ( EnumDescriptorProto )

object ( OneofDescriptorProto )

{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}

string

integer

enum ( Label )

enum ( Type )

Если установлено typeName, его не нужно устанавливать. Если установлены и this, и typeName, это должно быть одно из TYPE_ENUM, TYPE_MESSAGE или TYPE_GROUP.

string

Для типов сообщений и перечислений это имя типа. Если имя начинается с «.», оно является полным. В противном случае для поиска типа используются правила области видимости, подобные C++ (т. е. сначала просматриваются вложенные типы внутри этого сообщения, затем внутри родительского типа вплоть до корневого пространства имен).

string

Для числовых типов содержит исходное текстовое представление значения. Для логических значений «истина» или «ложь». Для строк содержит текстовое содержимое по умолчанию (никаким образом не экранированное). Для байтов содержит экранированное значение C. Все байты >= 128 экранируются.

integer

Если установлено, выдает индекс oneof в списке oneofDecl содержащего типа. Это поле является членом этого поля.

string

JSON-имя этого поля. Значение устанавливается компилятором протокола. Если пользователь установил в этом поле параметр «jsonName», будет использоваться значение этого параметра. В противном случае оно выводится из имени поля путем преобразования его в CamelCase.

boolean

Если это правда, это proto3 «необязательно». Если поле proto3 является необязательным, оно отслеживает присутствие независимо от типа поля.

Если proto3Optional имеет значение true, это поле должно принадлежать одному из, чтобы сигнализировать старым клиентам proto3 о том, что присутствие этого поля отслеживается. Это поле известно как «синтетическое» и это поле должно быть его единственным членом (каждое дополнительное поле proto3 получает свой собственный синтетический). Синтетические экземпляры существуют только в дескрипторе и не генерируют никакого API. Синтетические экземпляры необходимо заказывать после всех «настоящих» экземпляров.

Для полей сообщений proto3Optional не создает никаких семантических изменений, поскольку неповторяющиеся поля сообщений всегда отслеживают присутствие. Однако он по-прежнему указывает на семантические детали того, написал ли пользователь «необязательно» или нет. Это может быть полезно для обработки файла .proto. Для единообразия мы также придаем полям сообщений синтетические значения, хотя отслеживать их присутствие не требуется. Это особенно важно, поскольку анализатор не может определить, является ли поле сообщением или перечислением, поэтому он всегда должен создавать синтетическое поле.

Необязательные поля Proto2 не устанавливают этот флаг, поскольку они уже указывают необязательность с помощью LABEL_OPTIONAL .

{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}

string

object ( EnumValueDescriptorProto )

{
  "name": string,
  "number": integer
}

string

integer

{
  "name": string
}

string

{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}

string

Только вывод. Имя поля, связанного с этим описанием.

string

Устарело. Вместо этого используйте name и fieldDescription. Описание поля.

string

Только вывод. Любые входные ограничения, связанные со значениями поля.

object ( PolicySchemaFieldKnownValueDescription )

Только вывод. Если поле имеет набор известных значений, это поле предоставит описание этих значений.

object ( PolicySchemaFieldDescription )

Только вывод. Предоставляет описание полей, вложенных в это поле, если поле представляет собой тип сообщения, определяющий несколько полей. Поля рекомендуется отображать в этом списке по порядку, а не по номеру поля.

object ( PolicySchemaFieldDependencies )

Только вывод. Предоставляет список полей и значений. По крайней мере одно из полей должно иметь соответствующее значение, чтобы это поле можно было установить.

object ( PolicySchemaRequiredItems )

Только вывод. Предоставляет список полей, которые необходимо задать, если это поле имеет определенное значение.

value ( Value format)

Только вывод. Клиент по умолчанию, если политика не настроена.

string

Только вывод. Имя поля.

string

Только вывод. Описание поля.

object ( FieldConstraints )

Только вывод. Информация обо всех входных ограничениях, связанных со значениями поля.

{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}

string

Только вывод. Строковое представление значения, которое можно задать для поля.

string

Только вывод. Дополнительное описание для этого значения.

object ( PolicySchemaFieldDependencies )

Только вывод. Условия поля, необходимые для того, чтобы это значение было действительным.

{
  "sourceField": string,
  "sourceFieldValue": string
}

string

Исходное поле, от которого зависит это поле.

string

Значение, которое должно иметь исходное поле, чтобы это поле можно было установить.

{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}

string

Значения поля, которые вызывают обязательное принудительное применение поля. Пустое полеConditions означает, что любое значение, присвоенное этому полю, приведет к обязательному принудительному применению поля.

string

Поля, которые необходимы в силу полевых условий.

{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}

object ( NumericRangeConstraint )

Разрешенный диапазон для числовых полей.

object ( UploadedFileConstraints )

Ограничения на загруженный файл файловой политики. Для этой политики, если она присутствует, требуется URL-адрес, который можно получить, загрузив файл с ограничениями, указанными в этом прототипе.

{
  "minimum": string,
  "maximum": string
}

string ( int64 format)

Минимальное значение.

string ( int64 format)

Максимальное значение.

{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}

enum ( ContentType )

Типы файлов, которые можно загрузить для настройки.

string ( int64 format)

Ограничение размера загружаемых файлов для настройки в байтах.

{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}

string

Только вывод. Имя поля, связанное с уведомлением.

string

Только вывод. Значение поля, в котором есть уведомление. При установке этого значения в поле пользователю может потребоваться подтвердить сообщение с уведомлением, чтобы значение было установлено.

string

Только вывод. Сообщение уведомления связано со значением поля.

boolean

Только вывод. Необходимо ли пользователю подтвердить сообщение с уведомлением, прежде чем можно будет установить значение.

{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}

string

В случае, если эта политика будет признана устаревшей в пользу другой политики, полностью определенное пространство имен новых политик, как они будут показаны в PolicyAPI. Может быть установлен только в том случае, если policyApiLifecycleStage имеет значение API_DEPRECATED.

string

Соответствует устаревшемуInFavorOf, полному пространству имен старых политик, которые будут объявлены устаревшими из-за введения этой политики.

enum ( PolicyApiLifecycleEnum )

Указывает текущую стадию жизненного цикла API политики.

string

Описание текущего жизненного цикла.

object ( Date )

Дата окончания поддержки текущей политики. Попытка изменить политику после даты окончания ее поддержки приведет к ошибочному запросу (ошибка 400). Может быть установлен только в том случае, если policyApiLifecycleStage имеет значение API_DEPRECATED.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.

integer

Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

integer

День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.