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

Format: name=customers/{customer}/policySchemas/{schema_namespace}

string

Tylko dane wyjściowe. Opis schematu zasad na potrzeby wykorzystania przez użytkowników.

object (AdditionalTargetKeyName)

Tylko dane wyjściowe. Dodatkowe nazwy kluczy, które będą używane do identyfikowania celu wartości zasady. Przy określaniu policyTargetKey każdy z dodatkowych kluczy określonych tutaj musi być uwzględniony w mapie additionalTargetKeys.

object (FileDescriptorProto)

Definicja schematu za pomocą deskryptora protokołu.

object (PolicySchemaFieldDescription)

Tylko dane wyjściowe. Szczegółowy opis każdego pola, które jest częścią schematu. Sugerujemy, aby pola były wyświetlane według kolejności na tej liście, a nie według numeru pola.

string

Tylko dane wyjściowe. Określone ograniczenia dostępu związane z tymi zasadami.

object (PolicySchemaNoticeDescription)

Tylko dane wyjściowe. Specjalne uwagi dotyczące ustawiania określonych wartości w określonych polach schematu.

string

Tylko dane wyjściowe. Identyfikator URI do artykułu pomocy powiązanego z tym schematem.

string

Tylko dane wyjściowe. Pełna nazwa schematu zasad. Ta wartość służy do wypełnienia pola policySchema w PolicyValue podczas wywoływania funkcji BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies lub BatchDeleteGroupPolicies.

enum (TargetResource)

Tylko dane wyjściowe. Informacje o odpowiednich zasobach docelowych dla zasady.

object (PolicyApiLifecycle)

Tylko dane wyjściowe. Aktualne informacje dotyczące cyklu życia.

string

Tytuł kategorii, do której należy ustawienie.

enum (Platform)

Tylko dane wyjściowe. Lista wskazuje, że zasada będzie stosowana tylko do urządzeń/użytkowników na tych platformach.

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

string

Nazwa klucza.

string

Opis klucza.

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

string

nazwa pliku względem poziomu głównego drzewa źródłowego

string

np. „foo”, „foo.bar” itp.

object (DescriptorProto)

Wszystkie definicje najwyższego poziomu w tym pliku.

object (EnumDescriptorProto)

string

Składnia pliku proto. Obsługiwane wartości to „proto2”, „proto3” i „editions”.

Jeśli podano edition, musi to być wartość „editions”.

{
  "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)

Jeśli parametr typeName jest ustawiony, nie trzeba go ustawiać. Jeśli ustawiono zarówno to, jak i typName, muszą to być wartości TYPE_ENUM, TYPE_MESSAGE lub TYPE_GROUP.

string

W przypadku typów wiadomości i wyliczeniowych jest to nazwa typu. Jeśli nazwa zaczyna się od znaku „.”, oznacza to, że jest w pełni kwalifikowana. W przeciwnym razie do określenia typu są używane reguły określania zakresu podobne do C++ (tzn. najpierw przeszukiwane są typy zagnieżdżone w wiadomości, a następnie w środku elementu nadrzędnego aż do głównej przestrzeni nazw).

string

W przypadku typów liczbowych zawiera reprezentację wartości w oryginalnym tekście. W przypadku wartości logicznych: „true” (prawda). lub „false”. W przypadku ciągów tekstowych zawiera domyślną zawartość tekstu (bez żadnych znaków zmiany znaczenia). W przypadku bajtów zawiera ciąg znaków o zmienionym znaczeniu C. Wszystkie bajty >= 128 są objęte zmianą znaczenia.

integer

Jeśli jest ustawiony, daje indeks elementu oneof na liście oneofDecl w elemencie zawierającym. To pole należy do tego pola.

string

Nazwa tego pola w formacie JSON. Wartość jest ustawiana przez kompilator protokołu. Jeśli użytkownik ustawił „jsonName” , zostanie użyta wartość tej opcji. W przeciwnym razie jest usuwana z nazwy pola przez konwertowanie jej na rodzaj wielbłąda.

boolean

Jeśli ma wartość true (prawda), jest to „opcjonalny” protokół proto3. Jeśli pole proto3 jest opcjonalne, śledzi obecność niezależnie od typu pola.

Gdy proto3Optional ma wartość true (prawda), to pole musi należeć do 1of, aby zasygnalizować starym klientom proto3, że obecność jest śledzona dla tego pola. Ten element jest nazywany „syntetycznym” oneof, a to pole musi być jego jedynym elementem (każde pole opcjonalne proto3 ma własną wartość syntetyczną). Syntetyczny jeden z nich występuje tylko w deskryptorze i nie generuje żadnego interfejsu API. Syntetyczny Jeden z musi być uporządkowany po wszystkich „rzeczywistych” oneofs.

W przypadku pól wiadomości proto3Optional nie powoduje żadnej zmiany semantycznej, ponieważ pola niepowtarzające się wiadomości zawsze śledzą obecność. Nadal jednak wskazuje semantyczny szczegół określający, czy użytkownik wpisał „opcjonalny”. lub nie. Może to być przydatne w przypadku segmentowania pliku .proto w obie strony. Aby zachować spójność, pola wiadomości mają też pola wiadomości syntetyczne, nawet jeśli śledzenie obecności nie jest wymagane. Jest to szczególnie ważne, ponieważ parser nie potrafi określić, czy pole jest komunikatem czy wyliczeniem, więc musi zawsze utworzyć syntetyczną wartość.

Pola opcjonalne Proto2 nie ustawiają tej flagi, ponieważ wskazują one już jako opcjonalne w elemencie 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

Tylko dane wyjściowe. Nazwa pola powiązanego z tym opisem.

string

Rola wycofana. Zamiast tego używaj atrybutów name i fieldDescription. Opis pola.

string

Tylko dane wyjściowe. Wszelkie ograniczenia wejściowe związane z wartościami pola.

object (PolicySchemaFieldKnownValueDescription)

Tylko dane wyjściowe. Jeśli pole ma zestaw znanych wartości, to pole będzie zawierać ich opis.

object (PolicySchemaFieldDescription)

Tylko dane wyjściowe. Zawiera opis pól zagnieżdżonych w tym polu, jeśli pole jest typem wiadomości definiującym wiele pól. Sugerujemy, aby pola były wyświetlane według kolejności na tej liście, a nie według numeru pola.

object (PolicySchemaFieldDependencies)

Tylko dane wyjściowe. Udostępnia listę pól i wartości. Aby można było ustawić to pole, co najmniej jedno z nich musi mieć odpowiadającą wartość.

object (PolicySchemaRequiredItems)

Tylko dane wyjściowe. Zawiera listę pól, które należy ustawić, jeśli to pole ma określoną wartość.

value (Value format)

Tylko dane wyjściowe. Ustawienie domyślne klienta, jeśli zasada jest nieskonfigurowana.

string

Tylko dane wyjściowe. Nazwa pola.

string

Tylko dane wyjściowe. Opis pola.

object (FieldConstraints)

Tylko dane wyjściowe. Informacje o ograniczeniach wejściowych związanych z wartościami pola.

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

string

Tylko dane wyjściowe. Ponowne wystąpienie ciągu znaków wartości, którą można ustawić dla pola.

string

Tylko dane wyjściowe. Dodatkowy opis dla tej wartości.

object (PolicySchemaFieldDependencies)

Tylko dane wyjściowe. Warunki pola są wymagane, aby ta wartość była prawidłowa.

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

string

Pole źródłowe, od którego zależy to pole.

string

Wartość, którą musi mieć pole źródłowe, by można było ustawić to pole.

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

string

Wartości pola, które powodują wymuszenie zastosowania wymaganych pól. Puste polefieldConditions oznacza, że każda wartość przypisana do tego pola spowoduje wymuszenie zastosowania wymaganego pola.

string

Pola, które są wymagane ze względu na warunki pól.

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

object (NumericRangeConstraint)

Dozwolony zakres dla pól liczbowych.

object (UploadedFileConstraints)

Ograniczenia dotyczące przesłanego pliku zasad dotyczących plików. Jeśli ta zasada jest dostępna, wymaga adresu URL, który można pobrać, przesyłając plik z ograniczeniami określonymi w tym proto.

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

string (int64 format)

Wartość minimalna.

string (int64 format)

Wartość maksymalna.

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

enum (ContentType)

Typy plików, które można przesłać w przypadku ustawienia.

string (int64 format)

Limit rozmiaru przesyłanych plików związanych z ustawieniem (w bajtach).

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

string

Tylko dane wyjściowe. Nazwa pola powiązanego z powiadomieniem.

string

Tylko dane wyjściowe. Wartość pola, które zawiera powiadomienie. Ustawienie tej wartości może wymagać od użytkownika potwierdzenia komunikatu.

string

Tylko dane wyjściowe. Komunikat powiadomienia jest powiązany z wartością pola.

boolean

Tylko dane wyjściowe. Określa, czy użytkownik musi potwierdzić wiadomość, zanim będzie można ustawić wartość.

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

string

W przypadku wycofania tej zasady i zastąpienia jej inną zasadą w pełni kwalifikowane przestrzenie nazw nowych zasad będą widoczne w interfejsie PolicyAPI. Można ją ustawić tylko wtedy, gdy zasada policyApiLifecycleStage ma wartość API_DEPRECATED.

string

Odpowiada to wycofanym InFavorOf, w pełni kwalifikowanym przestrzeniom nazw starych zasad, które zostaną wycofane w związku z wprowadzeniem tych zasad.

enum (PolicyApiLifecycleEnum)

Wskazuje bieżący etap cyklu życia interfejsu Policy API.

string

Opis bieżącego cyklu życia.

object (Date)

Data zakończenia wsparcia dla obecnej zasady. Próba zmodyfikowania zasady po dacie zakończenia obsługi spowoduje wystąpienie nieprawidłowego żądania (błąd 400). Można ją ustawić tylko wtedy, gdy zasada policyApiLifecycleStage ma wartość API_DEPRECATED.

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

integer

Rok daty. Wartość musi mieścić się w zakresie od 1 do 9999 lub od 0 do określenia daty bez roku.

integer

Miesiąc w roku. Musi mieścić się w zakresie od 1 do 12 lub 0, jeśli chcesz określić rok bez miesiąca i dnia.

integer

Dzień miesiąca. Wartość musi należeć do zakresu od 1 do 31 i jest ważna dla roku i miesiąca. Wartość 0 pozwala określić pojedynczy rok lub rok i miesiąc, w którym dzień nie jest istotny.