REST Resource: projects.locations.consumerEnforcementActions

Ressource : ConsumerEnforcementAction

Représente une action entreprise par un partenaire pour faire respecter son contrat avec le fournisseur.

Représentation 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.
}
Champs
name

string

Identifiant. Nom de la ressource ConsumerEnforcementAction.

Format : projects/{project}/locations/{location}/consumerEnforcementActions/{consumerEnforcementAction}

uid

string

Uniquement en sortie. Identifiant unique de la ressource.

etag

string

Cette somme de contrôle est calculée par le serveur en fonction de la valeur des autres champs. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de continuer.

state

enum (State)

Uniquement en sortie. État actuel du cycle de vie de la ressource.

createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de la ressource.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la ressource.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

succeedTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la réussite de la mesure coercitive.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

displayName

string

Facultatif. Nom à afficher de la ressource, lisible par l'humain. La longueur maximale est de 63 caractères.

labels

map (key: string, value: string)

Facultatif. Étiquettes définies par l'utilisateur pour la ressource.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

consumerScope

object (ConsumerScope)

Obligatoire. Immuable. Portée de l'action coercitive pour les consommateurs.

productScope

object (ProductScope)

Obligatoire. Immuable. Champ d'application du produit de la mesure coercitive.

denyReason

object (DenyReason)

Uniquement en sortie. Motif du refus. Présent lorsque l'état de la ressource est DENIED.

Champ d'union action. Obligatoire. Action d'application configurée. action ne peut être qu'un des éléments suivants :
projectAccessRestrictionAction

object (ProjectAccessRestrictionConfig)

Facultatif. Immuable. Restreint l'accès aux produits pour les projets clients.

ProjectAccessRestrictionConfig

Configuration d'une restriction d'accès qui s'applique aux projets client.

Lorsqu'une restriction d'accès s'applique à un projet, celui-ci ne peut pas être utilisé comme projet client dans les requêtes d'accès aux services fournis par les produits concernés. La restriction d'accès n'est pas destructrice et ne modifie pas l'état d'approvisionnement du consommateur. L'accès aux projets clients est automatiquement rétabli lorsque la restriction est supprimée ou cesse de s'appliquer à un projet.

Représentation JSON
{
  "falsePositiveGuardDisabled": boolean
}
Champs
falsePositiveGuardDisabled

boolean

Facultatif. Détermine si Google doit se prémunir contre les faux positifs.

Lorsqu'elle est activée, Google protège les partenaires contre les mesures coercitives perturbatrices qui pourraient résulter de faux positifs concernant des cas de non-respect du contrat avec le fournisseur ou de mesures coercitives involontairement trop larges de la part du partenaire. Google prendra sa propre décision en fonction des informations dont il dispose pour déterminer si la mesure coercitive doit être appliquée. Il peut également la refuser, à sa discrétion. Google peut, à sa discrétion, fournir des détails sur la base de sa décision lorsqu'une mesure coercitive demandée est refusée, mais il n'y est pas tenu. Il peut également prendre des décisions en fonction d'informations qui ne peuvent pas être partagées avec le partenaire. Si le partenaire n'est pas d'accord avec la décision, il peut appliquer une nouvelle mesure coercitive sans la protection.

État

Représente l'état du cycle de vie de la mesure coercitive.

De nouvelles valeurs pourront être ajoutées à cette énumération à l'avenir.

Enums
STATE_UNSPECIFIED État non spécifié. Non utilisé.
RUNNING

La mesure coercitive est en cours. Il s'agit de l'état initial de la ressource, qui persiste pendant l'exécution de l'opération de longue durée consumerEnforcementActions.create.

Si l'opération est annulée ou se termine avant l'application de mesures coercitives, la ressource sera supprimée. Sinon, une fois l'opération terminée, l'état de la ressource sera l'un des suivants.

  • Si la mesure coercitive est acceptée et appliquée, l'état passe à SUCCEEDED une fois l'opération terminée.
  • Si la mesure coercitive est refusée, l'état passe à DENIED une fois la mesure appliquée.
  • Si l'action coercitive échoue après l'application partielle des effets coercitifs, l'état passe à FAILED pour refléter l'état d'application partielle incohérent.
SUCCEEDED La mesure coercitive a été acceptée et appliquée. Tous les effets en cours de la mesure coercitive sont actifs.
DENIED La mesure coercitive n'a pas été acceptée et n'a pas pris effet pour la raison détaillée dans denyReason.
FAILED Une transition d'état a échoué en raison d'une erreur système interne ou temporaire. Le comportement d'application peut être incohérent. La suppression d'une ressource dans cet état supprimera tous les effets en cours.

ConsumerScope

Spécifie l'entité de ressource consommateur cible pour l'action d'application.

Représentation 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.
}
Champs
Champ d'union target_consumer_entity. Obligatoire. Vous ne devez définir qu'un seul identifiant de ressource cible. target_consumer_entity ne peut être qu'un des éléments suivants :
project

string

Cible une seule ressource de projet. Le champ d'application de la mesure coercitive est limité au projet spécifié.

Doit exister au moment où la mesure coercitive est créée. Doit être spécifié au format project_number.

Format : projects/{project_number}

billingAccount

string

Cible une ressource de compte de facturation. Le champ d'application de la mesure coercitive couvre le compte de facturation et tous les projets qui y sont associés.

Ce champ d'application est dynamique. Tous les effets appliqués au moment de la création de la mesure coercitive sont appliqués aux entités concernées à ce moment-là. Tous les effets en cours de la mesure coercitive s'appliquent aux entités concernées au moment opportun.

Doit exister au moment où la mesure coercitive est créée. Ce champ ne peut pas être utilisé pour cibler un compte de facturation parent de revendeur.

Format : billingAccounts/{billingAccount}

organization

string

Cible une ressource Organisation. Le champ d'application de la mesure coercitive couvre tous les projets de l'organisation, ainsi que tous les comptes de facturation de l'organisation et tous les projets associés à ces comptes de facturation.

Ce champ d'application est dynamique. Tous les effets appliqués au moment de la création de la mesure coercitive sont appliqués aux entités concernées à ce moment-là. Tous les effets en cours de la mesure coercitive s'appliquent aux entités concernées au moment opportun.

Doit exister au moment où la mesure coercitive est créée.

Format : organizations/{organization}

ProductScope

Définit le champ d'application du produit de la mesure coercitive.

Représentation JSON
{
  "aiplatformPublisherId": string
}
Champs
aiplatformPublisherId

string

Facultatif. Cible tous les produits de modèles gérés dans AI Platform Model Garden dont la référence éditeur est celle spécifiée.

Dans AI Platform Model Garden, un publisher_id identifie l'éditeur du modèle. Les partenaires dont les produits sont disponibles dans Model Garden se voient attribuer une référence éditeur unique lors de leur premier onboarding. Seule la référence éditeur du partenaire peut être spécifiée. Si vous ne connaissez pas votre référence éditeur, contactez l'assistance pour les partenaires afin d'obtenir de l'aide.

Format : {publisher_id} (par exemple, google).

DenyReason

Explication de la raison pour laquelle aucune mesure coercitive n'a été appliquée.

Représentation JSON
{
  "reasonCode": enum (ReasonCode),
  "detailMessage": string
}
Champs
reasonCode

enum (ReasonCode)

Uniquement en sortie. Code de motif. Toujours présent lorsque l'application de la loi est refusée.

detailMessage

string

Uniquement en sortie. Message supplémentaire facultatif et lisible par l'utilisateur expliquant pourquoi la mesure coercitive a été refusée.

ReasonCode

Code indiquant pourquoi la mesure coercitive a été refusée par Google.

Enums
REASON_CODE_UNSPECIFIED Motif non spécifié. Non utilisé.
EXEMPT L'entité consommateur cible (ou une sous-entité inférieure dans la hiérarchie des entités) est exemptée de l'application de la mesure coercitive demandée par l'API. Pour faire appliquer les règles à l'encontre du consommateur, contactez Google.
FALSE_POSITIVE_GUARD L'action coercitive a été refusée, car le mode de protection contre les faux positifs a été demandé et déclenché.

Méthodes

create

Crée une ressource ConsumerEnforcementAction.

delete

Supprime une ressource ConsumerEnforcementAction.

get

Récupère une ressource ConsumerEnforcementAction par son nom.

list

Liste les ConsumerEnforcementActions sous un emplacement parent.

patch

Met à jour une ressource ConsumerEnforcementAction existante.