- リソース: PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- ラベル
- タイプ
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- 日付
- メソッド
リソース: PolicySchema
ポリシー スキーマを表すリソース。
JSON 表現 |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
フィールド | |
---|---|
name |
形式: name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
出力のみ。ユーザーが使用するポリシー スキーマの説明。 |
additionalTargetKeyNames[] |
出力のみ。ポリシー値の対象を識別するために使用される追加のキー名。 |
definition |
proto 記述子を使用したスキーマ定義。 |
fieldDescriptions[] |
出力のみ。スキーマを構成する各フィールドの詳細な説明。 |
accessRestrictions[] |
出力のみ。このポリシーに関連する特定のアクセス制限。 |
notices[] |
出力のみ。スキーマの特定のフィールドに特定の値を設定することに関連する特別な通知メッセージ。 |
supportUri |
出力のみ。このスキーマの関連サポート記事の URI。 |
schemaName |
出力のみ。ポリシー スキーマの完全修飾名。この値は、 |
validTargetResources[] |
出力のみ。ポリシーに適用されるターゲット リソースに関する情報。 |
policyApiLifecycle |
出力のみ。現在のライフサイクル情報。 |
categoryTitle |
設定が属するカテゴリのタイトル。 |
AdditionalTargetKeyName
ポリシー値の対象を識別するために使用される追加のキー名。
JSON 表現 |
---|
{ "key": string, "keyDescription": string } |
フィールド | |
---|---|
key |
鍵名。 |
keyDescription |
キーの説明。 |
FileDescriptorProto
完全な .proto ファイルを記述します。
JSON 表現 |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
フィールド | |
---|---|
name |
ファイル名(ソースツリーのルートからの相対名) |
package |
例: "foo"、"foo.bar" など |
messageType[] |
このファイル内のすべてのトップレベルの定義。 |
enumType[] |
|
syntax |
proto ファイルの構文。サポートされている値は、「proto2」、「proto3」、「editions」です。
|
DescriptorProto
メッセージ タイプを表します。
JSON 表現 |
---|
{ "name": string, "field": [ { object ( |
フィールド | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
メッセージ内のフィールドを記述します。
JSON 表現 |
---|
{ "name": string, "number": integer, "label": enum ( |
フィールド | |
---|---|
name |
|
number |
|
label |
|
type |
typeName が設定されている場合は、設定する必要はありません。これと typeName の両方を設定する場合は、TYPE_ENUM、TYPE_MESSAGE、または TYPE_GROUP のいずれかにする必要があります。 |
typeName |
メッセージ型と列挙型の場合、これは型の名前です。名前が「.」で始まる場合は、完全修飾名が指定されます。それ以外の場合は、C++ のようなスコープ設定ルールを使用して型が検索されます(つまり、まずこのメッセージ内のネストされた型が検索され、次に親の型からルート名前空間まで検索されます)。 |
defaultValue |
数値型の場合、値の元のテキスト表現が格納されます。ブール値の場合は true または false。文字列の場合は、デフォルトのテキスト コンテンツが含まれます(エスケープされません)。バイトの場合は、C にエスケープされた値が含まれます。128 以上のすべてのバイトがエスケープされます。 |
oneofIndex |
設定されている場合は、含まれる型の oneofDecl リストにある oneof のインデックスを返します。このフィールドはその oneof のメンバーです。 |
jsonName |
このフィールドの JSON 名。この値はプロトコル コンパイラによって設定されます。ユーザーがこのフィールドに「jsonName」オプションを設定している場合は、そのオプションの値が使用されます。そうでない場合は、キャメルケースに変換することでフィールド名から推測されます。 |
proto3Optional |
true の場合、proto3 の「省略可」です。proto3 フィールドがオプションの場合は、フィールド タイプに関係なくプレゼンスを追跡します。 proto3Optional が true の場合、このフィールドでプレゼンスが追跡されていることを古い proto3 クライアントに通知するために、このフィールドは oneof に属している必要があります。この oneof は「synthetic oneof」と呼ばれ、このフィールドはその唯一のメンバーである必要があります(proto3 の各オプション フィールドは独自の synthetic oneof を持ちます)。合成 oneof は記述子にのみ存在し、API を生成しません。合成 oneof は、すべての「実際の」 oneof の後に注文する必要があります。 proto3Optional は、メッセージ フィールドの場合、繰り返しでないメッセージ フィールドは常に存在を追跡するため、セマンティックな変更を行いません。ただし、それでもユーザーが「省略可」と入力したかどうかに関するセマンティックな詳細が示されます。これは .proto ファイルのラウンドトリップに便利です。一貫性を確保するために、プレゼンスを追跡する必要はありませんが、メッセージ フィールドには synthetic oneof も付けています。パーサーはフィールドがメッセージか列挙型かを判別できないため、これは特に重要です。したがって、常に合成 oneof を作成する必要があります。 Proto2 のオプション フィールドでは、すでに |
ラベル
列挙型 | |
---|---|
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 |
ジグザグ エンコードを使用します。 |
TYPE_SINT64 |
ジグザグ エンコードを使用します。 |
EnumDescriptorProto
列挙型を表します。
JSON 表現 |
---|
{
"name": string,
"value": [
{
object ( |
フィールド | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
列挙型内の値を記述します。
JSON 表現 |
---|
{ "name": string, "number": integer } |
フィールド | |
---|---|
name |
|
number |
|
OneofDescriptorProto
oneof を記述します。
JSON 表現 |
---|
{ "name": string } |
フィールド | |
---|---|
name |
|
PolicySchemaFieldDescription
PolicySchema に含まれる特定のフィールドの詳細情報を提供します。
JSON 表現 |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
フィールド | |
---|---|
field |
出力のみ。この説明に関連付けられているフィールドの名前。 |
description |
非推奨です。代わりに name と fieldDescription を使用してください。フィールドの説明。 |
inputConstraint |
出力のみ。フィールドの値に関連付けられた入力制約。 |
knownValueDescriptions[] |
出力のみ。フィールドに既知の値のセットがある場合、このフィールドには値の説明が提供されます。 |
nestedFieldDescriptions[] |
出力のみ。フィールドが複数のフィールドを定義するメッセージ型の場合、このフィールドにネストされたフィールドの説明を提供します。 |
fieldDependencies[] |
出力のみ。フィールドと値のリストを指定します。このフィールドを設定するには、少なくとも 1 つのフィールドに対応する値が指定されている必要があります。 |
requiredItems[] |
出力のみ。このフィールドに特定の値がある場合に設定する必要があるフィールドのリストを提供します。 |
defaultValue |
出力のみ。このポリシーを未設定のままにした場合のクライアントのデフォルト。 |
name |
出力のみ。フィールドの名前。 |
fieldDescription |
出力のみ。フィールドの説明。 |
fieldConstraints |
出力のみ。フィールドの値に関連する入力制約の情報。 |
PolicySchemaFieldKnownValueDescription
PolicySchema の特定のフィールドで使用できる既知の値に関する詳細情報を提供します。
JSON 表現 |
---|
{ "value": string, "description": string } |
フィールド | |
---|---|
value |
出力のみ。フィールドに設定できる値の文字列表現。 |
description |
出力のみ。この値に関する追加の説明。 |
PolicySchemaFieldDependencies
別のフィールドを設定するために必要なフィールドと値。
JSON 表現 |
---|
{ "sourceField": string, "sourceFieldValue": string } |
フィールド | |
---|---|
sourceField |
このフィールドが依存するソース フィールド。 |
sourceFieldValue |
このフィールドを設定するためにソース フィールドに必要な値。 |
PolicySchemaRequiredItems
このフィールドの値に基づいて必須になるフィールド。
JSON 表現 |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
フィールド | |
---|---|
fieldConditions[] |
必須フィールドの適用を開始するフィールドの値。空の fieldConditions は、このフィールドに割り当てられた値によって必須フィールドが適用されることを意味します。 |
requiredFields[] |
フィールド条件の結果として必要とされるフィールド。 |
FieldConstraints
範囲の制約に関する情報。
JSON 表現 |
---|
{ "numericRangeConstraint": { object ( |
フィールド | |
---|---|
numericRangeConstraint |
数値フィールドの範囲です。 |
uploadedFileConstraints |
アップロードされたファイルに対するファイル ポリシーの制約。存在する場合、このポリシーには proto で指定された制約のあるファイルをアップロードして取得できる URL が必要です。 |
NumericRangeConstraint
上限や下限に対する制約で、少なくとも 1 つが設定されています。
JSON 表現 |
---|
{ "minimum": string, "maximum": string } |
フィールド | |
---|---|
minimum |
最小値。 |
maximum |
最大値 |
UploadedFileConstraints
アップロードされたファイルに対するファイル ポリシーの制約。
JSON 表現 |
---|
{
"supportedContentTypes": [
enum ( |
フィールド | |
---|---|
supportedContentTypes[] |
設定に対してアップロードできるファイル形式。 |
sizeLimitBytes |
1 つの設定にアップロードするファイルのサイズ上限(バイト単位)。 |
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 |
記述できます。 |
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 |
出力のみ。通知に関連付けられたフィールド名。 |
noticeValue |
出力のみ。通知があるフィールドの値。このフィールドにこの値を設定した場合、値を設定するために、ユーザーが通知メッセージの確認応答を求められることがあります。 |
noticeMessage |
出力のみ。フィールドの値に関連付けられた通知メッセージ。 |
acknowledgementRequired |
出力のみ。値を設定する前に、ユーザーが通知メッセージを確認する必要があるかどうか。 |
TargetResource
ターゲット リソースタイプ
列挙型 | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
未指定のターゲット リソース。 |
ORG_UNIT |
組織部門の対象リソース。 |
GROUP |
グループ ターゲット リソース。 |
PolicyApiLifecycle
JSON 表現 |
---|
{ "policyApiLifecycleStage": enum ( |
フィールド | |
---|---|
policyApiLifecycleStage |
ポリシー API の現在のライフサイクル ステージを示します。 |
description |
現在のライフサイクルに関する説明。 |
endSupport |
現在のポリシーのサポート終了日。 |
deprecatedInFavorOf[] |
このポリシーが非推奨になり別のポリシーに置き換えられた場合、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 日という単独の年。
- 年と月、日がゼロ(クレジット カードの有効期限など)。
関連するタイプ:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON 表現 |
---|
{ "year": integer, "month": integer, "day": integer } |
フィールド | |
---|---|
year |
日付の年。1 ~ 9999 の範囲で指定するか、年のない日付を指定する場合は 0 にする必要があります。 |
month |
月。1 ~ 12 にする必要があります。月と日のない年を指定するには 0 を指定します。 |
day |
日。1 ~ 31 の範囲の年と月で指定でき、0 の場合は単独で年を指定するか、日付が重要でない年と月を指定します。 |
Methods |
|
---|---|
|
リソース名で顧客の特定のポリシー スキーマを取得します。 |
|
特定の顧客の指定されたフィルタ値に一致するポリシー スキーマのリストを取得します。 |