REST Resource: projects.locations.consumerEnforcementActions

リソース: ConsumerEnforcementAction

パートナーのベンダー契約を適用するためにパートナーが実施したアクションを表します。

JSON 表現
{
  "name": string,
  "uid": string,
  "etag": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "succeedTime": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "consumerScope": {
    object (ConsumerScope)
  },
  "productScope": {
    object (ProductScope)
  },
  "denyReason": {
    object (DenyReason)
  },

  // Union field action can be only one of the following:
  "projectAccessRestrictionAction": {
    object (ProjectAccessRestrictionConfig)
  }
  // End of list of possible types for union field action.
}
フィールド
name

string

ID。ConsumerEnforcementAction リソースの名前。

形式: projects/{project}/locations/{location}/consumerEnforcementActions/{consumerEnforcementAction}

uid

string

出力専用。リソースの固有識別子。

etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

state

enum (State)

出力専用。リソースの現在のライフサイクル状態。

createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

updateTime

string (Timestamp format)

出力専用。リソース最終更新時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

succeedTime

string (Timestamp format)

出力専用。適用アクションが成功したときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

displayName

string

省略可。リソースの表示名(人が読める形式)。最大文字数は 63 文字です。

labels

map (key: string, value: string)

省略可。リソースのユーザー定義ラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

consumerScope

object (ConsumerScope)

必須。変更不可。適用アクションのコンシューマー スコープ。

productScope

object (ProductScope)

必須。変更不可。適用アクションのプロダクト スコープ。

denyReason

object (DenyReason)

出力専用。拒否の理由。リソースの状態が DENIED の場合に存在します。

共用体フィールド action。必須。構成された適用アクション。action は次のいずれかになります。
projectAccessRestrictionAction

object (ProjectAccessRestrictionConfig)

省略可。変更不可。コンシューマー プロジェクトのプロダクトへのアクセスを制限します。

ProjectAccessRestrictionConfig

コンシューマー プロジェクトに適用されるアクセス制限の構成。

アクセス制限がプロジェクトに適用されている間、関連するプロダクトによって提供されるサービスにアクセスするリクエストで、プロジェクトをクライアント プロジェクトとして使用することはできません。アクセス制限は破壊的ではなく、コンシューマーの調達状態を変更しません。制限が削除されるか、プロジェクトに適用されなくなると、コンシューマー プロジェクトへのアクセスは自動的に復元されます。

JSON 表現
{
  "falsePositiveGuardDisabled": boolean
}
フィールド
falsePositiveGuardDisabled

boolean

省略可。Google が誤検出を防ぐかどうかを制御します。

有効にすると、Google は、ベンダー契約違反の誤検出や、パートナーによる意図しない広範な適用によって発生する可能性のある、中断を伴う適用アクションを防ぎます。Google は、Google が入手できる情報に基づいて、適用アクションを続行するかどうかを独自に判断し、独自の裁量で適用アクションを拒否することがあります。Google は、リクエストされた適用アクションが拒否された場合、独自の裁量で判断の根拠に関する詳細情報を提供することがありますが、その義務はありません。また、パートナーと共有できない情報に基づいて判断を行うこともあります。パートナーが判断に同意しない場合は、ガードなしで新しい適用アクションを適用できます。

State

適用アクションのライフサイクル状態を表します。

今後、この列挙型に新しい値が追加される可能性があります。

列挙型
STATE_UNSPECIFIED 未指定の状態。使用されていません。
RUNNING

適用アクションが実行中です。これはリソースの初期状態であり、consumerEnforcementActions.create の長時間実行オペレーションが実行されている間は維持されます。

適用効果が発生する前にオペレーションがキャンセルされた場合、または終了した場合、リソースは削除されます。それ以外の場合、オペレーションが完了すると、リソースの状態は次のいずれかの状態に解決されます。

  • 適用アクションが承認されて正常に適用されると、完了時に状態が SUCCEEDED に移行します。
  • 適用アクションが拒否されると、完了時に状態が DENIED に移行します。
  • 適用効果の一部が適用された後に適用アクションが失敗すると、状態が FAILED に移行し、適用状態が不整合であることを反映します。
SUCCEEDED 適用アクションが承認され、正常に適用されました。適用アクションの進行中の効果はすべて有効です。
DENIED 適用アクションは承認されず、denyReason に記載されている理由で有効になりませんでした。
FAILED 一時的なシステムエラーまたは内部システムエラーが原因で、状態遷移に失敗しました。適用動作に一貫性がない可能性があります。この状態のリソースを削除すると、進行中の効果がすべて削除されます。

ConsumerScope

適用アクションのターゲット コンシューマー リソース エンティティを指定します。

JSON 表現
{

  // Union field target_consumer_entity can be only one of the following:
  "project": string,
  "billingAccount": string,
  "organization": string
  // End of list of possible types for union field target_consumer_entity.
}
フィールド
共用体フィールド target_consumer_entity。必須。ターゲット リソース ID を 1 つだけ設定する必要があります。target_consumer_entity は次のいずれかになります。
project

string

単一のプロジェクト リソースをターゲットにします。適用アクションのスコープは、指定されたプロジェクトに限定されます。

適用アクションの作成時に存在する必要があります。project_number 形式で指定する必要があります。

形式: projects/{project_number}

billingAccount

string

請求先アカウント リソースをターゲットにします。適用アクションのスコープは、請求先アカウントとそれにリンクされているすべてのプロジェクトに及びます。

このスコープは動的です。適用アクションの作成時に適用された効果は、その時点のスコープ内のエンティティに適用されます。適用アクションの進行中の効果は、関連する時点のスコープ内のエンティティに適用されます。

適用アクションの作成時に存在する必要があります。このフィールドを使用して、販売パートナーの親の請求先アカウントをターゲットにすることはできません。

形式: billingAccounts/{billingAccount}

organization

string

組織リソースをターゲットにします。適用アクションのスコープは、組織内のすべてのプロジェクト、組織内のすべての請求先アカウント、それらの請求先アカウントにリンクされているすべてのプロジェクトに及びます。

このスコープは動的です。適用アクションの作成時に適用された効果は、その時点のスコープ内のエンティティに適用されます。適用アクションの進行中の効果は、関連する時点のスコープ内のエンティティに適用されます。

適用アクションの作成時に存在する必要があります。

形式: organizations/{organization}

ProductScope

適用アクションのプロダクト スコープを定義します。

JSON 表現
{
  "aiplatformPublisherId": string
}
フィールド
aiplatformPublisherId

string

省略可。指定されたパブリッシャー ID を親とする AI Platform Model Garden のすべてのマネージド モデル プロダクトをターゲットにします。

AI Platform Model Garden では、publisher_id はモデル パブリッシャーを識別します。Model Garden でプロダクトを利用できるパートナーには、最初のオンボーディング時に一意のパブリッシャー ID が割り当てられます。指定できるのは、パートナー自身のパブリッシャー ID のみです。パブリッシャー ID が不明な場合は、パートナー サポートにお問い合わせください。

形式: {publisher_id}(例: google)。

DenyReason

適用アクションが適用されなかった理由の説明。

JSON 表現
{
  "reasonCode": enum (ReasonCode),
  "detailMessage": string
}
フィールド
reasonCode

enum (ReasonCode)

出力専用。理由コード。適用が拒否された場合は常に存在します。

detailMessage

string

出力専用。適用アクションが拒否された理由を説明する、人が読める形式の追加メッセージ(省略可)。

ReasonCode

Google によって適用アクションが拒否された理由を示すコード。

列挙型
REASON_CODE_UNSPECIFIED 理由の指定なし。使用されていません。
EXEMPT ターゲット コンシューマー エンティティ(またはエンティティ階層の下位のサブエンティティ)は、API によって開始されたリクエストされた適用アクションの適用から除外されます。コンシューマーに対する適用を進めるには、Google にお問い合わせください。
FALSE_POSITIVE_GUARD 誤検出ガードモードがリクエストされ、誤検出保護がトリガーされたため、適用アクションが拒否されました。

メソッド

create

ConsumerEnforcementAction リソースを作成します。

delete

ConsumerEnforcementAction リソースを削除します。

get

名前で ConsumerEnforcementAction リソースを取得します。

list

親ロケーションの下にある ConsumerEnforcementAction を一覧表示します。

patch

既存の ConsumerEnforcementAction リソースを更新します。