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

Định dạng: name=customer/{customer}/policySchemas/{schema_workspace}

string

Chỉ có đầu ra. Nội dung mô tả giản đồ chính sách về mức tiêu thụ của người dùng.

object (AdditionalTargetKeyName)

Chỉ có đầu ra. Tên khoá bổ sung sẽ được dùng để xác định mục tiêu của giá trị chính sách. Khi chỉ định policyTargetKey, mỗi khoá bổ sung được chỉ định ở đây sẽ phải được đưa vào bản đồ additionalTargetKeys.

object (FileDescriptorProto)

Định nghĩa giản đồ bằng phần mô tả proto.

object (PolicySchemaFieldDescription)

Chỉ có đầu ra. Nội dung mô tả chi tiết về từng trường là một phần của giản đồ. Bạn nên hiển thị các trường theo thứ tự trong danh sách này, chứ không phải theo số trường.

string

Chỉ có đầu ra. Các quy định hạn chế truy cập cụ thể liên quan đến chính sách này.

object (PolicySchemaNoticeDescription)

Chỉ có đầu ra. Các thông báo đặc biệt liên quan đến việc đặt một số giá trị trong một số trường nhất định trong giản đồ.

string

Chỉ có đầu ra. URI tới bài viết hỗ trợ có liên quan cho giản đồ này.

string

Chỉ có đầu ra. Tên đủ điều kiện của giản đồ chính sách. Giá trị này dùng để điền vào trường policySchema trong PolicyValue khi gọi BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies hoặc BatchDeleteGroupPolicies.

enum (TargetResource)

Chỉ có đầu ra. Thông tin về các tài nguyên mục tiêu có thể áp dụng cho chính sách.

object (PolicyApiLifecycle)

Chỉ có đầu ra. Thông tin về vòng đời hiện tại.

string

Tiêu đề của danh mục chứa một chế độ cài đặt.

enum (Platform)

Chỉ có đầu ra. Danh sách cho biết rằng chính sách sẽ chỉ áp dụng cho thiết bị/người dùng trên những nền tảng này.

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

string

Tên khoá.

string

Nội dung mô tả chính.

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

string

tên tệp, so với gốc của cây nguồn

string

ví dụ: "foo", "foo.bar", v.v.

object (DescriptorProto)

Tất cả định nghĩa cấp cao nhất trong tệp này.

object (EnumDescriptorProto)

string

Cú pháp của tệp proto. Các giá trị được hỗ trợ là "proto2", "proto3" và "editions".

Nếu có edition, thì giá trị này phải là "phiên bản".

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

Nếu đã đặt typeName, thì bạn không cần đặt giá trị này. Nếu cả này và typeName được đặt, thì đây phải là một trong hai giá trị TYPE_ENUM, TYPE_MESSAGE hoặc TYPE_GROUP.

string

Đối với loại thông báo và loại enum, đây là tên của loại. Nếu tên bắt đầu bằng ".", thì tên đó đủ điều kiện. Nếu không, các quy tắc xác định phạm vi giống như C++ sẽ được dùng để tìm kiểu (tức là trước tiên, các kiểu lồng trong thông báo này được tìm kiếm, sau đó trong vùng chứa mẹ cho đến không gian tên gốc).

string

Đối với loại số, hãy chứa đại diện bằng văn bản gốc của giá trị. Đối với boolean, "true" hoặc "false". Đối với chuỗi, chứa nội dung văn bản mặc định (không được thoát theo bất kỳ cách nào). Đối với byte, hãy chứa giá trị thoát C. Tất cả các byte >= 128 đều được thoát.

integer

Nếu được đặt, hãy cung cấp chỉ mục của một trong các giá trị này thuộc danh sách oneofdecl của loại chứa. Trường này là một thành phần của trường đó.

string

Tên JSON của trường này. Giá trị do trình biên dịch giao thức đặt. Nếu người dùng đã đặt "jsonName" trên trường này, thì giá trị của lựa chọn đó sẽ được sử dụng. Nếu không, giá trị này được suy ra từ tên của trường bằng cách chuyển đổi trường đó theo quy ước camelCase.

boolean

Nếu đúng, thì đây là "không bắt buộc" proto3. Khi trường proto3 là không bắt buộc, trường này sẽ theo dõi sự hiện diện bất kể loại trường.

Khi proto3optional có giá trị là true, trường này phải thuộc một trường nào đó để báo hiệu cho các ứng dụng khách proto3 cũ rằng sự hiện diện được theo dõi cho trường này. Đây được gọi là "mô-đun tổng hợp" oneof và trường này phải là thành phần duy nhất (mỗi trường không bắt buộc proto3 sẽ có một trường tổng hợp riêng). Các giá trị tổng hợp chỉ tồn tại trong phần mô tả và không tạo ra API nào. Phải sắp xếp các mặt hàng tổng hợp sau tất cả các mặt hàng là "thực" một trong hai.

Đối với các trường thông báo, proto3optional không tạo ra bất kỳ thay đổi nào về ngữ nghĩa, vì các trường thông báo không lặp lại luôn theo dõi sự hiện diện. Tuy nhiên, mã này vẫn cho biết chi tiết ngữ nghĩa về việc liệu người dùng có viết "không bắt buộc" hay không hoặc không. Cách này có thể hữu ích khi loại bỏ tệp .proto. Để đảm bảo tính nhất quán, chúng tôi cũng cung cấp cho các trường thông báo dưới dạng một trường tổng hợp, mặc dù không bắt buộc phải theo dõi sự hiện diện. Điều này đặc biệt quan trọng vì trình phân tích cú pháp không thể phân biệt một trường là thông báo hay enum, vì vậy, trình phân tích cú pháp phải luôn tạo một trường tổng hợp.

Các trường không bắt buộc của Proto2 không đặt cờ này vì các trường này đã cho biết là không bắt buộc bằng 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

Chỉ có đầu ra. Tên của trường cho liên kết với mô tả này.

string

Không dùng nữa. Thay vào đó, hãy sử dụng tên và trườngMô tả. Nội dung mô tả cho trường.

string

Chỉ có đầu ra. Mọi quy tắc ràng buộc đối với dữ liệu đầu vào được liên kết với các giá trị cho trường này.

object (PolicySchemaFieldKnownValueDescription)

Chỉ có đầu ra. Nếu trường này có một tập hợp các giá trị đã biết, thì trường này sẽ cung cấp nội dung mô tả cho các giá trị đó.

object (PolicySchemaFieldDescription)

Chỉ có đầu ra. Cung cấp nội dung mô tả về các trường lồng trong trường này nếu trường đó là một loại thông báo xác định nhiều trường. Bạn nên hiển thị các trường theo thứ tự trong danh sách này, chứ không phải theo số trường.

object (PolicySchemaFieldDependencies)

Chỉ có đầu ra. Cung cấp danh sách các trường và giá trị. Ít nhất một trong các trường phải có giá trị tương ứng để trường này được phép đặt.

object (PolicySchemaRequiredItems)

Chỉ có đầu ra. Cung cấp danh sách các trường bắt buộc phải thiết lập nếu trường này có một giá trị nhất định.

value (Value format)

Chỉ có đầu ra. Theo giá trị mặc định của ứng dụng, nếu bạn không đặt chính sách này.

string

Chỉ có đầu ra. Tên của trường.

string

Chỉ có đầu ra. Nội dung mô tả về trường.

object (FieldConstraints)

Chỉ có đầu ra. Thông tin về mọi điều kiện ràng buộc đối với dữ liệu đầu vào được liên kết với các giá trị cho trường này.

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

string

Chỉ có đầu ra. Chuỗi đại diện của giá trị có thể đặt cho trường.

string

Chỉ có đầu ra. Nội dung mô tả bổ sung về giá trị này.

object (PolicySchemaFieldDependencies)

Chỉ có đầu ra. Điều kiện trường bắt buộc để giá trị này hợp lệ.

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

string

Trường nguồn mà trường này phụ thuộc vào.

string

Giá trị mà trường nguồn phải có cho trường này để được phép đặt.

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

string

(Các) giá trị của trường kích hoạt quá trình thực thi tại trường bắt buộc. Trường điều kiện trường trống ngụ ý rằng mọi giá trị được chỉ định cho trường này sẽ kích hoạt quy trình thực thi trường bắt buộc.

string

Các trường bắt buộc do các điều kiện của trường.

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

object (NumericRangeConstraint)

Phạm vi cho phép dành cho các trường số.

object (UploadedFileConstraints)

Các quy tắc ràng buộc đối với tệp đã tải lên của chính sách về tệp. Nếu có, chính sách này yêu cầu một URL có thể tìm nạp được bằng cách tải tệp lên kèm theo các quy tắc ràng buộc được chỉ định trong proto này.

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

string (int64 format)

Giá trị nhỏ nhất.

string (int64 format)

Giá trị tối đa.

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

enum (ContentType)

Các loại tệp có thể được tải lên cho một chế độ cài đặt.

string (int64 format)

Giới hạn kích thước của các tệp đã tải lên cho một chế độ cài đặt, tính bằng byte.

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

string

Chỉ có đầu ra. Tên trường liên kết với thông báo.

string

Chỉ có đầu ra. Giá trị của trường có thông báo. Khi đặt trường này thành giá trị này, người dùng có thể phải xác nhận nội dung thông báo để đặt giá trị đó.

string

Chỉ có đầu ra. Nội dung thông báo liên kết với giá trị của trường.

boolean

Chỉ có đầu ra. Liệu người dùng có cần xác nhận nội dung thông báo trước khi có thể đặt giá trị này hay không.

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

string

Trong trường hợp chính sách này không được dùng nữa và thay vào đó là một chính sách khác, (các) không gian tên đủ điều kiện của các chính sách mới sẽ xuất hiện trong PolicyAPI. Chỉ có thể đặt nếu policyApiLifecycleContext được sử dụng là API_DEPREDeprecated.

string

Tương ứng với deprecatedInFavorOf, (các) vùng chứa tên đủ điều kiện của các chính sách cũ sẽ không được dùng nữa do chính sách này ra mắt.

enum (PolicyApiLifecycleEnum)

Cho biết giai đoạn vòng đời hiện tại của API chính sách.

string

Nội dung mô tả về vòng đời hiện tại.

object (Date)

Ngày kết thúc hỗ trợ chính sách hiện tại. Việc cố gắng sửa đổi một chính sách sau ngày ngừng hỗ trợ chính sách đó sẽ dẫn đến Yêu cầu không hợp lệ (lỗi 400). Chỉ có thể đặt nếu policyApiLifecycleContext được sử dụng là API_DEPREDeprecated.

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

integer

Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm.

integer

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày.

integer

Ngày trong tháng. Phải có giá trị từ 1 đến 31 và có giá trị hợp lệ trong năm và tháng, hoặc bằng 0 để chỉ định một năm độc lập hoặc là một năm và tháng mà ngày không quan trọng.