REST Resource: customers.policySchemas

Risorsa: PolicySchema

Risorsa che rappresenta uno schema di criteri.

Rappresentazione 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
}
Campi
name

string

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

string

Solo output. Descrizione dello schema dei criteri per l'utilizzo da parte degli utenti.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Solo output. Nomi di chiavi aggiuntivi che verranno utilizzati per identificare la destinazione del valore del criterio. Quando specifichi un valore policyTargetKey, ciascuna delle chiavi aggiuntive specificate qui dovrà essere inclusa nella mappa additionalTargetKeys.
definition

object (FileDescriptorProto)

Definizione dello schema utilizzando descrittore del protocollo.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo output. Descrizione dettagliata di ogni campo che fa parte dello schema.
accessRestrictions[]

string

Solo output. Limitazioni di accesso specifiche correlate a questo criterio.
notices[]

object (PolicySchemaNoticeDescription)

Solo output. Messaggi di avviso speciali relativi all'impostazione di determinati valori in determinati campi dello schema.
supportUri

string

Solo output. URI dell'articolo dell'assistenza correlato per questo schema.
schemaName

string

Solo output. Il nome completo dello schema dei criteri. Questo valore viene utilizzato per compilare il campo policySchema in PolicyValue quando chiami orgunits.batchInherit orgunits.batchModify groups.batchModify o groups.batchDelete.
validTargetResources[]

enum (TargetResource)

Solo output. Informazioni sulle risorse di destinazione applicabili per il criterio.
policyApiLifecycle

object (PolicyApiLifecycle)

Solo output. Informazioni sul ciclo di vita attuale.
categoryTitle

string

Titolo della categoria a cui appartiene un'impostazione.

AdditionalTargetKeyName

Nomi di chiavi aggiuntivi che verranno utilizzati per identificare la destinazione del valore del criterio.

Rappresentazione JSON 
{
  "key": string,
  "keyDescription": string
}
Campi
key

string

Nome chiave.
keyDescription

string

Descrizione della chiave.

FileDescriptorProto

Descrive un file .proto completo.

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

string

nome file, in relazione alla radice della struttura di origine
package

string

ad es. "foo", "foo.bar" e così via.
messageType[]

object (DescriptorProto)

Tutte le definizioni di primo livello in questo file.
enumType[]

object (EnumDescriptorProto)
syntax

string

La sintassi del file proto. I valori supportati sono "proto2", "proto3" ed "editions".

Se è presente edition, questo valore deve essere "editions".

DescriptorProto

Descrive un tipo di messaggio.

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

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Descrive un campo all'interno di un messaggio.

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

string
number

integer
label

enum (Label)
type

enum (Type)

Se typeName è impostato, non è necessario impostarlo. Se sono impostati sia questo che typeName, il valore deve essere TYPE_ENUM, TYPE_MESSAGE o TYPE_GROUP.
typeName

string

Per i tipi di messaggio ed enum, è il nome del tipo. Se il nome inizia con ".", significa che è valido. In caso contrario, per trovare il tipo vengono utilizzate regole di ambito di tipo C++, ovvero prima la ricerca dei tipi nidificati all'interno di questo messaggio, quindi all'interno dell'elemento padre fino allo spazio dei nomi principale.
defaultValue

string

Per i tipi numerici, contiene la rappresentazione testuale originale del valore. Per i valori booleani, "true" o "false". Per le stringhe, contiene i contenuti di testo predefiniti (non sottoposti in alcun modo a caratteri di escape). Per i byte, contiene il valore C preceduto da una sequenza di escape. Tutti i byte >= 128 contengono caratteri di escape.
oneofIndex

integer

Se impostato, restituisce l'indice di uno dei valori nell'elenco oneofDecl del tipo contenitore. Questo campo è un membro di quel campo.
jsonName

string

Nome JSON di questo campo. Il valore è impostato dal compilatore di protocollo. Se l'utente ha impostato un'opzione "jsonName" in questo campo, verrà utilizzato il relativo valore. Altrimenti, viene dedotto dal nome del campo convertendolo in camelCase.
proto3Optional

boolean

Se true, questo è un proto3 "facoltativo". Quando un campo proto3 è facoltativo, monitora la presenza indipendentemente dal tipo di campo.

Se proto3Optional è true, questo campo deve appartenere a uno di uno di per segnalare ai vecchi client proto3 che viene monitorata la presenza di questo campo. Questo campo è noto come "sintetico" e deve essere l'unico membro (ogni campo facoltativo proto3 ha il proprio uno sintetico). Un codice sintetico esiste solo nel descrittore e non genera alcuna API. Gli oneof sintetici devono essere ordinati dopo tutti quelli "reali".

Per i campi dei messaggi, proto3Optional non crea alcuna modifica semantica, poiché i campi di messaggio non ripetuti tracciano sempre la presenza. Tuttavia, indica comunque il dettaglio semantico se l'utente ha scritto "facoltativo" o meno. Questo può essere utile per eseguire l'operazione di round trip nel file .proto. Per coerenza, assegniamo ai campi dei messaggi un codice sintetico, anche se non è necessario monitorare la presenza. Questo è particolarmente importante perché il parser non può capire se un campo è un messaggio o un'enum, quindi deve sempre crearne uno sintetico.

I campi facoltativi di Proto2 non impostano questo flag, perché indicano già come facoltativi con LABEL_OPTIONAL.

Etichetta

Enum
LABEL_OPTIONAL 0 è riservato per gli errori
LABEL_REQUIRED
LABEL_REPEATED

Tipo

Enum
TYPE_DOUBLE 0 è riservato per gli errori. L'ordine è strano per motivi storici.
TYPE_FLOAT
TYPE_INT64 Codifica ZigZag non eseguita. I numeri negativi richiedono 10 byte. Utilizza TYPE_SINT64 se sono probabili valori negativi.
TYPE_UINT64
TYPE_INT32 Codifica ZigZag non eseguita. I numeri negativi richiedono 10 byte. Utilizza TYPE_SINT32 se sono probabili valori negativi.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Aggregato delimitato da tag. Il tipo di gruppo è deprecato e non è supportato in proto3. Tuttavia, le implementazioni di Proto3 dovrebbero essere comunque in grado di analizzare il formato GroupWire e trattare i campi del gruppo come campi sconosciuti.
TYPE_MESSAGE Aggregato delimitato da lunghezza.
TYPE_BYTES Novità della versione 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Utilizza la codifica ZigZag.
TYPE_SINT64 Utilizza la codifica ZigZag.

EnumDescriptorProto

Descrive un tipo di enumerazione.

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

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Descrive un valore all'interno di un'enumerazione.

Rappresentazione JSON 
{
  "name": string,
  "number": integer
}
Campi
name

string
number

integer

OneofDescriptorProto

Descrive un attributo.

Rappresentazione JSON 
{
  "name": string
}
Campi
name

string

PolicySchemaFieldDescription

Fornisce informazioni dettagliate per un determinato campo che fa parte di uno schema PolicySchema.

Rappresentazione 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)
  }
}
Campi
field

string

Solo output. Il nome del campo associato a questa descrizione.
description
(deprecated)

string

Deprecato. Utilizza invece name e fieldDescription. La descrizione del campo.
inputConstraint

string

Solo output. Eventuali vincoli di input associati ai valori del campo.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Solo output. Se il campo ha un insieme di valori noti, questo campo fornisce una descrizione per questi valori.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo output. Fornisce la descrizione dei campi nidificati in questo campo, se il campo è un tipo di messaggio che definisce più campi.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo output. Fornisce un elenco di campi e valori. Per consentire l'impostazione di questo campo, è necessario che almeno uno dei campi abbia il valore corrispondente.
requiredItems[]

object (PolicySchemaRequiredItems)

Solo output. Fornisce un elenco di campi che è necessario impostare se il campo ha un determinato valore.
defaultValue

value (Value format)

Solo output. Valore predefinito del client se il criterio non viene configurato.
name

string

Solo output. Il nome del campo.
fieldDescription

string

Solo output. La descrizione del campo.
fieldConstraints

object (FieldConstraints)

Solo output. Informazioni su eventuali vincoli di input associati ai valori del campo.

PolicySchemaFieldKnownValueDescription

Fornisce informazioni dettagliate su un valore noto consentito per un determinato campo in uno schema PolicySchema.

Rappresentazione JSON 
{
  "value": string,
  "description": string
}
Campi
value

string

Solo output. La rappresentazione stringa del valore che può essere impostato per il campo.
description

string

Solo output. Descrizione aggiuntiva per questo valore.

PolicySchemaFieldDependencies

Il campo e il valore che deve avere per poter impostare un altro campo.

Rappresentazione JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Campi
sourceField

string

Il campo di origine da cui dipende questo campo.
sourceFieldValue

string

Il valore che il campo di origine deve avere per poter impostare questo campo.

PolicySchemaRequiredItems

I campi che diventeranno obbligatori in base al valore di questo campo.

Rappresentazione JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Campi
fieldConditions[]

string

I valori del campo che hanno provocato l'applicazione forzata dei campi. Un campo fieldConditions vuoto implica che qualsiasi valore assegnato a questo campo provocherà l'applicazione di un campo obbligatorio.
requiredFields[]

string

I campi obbligatori a causa delle relative condizioni.

FieldConstraints

Informazioni sui vincoli di intervallo.

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

object (NumericRangeConstraint)

L'intervallo consentito per i campi numerici.
uploadedFileConstraints

object (UploadedFileConstraints)

Vincoli sul file caricato di un criterio relativo ai file. Se presente, questo criterio richiede un URL che possa essere recuperato caricando un file con i vincoli specificati in questo protocollo.

NumericRangeConstraint

Un vincolo sui limiti superiore e/o inferiore, di cui almeno uno è impostato.

Rappresentazione JSON 
{
  "minimum": string,
  "maximum": string
}
Campi
minimum

string (int64 format)

Valore minimo.
maximum

string (int64 format)

Valore massimo.

UploadedFileConstraints

Vincoli sul file caricato di un criterio relativo ai file.

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

enum (ContentType)

Tipi di file che possono essere caricati per un'impostazione.
sizeLimitBytes

string (int64 format)

Il limite delle dimensioni dei file caricati per un'impostazione, in byte.

ContentType

Tipi di file che possono essere caricati per un'impostazione.

Enum
CONTENT_TYPE_UNSPECIFIED Tipo di contenuti non specificato.
CONTENT_TYPE_PLAIN_TEXT Testo normale.
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 YAML.
CONTENT_TYPE_IMAGE_WEBP WebP.

PolicySchemaNoticeDescription

Fornisce messaggi di avviso speciali relativi a un determinato valore in un campo che fa parte di uno schema PolicySchema.

Rappresentazione JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Campi
field

string

Solo output. Il nome del campo associato alla notifica.
noticeValue

string

Solo output. Il valore del campo che ha una notifica. Quando il campo viene impostato su questo valore, all'utente potrebbe essere richiesto di confermare il messaggio di avviso per poter impostare il valore.
noticeMessage

string

Solo output. Il messaggio di avviso associato al valore del campo.
acknowledgementRequired

boolean

Solo output. Indica se l'utente deve confermare il messaggio di avviso prima che possa essere impostato il valore.

TargetResource

Tipi di risorse di destinazione

Enum
TARGET_RESOURCE_UNSPECIFIED Risorsa di destinazione non specificata.
ORG_UNIT Risorsa di destinazione dell'unità organizzativa.
GROUP Risorsa di destinazione del gruppo.

PolicyApiLifecycle

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

enum (PolicyApiLifecycleEnum)

Indica la fase attuale del ciclo di vita dell'API dei criteri.
description

string

Descrizione del ciclo di vita attuale.
endSupport

object (Date)

Data di fine del supporto per la norma attuale.
deprecatedInFavorOf[]

string

Nel caso in cui questo criterio sia stato ritirato a favore di un altro criterio, gli spazi dei nomi completi dei nuovi criteri verranno visualizzati in PolicyAPI.

PolicyApiLifecycleEnum

Enum
API_UNSPECIFIED non specificato.
API_PREVIEW Le norme non funzionano ancora, ma stiamo informando gli sviluppatori sul formato. Questa fase può essere trasferita in API_DEappealMNT o API_CURRENT.
API_DEVELOPMENT Il criterio può cambiare il formato in modo incompatibile con le versioni precedenti (modifica che provoca un errore). Questa fase può essere trasferita ad API_CURRENT o API_DEPRECATED. Questa funzionalità può essere utilizzata per i criteri lanciati solo per i TT o per i clienti selezionati per l'utilizzo in caso di emergenza.
API_CURRENT Norme nel formato ufficiale. Il criterio può cambiare formato in modo compatibile con le versioni precedenti (modifica valida). Esempio: questo criterio può introdurre un nuovo campo, considerato una modifica ininterrotta, quando le maschere di campo sono utilizzate correttamente. Questa fase può essere trasferita ad API_DEPRECATED.
API_DEPRECATED Ti invitiamo a non utilizzare più questo criterio. Questo criterio è deprecato e potrebbe/verrà rimosso in futuro. Molto probabilmente è stata introdotta una nuova norma in sostituzione di questa.

Data

Rappresenta una data di calendario intera o parziale, ad esempio un compleanno. L'ora del giorno e il fuso orario sono specificati altrove o non sono significativi. La data è relativa al calendario gregoriano. Può rappresentare uno dei seguenti valori:

  • Una data completa, con valori di anno, mese e giorno diversi da zero.
  • Un mese e un giorno, con un anno zero (ad esempio, un anniversario).
  • Un anno per sé, con un mese e un giorno zero.
  • Un anno e un mese, con un giorno zero (ad esempio, la data di scadenza di una carta di credito).

Tipi correlati:

Rappresentazione JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campi
year

integer

Anno della data. Il valore deve essere compreso tra 1 e 9999 oppure 0 per specificare una data senza anno.
month

integer

Mese dell'anno. Deve essere compreso tra 1 e 12 oppure 0 per specificare un anno senza giorno e mese.
day

integer

Giorno del mese. Deve essere compreso tra 1 e 31 ed essere valido per l'anno e il mese oppure 0 per specificare un anno da solo o un anno e un mese in cui il giorno non è significativo.

Metodi

get

 Ottieni uno schema dei criteri specifico per un cliente in base al nome della risorsa.

list

 Recupera un elenco di schemi di criteri che corrispondono a un valore di filtro specificato per un determinato cliente.