REST Resource: customers.policySchemas

Recurso: PolicySchema

Recurso que representa un esquema de política.

Representación JSON 
{
  "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
}
Campos
name

string

Formato: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Solo salida. Descripción sobre el esquema de políticas para el consumo de los usuarios.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Solo salida. Nombres de clave adicionales que se usarán para identificar el objetivo del valor de la política. Cuando se especifica un objeto policyTargetKey, cada una de las claves adicionales especificadas aquí se debe incluir en el mapa de additionalTargetKeys.
definition

object (FileDescriptorProto)

Definición de esquema con el descriptor de proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo salida. Descripción detallada de cada campo que forma parte del esquema.
accessRestrictions[]

string

Solo salida. Restricciones de acceso específicas relacionadas con esta política.
notices[]

object (PolicySchemaNoticeDescription)

Solo salida. Mensajes de aviso especial relacionados con la configuración de ciertos valores en ciertos campos del esquema.
supportUri

string

Solo salida. Es el URI del artículo de asistencia relacionado con este esquema.
schemaName

string

Solo salida. El nombre completamente calificado del esquema de la política. Este valor se usa para completar el campo policySchema en PolicyValue cuando se llama a orgunits.batchInherit orgunits.batchModify groups.batchModify o groups.batchDelete.
validTargetResources[]

enum (TargetResource)

Solo salida. Información sobre los recursos de destino aplicables a la política.
policyApiLifecycle

object (PolicyApiLifecycle)

Solo salida. Información actual del ciclo de vida.
categoryTitle

string

Es el título de la categoría a la que pertenece un parámetro de configuración.

AdditionalTargetKeyName

Nombres de clave adicionales que se usarán para identificar el objetivo del valor de la política.

Representación JSON 
{
  "key": string,
  "keyDescription": string
}
Campos
key

string

Nombre de la clave.
keyDescription

string

Descripción clave.

FileDescriptorProto

Describe un archivo .proto completo.

Representación JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
Campos
name

string

nombre del archivo, en relación con la raíz del árbol de fuentes
package

string

p.ej., “foo”, “foo.bar”, etcétera.
messageType[]

object (DescriptorProto)

Todas las definiciones de nivel superior de este archivo.
enumType[]

object (EnumDescriptorProto)
syntax

string

La sintaxis del archivo proto. Los valores admitidos son “proto2”, “proto3” y “editions”.

Si edition está presente, este valor debe ser "editions".

DescriptorProto

Describe un tipo de mensaje.

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

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Describe un campo dentro de un mensaje.

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

string
number

integer
label

enum (Label)
type

enum (Type)

Si se establece typeName, no es necesario establecerlo. Si se configuran tanto esto como typeName, este debe ser TYPE_ENUM, TYPE_MESSAGE o TYPE_GROUP.
typeName

string

Para los tipos de mensaje y enum, este es el nombre del tipo. Si el nombre comienza con “.”, significa que está completamente calificado. De lo contrario, se usan reglas de alcance similares a C++ para encontrar el tipo (es decir, primero se buscan los tipos anidados dentro de este mensaje y, luego, dentro del elemento superior, hasta el espacio de nombres raíz).
defaultValue

string

Para tipos numéricos, contiene la representación de texto original del valor. Para valores booleanos, “verdadero” o “falso”. Para las strings, contiene el contenido de texto predeterminado (sin escape de ninguna manera). En el caso de los bytes, contiene el valor de escape C. Se escapen todos los bytes >= 128.
oneofIndex

integer

Si se configura, proporciona el índice de un oneof en la lista oneofDecl del tipo que lo contiene. Este campo es miembro de ese campo.
jsonName

string

Nombre JSON de este campo. El compilador de protocolos establece el valor. Si el usuario estableció una opción “jsonName” en este campo, se usará el valor de esa opción. De lo contrario, se deduce del nombre del campo convirtiéndolo a camelCase.
proto3Optional

boolean

Si es verdadero, este es un proto3 “opcional”. Cuando un campo proto3 es opcional, realiza un seguimiento de la presencia sin importar el tipo de campo.

Cuando proto3Optional es verdadero, este campo debe pertenecer a uno de ellos para indicar a los clientes de proto3 antiguos que se realiza un seguimiento de la presencia de este campo. Este campo se conoce como uno “sintético”, y debe ser su único miembro (cada campo opcional proto3 obtiene su propio campo sintético). El oneof sintético solo existe en el descriptor y no genera ninguna API. Los oneofs sintéticos deben ordenarse después de todos los "reales".

Para los campos de mensaje, proto3Optional no crea ningún cambio semántico, ya que los campos de mensajes no repetidos siempre hacen un seguimiento de la presencia. Sin embargo, esto indica el detalle semántico que indica si el usuario escribió "opcional" o no. Esto puede ser útil para realizar un robo de ida y vuelta en el archivo .proto. Por motivos de coherencia, también proporcionamos uno sintético a los campos de mensaje, aunque no es necesario para realizar un seguimiento de la presencia. Esto es muy importante, ya que el analizador no puede distinguir si un campo es un mensaje o una enumeración, por lo que siempre debe crear un oneof sintético.

Los campos opcionales de Proto2 no establecen esta marca porque ya lo indican con LABEL_OPTIONAL.

Etiqueta

Enumeradores
LABEL_OPTIONAL 0 se reserva para errores
LABEL_REQUIRED
LABEL_REPEATED

Tipo

Enumeradores
TYPE_DOUBLE 0 está reservado para errores. El orden es extraño por razones históricas.
TYPE_FLOAT
TYPE_INT64 Sin codificación ZigZag. Los números negativos toman 10 bytes. Usa TYPE_SINT64 si es probable que los valores negativos sean.
TYPE_UINT64
TYPE_INT32 Sin codificación ZigZag. Los números negativos toman 10 bytes. Usa TYPE_SINT32 si es probable que los valores negativos sean.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Agregado delimitado por etiquetas. El tipo de grupo dejó de estar disponible y no se admite en proto3. Sin embargo, las implementaciones de Proto3 aún deberían poder analizar el formato de conexión de grupo y tratar los campos de grupo como campos desconocidos.
TYPE_MESSAGE Agregado delimitado por longitudes.
TYPE_BYTES Nuevo en la versión 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Usa la codificación ZigZag.
TYPE_SINT64 Usa la codificación ZigZag.

EnumDescriptorProto

Describe un tipo enum.

Representación JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Campos
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Describe un valor dentro de una enum.

Representación JSON 
{
  "name": string,
  "number": integer
}
Campos
name

string
number

integer

OneofDescriptorProto

Describe un oneof.

Representación JSON 
{
  "name": string
}
Campos
name

string

PolicySchemaFieldDescription

Proporciona información detallada sobre un campo en particular que forma parte de un PolicySchema.

Representación JSON 
{
  "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)
  }
}
Campos
field

string

Solo salida. Es el nombre del campo asociado con esta descripción.
description
(deprecated)

string

Ya no está disponible. En su lugar, usa name y fieldDescription. Es la descripción del campo.
inputConstraint

string

Solo salida. Cualquier restricción de entrada asociada a los valores del campo
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Solo salida. Si el campo tiene un conjunto de valores conocidos, este proporcionará una descripción para estos valores.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo salida. Proporciona la descripción de los campos anidados en este campo, si el campo es un tipo de mensaje que define varios campos.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo salida. Proporciona una lista de campos y valores. Para que se pueda configurar este campo, al menos uno de los campos debe tener el valor correspondiente.
requiredItems[]

object (PolicySchemaRequiredItems)

Solo salida. Proporciona una lista de campos que se deben establecer si el campo tiene un valor determinado.
defaultValue

value (Value format)

Solo salida. Predeterminado del cliente si no estableces la política.
name

string

Solo salida. El nombre del campo
fieldDescription

string

Solo salida. La descripción del campo.
fieldConstraints

object (FieldConstraints)

Solo salida. Información sobre las restricciones de entrada asociadas con los valores para el campo.

PolicySchemaFieldKnownValueDescription

Proporciona información detallada sobre un valor conocido permitido para un campo particular en un PolicySchema.

Representación JSON 
{
  "value": string,
  "description": string
}
Campos
value

string

Solo salida. La representación de string del valor que se puede establecer para el campo.
description

string

Solo salida. Es la descripción adicional de este valor.

PolicySchemaFieldDependencies

El campo y el valor que debe tener para que se pueda configurar otro campo.

Representación JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Campos
sourceField

string

El campo de origen del que depende este campo.
sourceFieldValue

string

Es el valor que debe tener el campo de origen para que se pueda configurar este campo.

PolicySchemaRequiredItems

Los campos que serán obligatorios según el valor de este campo.

Representación JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Campos
fieldConditions[]

string

Los valores del campo que provocan la aplicación forzosa de campos obligatorios. Si fieldConditions vacío significa que cualquier valor asignado a este campo provocará la aplicación de los campos obligatorios.
requiredFields[]

string

Los campos que se requieren como consecuencia de las condiciones del campo.

FieldConstraints

Información sobre cualquier restricción de rango.

Representación JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Campos
numericRangeConstraint

object (NumericRangeConstraint)

El rango permitido para campos numéricos.
uploadedFileConstraints

object (UploadedFileConstraints)

Restricciones del archivo subido de una política de archivos. Si está presente, esta política requiere una URL que se pueda recuperar subiendo un archivo con las restricciones especificadas en este proto.

NumericRangeConstraint

Una restricción en los límites inferiores o superiores, en la que se establece, al menos, uno.

Representación JSON 
{
  "minimum": string,
  "maximum": string
}
Campos
minimum

string (int64 format)

Valor mínimo.
maximum

string (int64 format)

Valor máximo

UploadedFileConstraints

Restricciones del archivo subido de una política de archivos.

Representación JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Campos
supportedContentTypes[]

enum (ContentType)

Tipos de archivo que se pueden subir para una configuración.
sizeLimitBytes

string (int64 format)

Es el límite de tamaño, en bytes, de los archivos subidos para un parámetro de configuración.

ContentType

Tipos de archivo que se pueden subir para una configuración.

Enumeradores
CONTENT_TYPE_UNSPECIFIED Tipo de contenido sin especificar.
CONTENT_TYPE_PLAIN_TEXT Texto sin formato
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV
CONTENT_TYPE_YAML en formato YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP

PolicySchemaNoticeDescription

Proporciona mensajes de aviso especial relacionados con un valor particular en un campo que forma parte de PolicySchema.

Representación JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Campos
field

string

Solo salida. El nombre del campo asociado con la notificación.
noticeValue

string

Solo salida. El valor del campo que tiene un aviso. Cuando se configura el campo en este valor, es posible que el usuario deba aceptar el mensaje de aviso para que se establezca el valor.
noticeMessage

string

Solo salida. El mensaje de aviso asociado con el valor del campo.
acknowledgementRequired

boolean

Solo salida. Indica si el usuario debe confirmar el mensaje de aviso para poder establecer el valor.

TargetResource

Tipos de recursos objetivo

Enumeradores
TARGET_RESOURCE_UNSPECIFIED Recurso de destino no especificado.
ORG_UNIT Recurso objetivo de unidad organizativa.
GROUP Recurso de destino del grupo.

PolicyApiLifecycle

Representación JSON 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
Campos
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Indica la etapa actual del ciclo de vida de la API de políticas.
description

string

Descripción sobre el ciclo de vida actual.
endSupport

object (Date)

Fecha de finalización de compatibilidad de la política actual.
deprecatedInFavorOf[]

string

En el caso de que esta política deje de estar disponible y se reemplace por otra política, los espacios de nombres completamente calificados de las políticas nuevas se mostrarán en PolicyAPI.

PolicyApiLifecycleEnum

Enumeradores
API_UNSPECIFIED sin especificar.
API_PREVIEW La política aún no funciona, pero está informando a los desarrolladores sobre el formato. Esta etapa se puede transferir a API_DELEARNMNT o API_CURRENT.
API_DEVELOPMENT La política puede cambiar de formato de manera tal que deje de ser compatible con versiones anteriores (cambio rotundo). Esta etapa puede transferirse a API_CURRENT o API_DEPRECATED. Se puede usar en el caso de las políticas que se lanzan solo para TT o a clientes seleccionados con fines de uso de emergencia.
API_CURRENT Política en formato oficial La política puede cambiar de formato de manera retrocompatible (cambio no rotundo). Ejemplo: Esta política puede introducir un campo nuevo, que se considera un cambio no rotundo, cuando las máscaras de campo se utilizan correctamente. Esta etapa puede transferir a API_DEPRECATED.
API_DEPRECATED Deja de utilizar esta política. Esta política dejó de estar disponible y podría quitarse o se quitará en el futuro. Es muy probable que se haya introducido una nueva política para reemplazar esta.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o no son significativas. La fecha está relacionada con el calendario gregoriano. Esto puede representar una de las siguientes opciones:

  • Una fecha completa con valores de año, mes y día que no sean cero
  • Es un mes y un día con un año cero (por ejemplo, un aniversario).
  • Un año solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe encontrarse entre 1 y 9999, o bien entre 0 para especificar una fecha sin año.
month

integer

Mes del año Debe encontrarse entre 1 y 12, o bien 0 para especificar un año sin mes ni día.
day

integer

Día del mes. Debe encontrarse entre 1 y 31 y ser válido para el año y el mes, o bien 0 para especificar solo un año o un año y mes en los que el día no sea importante.

Métodos

get

 Obtén un esquema de política específico para un cliente por su nombre de recurso.

list

 Obtiene una lista de esquemas de políticas que coinciden con un valor de filtro especificado para un cliente determinado.