REST Resource: customers.policySchemas

리소스: PolicySchema

정책 스키마를 나타내는 리소스입니다.

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
}
입력란
name

string

형식: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

출력 전용. 사용자 소비를 위한 정책 스키마에 대한 설명입니다.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

출력 전용. 정책 값의 대상을 식별하는 데 사용할 추가 키 이름입니다. policyTargetKey를 지정하는 경우 여기에 지정된 각 추가 키는 additionalTargetKeys 맵에 포함되어야 합니다.
definition

object (FileDescriptorProto)

proto 설명자를 사용한 스키마 정의
fieldDescriptions[]

object (PolicySchemaFieldDescription)

출력 전용. 스키마의 일부인 각 필드에 대한 자세한 설명입니다.
accessRestrictions[]

string

출력 전용. 이 정책과 관련된 특정 액세스 제한입니다.
notices[]

object (PolicySchemaNoticeDescription)

출력 전용. 스키마의 특정 필드에 특정 값을 설정하는 것과 관련된 특별 알림 메시지입니다.
supportUri

string

출력 전용. 이 스키마의 관련 지원 도움말의 URI입니다.
schemaName

string

출력 전용. 정책 스키마의 정규화된 이름입니다. 이 값은 orgunits.batchInherit orgunits.batchModify groups.batchModify 또는 groups.batchDelete를 호출할 때 PolicyValue의 policySchema 필드를 채우는 데 사용됩니다.
validTargetResources[]

enum (TargetResource)

출력 전용. 정책에 적용 가능한 대상 리소스에 대한 정보입니다.
policyApiLifecycle

object (PolicyApiLifecycle)

출력 전용. 현재 수명 주기 정보입니다.
categoryTitle

string

설정이 속한 카테고리의 제목입니다.

AdditionalTargetKeyName

정책 값의 대상을 식별하는 데 사용할 추가 키 이름입니다.

JSON 표현 
{
  "key": string,
  "keyDescription": string
}
입력란
key

string

키 이름입니다.
keyDescription

string

키 설명

FileDescriptorProto

완전한 .proto 파일을 설명합니다.

JSON 표현 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
입력란
name

string

소스 트리의 루트를 기준으로 한 파일 이름
package

string

예: 'foo', 'foo.bar'
messageType[]

object (DescriptorProto)

이 파일의 모든 최상위 정의입니다.
enumType[]

object (EnumDescriptorProto)
syntax

string

proto 파일의 구문입니다. 지원되는 값은 'proto2', 'proto3', 'editions'입니다.

edition가 있는 경우 이 값은 'editions'여야 합니다.

DescriptorProto

메시지 유형을 설명합니다.

JSON 표현 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
입력란
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

메시지 내의 필드를 설명합니다.

JSON 표현 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
입력란
name

string
number

integer
label

enum (Label)
type

enum (Type)

typeName이 설정된 경우에는 이 값을 설정할 필요가 없습니다. 이 값과 typeName이 모두 설정된 경우 TYPE_ENUM, TYPE_MESSAGE 또는 TYPE_GROUP 중 하나여야 합니다.
typeName

string

메시지 및 enum 유형의 경우 유형의 이름입니다. 이름이 '.'로 시작하면 정규화됩니다. 그 외의 경우에는 C++와 유사한 범위 지정 규칙을 사용하여 유형을 찾습니다. 즉, 먼저 이 메시지 내의 중첩된 유형이 검색된 다음 상위 요소 내에서 루트 네임스페이스까지 검색됩니다.
defaultValue

string

숫자 유형의 경우 값의 원래 텍스트 표현을 포함합니다. 불리언의 경우 'true' 또는 'false'입니다. 문자열의 경우 기본 텍스트 콘텐츠를 포함합니다 (어떤 방식으로도 이스케이프 처리되지 않음). 바이트의 경우 C 이스케이프된 값을 포함합니다. 128보다 크거나 같은 모든 바이트가 이스케이프 처리됩니다.
oneofIndex

integer

설정된 경우 포함 유형의 oneofDecl 목록에 있는 oneof의 색인을 제공합니다. 이 필드는 해당 필드 중 하나입니다.
jsonName

string

이 필드의 JSON 이름입니다. 값은 프로토콜 컴파일러에 의해 설정됩니다. 사용자가 이 필드에 'jsonName' 옵션을 설정한 경우 해당 옵션의 값이 사용됩니다. 그렇지 않으면 camelCase로 변환하여 필드 이름에서 추론됩니다.
proto3Optional

boolean

true인 경우 proto3 '선택사항'입니다. proto3 필드가 선택사항인 경우 필드 유형과 관계없이 존재 여부를 추적합니다.

proto3Optional이 true인 경우 이 필드는 존재가 이 필드의 존재를 추적한다는 것을 이전 proto3 클라이언트에 알리려면 이 필드 중 하나에 속해야 합니다. 이 필드를 '합성' 필드라고 하며, 이 필드는 단독 멤버여야 합니다 (각 proto3 선택 필드는 자체 합성 필드 중 하나를 얻음). 합성 객체는 설명자에만 존재하며 API를 생성하지 않습니다. 합성 속성은 모든 '실제' 속성 다음에 정렬되어야 합니다.

메시지 필드의 경우 proto3Optional은 반복되지 않는 메시지 필드가 항상 존재를 추적하므로 의미적 변화를 생성하지 않습니다. 하지만 사용자가 'optional'로 작성했는지 여부에 대한 시맨틱 세부정보를 계속 나타냅니다. 이 방법은 .proto 파일을 왕복하는 경우에 유용합니다. 일관성을 위해 메시지 필드에 합성 필드도 제공합니다. 이것이 특히 중요한 이유는 파서가 필드가 메시지인지 enum인지 알 수 없어 항상 합성된 필드를 생성해야 하기 때문입니다.

Proto2 선택적 필드는 이미 LABEL_OPTIONAL에서 선택사항으로 표시되어 있으므로 이 플래그를 설정하지 않습니다.

라벨

열거형
LABEL_OPTIONAL 0은 오류용으로 예약되어 있습니다.
LABEL_REQUIRED
LABEL_REPEATED

유형

열거형
TYPE_DOUBLE 0은 오류용으로 예약되어 있습니다. 역사적 이유로 순서가 이상합니다.
TYPE_FLOAT
TYPE_INT64 ZigZag가 인코딩되지 않았습니다. 음수는 10바이트를 사용합니다. 음수 값일 가능성이 있으면 TYPE_SINT64를 사용합니다.
TYPE_UINT64
TYPE_INT32 ZigZag가 인코딩되지 않았습니다. 음수는 10바이트를 사용합니다. 음수 값일 가능성이 있으면 TYPE_SINT32를 사용합니다.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP 태그로 구분된 집계입니다. 그룹 유형이 지원 중단되었으며 proto3에서 지원되지 않습니다. 그러나 Proto3 구현에서는 여전히 그룹 연결 형식을 파싱하고 그룹 필드를 알 수 없는 필드로 처리할 수 있어야 합니다.
TYPE_MESSAGE 길이로 구분된 집계입니다.
TYPE_BYTES 버전 2의 새로운 기능입니다.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 ZigZag 인코딩을 사용합니다.
TYPE_SINT64 ZigZag 인코딩을 사용합니다.

EnumDescriptorProto

enum 유형을 설명합니다.

JSON 표현 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
입력란
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

enum 내의 값을 설명합니다.

JSON 표현 
{
  "name": string,
  "number": integer
}
입력란
name

string
number

integer

OneofDescriptorProto

하나를 설명합니다.

JSON 표현 
{
  "name": string
}
입력란
name

string

PolicySchemaFieldDescription

PolicySchema의 일부인 특정 필드에 대한 세부정보를 제공합니다.

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)
  }
}
입력란
field

string

출력 전용. 이 설명과 연결된 필드의 이름입니다.
description
(deprecated)

string

지원이 중단되었습니다. 대신 name 및 fieldDescription을 사용하세요. 필드에 대한 설명입니다.
inputConstraint

string

출력 전용. 필드 값에 연결된 입력 제약조건입니다.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

출력 전용. 필드에 알려진 값 집합이 있는 경우 이 필드는 이러한 값에 대한 설명을 제공합니다.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

출력 전용. 필드가 여러 필드를 정의하는 메시지 유형인 경우 이 필드에 중첩된 필드에 대한 설명을 제공합니다.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

출력 전용. 필드와 값의 목록을 제공합니다. 이 필드를 설정하려면 하나 이상의 필드에 해당 값이 있어야 합니다.
requiredItems[]

object (PolicySchemaRequiredItems)

출력 전용. 이 필드에 특정 값이 있는 경우 설정해야 하는 필드의 목록을 제공합니다.
defaultValue

value (Value format)

출력 전용. 정책을 설정하지 않은 경우 클라이언트 기본값입니다.
name

string

출력 전용. 필드의 이름입니다.
fieldDescription

string

출력 전용. 필드에 대한 설명입니다.
fieldConstraints

object (FieldConstraints)

출력 전용. 필드 값과 연결된 입력 제약조건에 대한 정보입니다.

PolicySchemaFieldKnownValueDescription

PolicySchema의 특정 필드에 허용되는 알려진 값에 대한 자세한 정보를 제공합니다.

JSON 표현 
{
  "value": string,
  "description": string
}
입력란
value

string

출력 전용. 필드에 설정할 수 있는 값의 문자열 표현입니다.
description

string

출력 전용. 이 값에 대한 추가 설명입니다.

PolicySchemaFieldDependencies

다른 필드를 설정하려면 필드 및 필드가 가져야 하는 값입니다.

JSON 표현 
{
  "sourceField": string,
  "sourceFieldValue": string
}
입력란
sourceField

string

이 필드가 사용하는 소스 필드입니다.
sourceFieldValue

string

이 필드를 설정하려면 소스 필드에 있어야 하는 값입니다.

PolicySchemaRequiredItems

이 필드의 값을 기준으로 필수가 되는 필드입니다.

JSON 표현 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
입력란
fieldConditions[]

string

필수 필드 적용을 유발하는 필드의 값입니다. fieldCondition이 비어 있으면 이 필드에 할당된 모든 값이 필수 필드 적용을 유발한다는 것을 의미합니다.
requiredFields[]

string

필드 조건의 결과로 필요한 필드입니다.

FieldConstraints

범위 제약조건에 대한 정보입니다.

JSON 표현 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
입력란
numericRangeConstraint

object (NumericRangeConstraint)

숫자 필드에 허용되는 범위입니다.
uploadedFileConstraints

object (UploadedFileConstraints)

파일 정책의 업로드된 파일에 대한 제약조건입니다. 있는 경우 이 정책에는 이 proto에 지정된 제약 조건이 있는 파일을 업로드하여 가져올 수 있는 URL이 필요합니다.

NumericRangeConstraint

상한 또는 하한의 제약 조건(하나 이상이 설정됨)

JSON 표현 
{
  "minimum": string,
  "maximum": string
}
입력란
minimum

string (int64 format)

최솟값입니다.
maximum

string (int64 format)

최댓값입니다.

UploadedFileConstraints

파일 정책의 업로드된 파일에 대한 제약조건입니다.

JSON 표현 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
입력란
supportedContentTypes[]

enum (ContentType)

설정에 대해 업로드할 수 있는 파일 형식입니다.
sizeLimitBytes

string (int64 format)

설정에 대해 업로드되는 파일의 크기 제한(바이트)입니다.

ContentType

설정에 대해 업로드할 수 있는 파일 형식입니다.

열거형
CONTENT_TYPE_UNSPECIFIED 콘텐츠 유형이 지정되지 않았습니다.
CONTENT_TYPE_PLAIN_TEXT 일반 텍스트
CONTENT_TYPE_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

PolicySchema의 일부인 필드의 특정 값과 관련된 특별 알림 메시지를 제공합니다.

JSON 표현 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
입력란
field

string

출력 전용. 고지와 연결된 필드 이름입니다.
noticeValue

string

출력 전용. 알림이 있는 필드의 값입니다. 필드를 이 값으로 설정하면 값을 설정하기 위해 사용자가 알림 메시지를 확인해야 할 수 있습니다.
noticeMessage

string

출력 전용. 공지 메시지는 필드 값과 연결됩니다.
acknowledgementRequired

boolean

출력 전용. 값을 설정하기 전에 사용자가 알림 메시지를 확인해야 하는지 여부입니다.

TargetResource

대상 리소스 유형

열거형
TARGET_RESOURCE_UNSPECIFIED 지정되지 않은 대상 리소스입니다.
ORG_UNIT 조직 단위 대상 리소스입니다.
GROUP 그룹 대상 리소스입니다.

PolicyApiLifecycle

JSON 표현 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
입력란
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Policy API의 현재 수명 주기 단계를 나타냅니다.
description

string

현재 수명 주기에 대한 설명입니다.
endSupport

object (Date)

현재 보험 증권의 지원 종료일입니다.
deprecatedInFavorOf[]

string

이 정책이 지원 중단되고 다른 정책으로 대체될 경우 새 정책의 정규화된 네임스페이스가 PolicyAPI에 표시됩니다.

PolicyApiLifecycleEnum

열거형
API_UNSPECIFIED 지정되지 않습니다.
API_PREVIEW 정책이 아직 작동하지 않으나 개발자에게 형식에 대해 미리 알립니다. 이 단계는 API_DEVELOPEMNT 또는 API_CURRENT로 이전할 수 있습니다.
API_DEVELOPMENT 정책이 이전 버전과 호환되지 않는 방식으로 형식을 변경할 수 있습니다 (브레이킹 체인지). 이 단계는 API_CURRENT 또는 API_DEPRECATED로 이전할 수 있습니다. 이 기능은 TT에게만 출시된 정책이나 일부 고객을 대상으로 긴급 상황에서 시행할 수 있습니다.
API_CURRENT 공식 형식의 정책입니다. 정책은 이전 버전과 호환되는 방식으로 형식을 변경할 수 있습니다 (브레이킹 체인지 없는 변경). 예: 이 정책은 필드 마스크가 제대로 활용될 때 브레이킹 체인지가 아닌 변경사항으로 간주되는 새 필드를 도입할 수 있습니다. 이 단계는 API_DEPRECATED로 이전할 수 있습니다.
API_DEPRECATED 이 정책의 사용을 중지하시기 바랍니다. 이 정책은 지원 중단되었으며 향후 삭제될 수 있습니다. 이 정책을 대체하기 위해 새로운 정책이 도입되었을 가능성이 높습니다.

날짜

생일과 같은 캘린더 날짜 전체 또는 일부를 나타냅니다. 하루 중 시간과 시간대가 다른 곳에 지정되어 있거나 중요하지 않습니다. 날짜는 그레고리력을 기준으로 합니다. 다음 중 하나를 나타낼 수 있습니다.

  • 연도, 월, 일 값이 0이 아닌 전체 날짜
  • 월과 일, 연도는 0년입니다 (예: 기념일).
  • 1년은 자체적으로, 월은 0이고 나머지는 0일입니다.
  • 연도와 월을 0일로 표시 (예: 신용카드 만료일)

관련 유형:

JSON 표현 
{
  "year": integer,
  "month": integer,
  "day": integer
}
입력란
year

integer

날짜의 연도입니다. 1~9999 사이의 값이어야 합니다. 연도 없이 날짜를 지정하려면 0이어야 합니다.
month

integer

월입니다. 1~12 사이의 값이어야 합니다. 월과 일 없이 연도를 지정하려면 0과 같아야 합니다.
day

integer

날짜입니다. 1~31 사이의 값이어야 하며 연도와 월에 유효해야 합니다. 또는 연도만 지정하거나 일이 중요하지 않은 연도와 월을 지정하려면 0이어야 합니다.

방법

get

 리소스 이름으로 고객의 특정 정책 스키마를 가져옵니다.

list

 지정된 고객에 대해 지정된 필터 값과 일치하는 정책 스키마 목록을 가져옵니다.