REST Resource: projects.locations.unitOperations

Ressource : UnitOperation

UnitOperation encapsule l'intention de modifier/d'interagir avec le composant de service représenté par l'unité spécifique. Il est possible de créer (demander) et de planifier plusieurs UnitOperations à l'avenir, mais une seule pourra être exécutée à la fois (cela pourra changer à l'avenir pour les opérations non mutantes).

Les UnitOperations permettent à différents acteurs interagissant avec la même unité de se concentrer uniquement sur la modification qu'ils ont demandée.

Il s'agit d'un objet de base qui contient les champs communs à toutes les opérations unitaires. Suivant : 22

Représentation JSON 
{
  "name": string,
  "unit": string,
  "parentUnitOperation": string,
  "rollout": string,
  "cancel": boolean,
  "state": enum (UnitOperationState),
  "conditions": [
    {
      object (UnitOperationCondition)
    }
  ],
  "schedule": {
    object (Schedule)
  },
  "engineState": string,
  "errorCategory": enum (UnitOperationErrorCategory),
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,

  // Union field unit_operation_type can be only one of the following:
  "provision": {
    object (Provision)
  },
  "upgrade": {
    object (Upgrade)
  },
  "deprovision": {
    object (Deprovision)
  }
  // End of list of possible types for union field unit_operation_type.
}
Champs
name

string

Identifiant. Nom de la ressource (URI complet de la ressource) suivant le schéma de dénomination standard :

"projects/{project}/locations/{location}/unitOperations/{unitOperation}"
unit

string

Obligatoire. Immuable. Unité sur laquelle une UnitOperation donnée agira.
parentUnitOperation

string

Facultatif. Référence à la ressource parente : UnitOperation. Si une opération doit créer d'autres opérations dans son workflow, le champ de chacune des opérations enfants doit être défini sur le parent. Vous pouvez l'utiliser pour le traçage. (Facultatif)
rollout

string

Facultatif. Indique le déploiement qui a créé cette opération d'unité. Cette valeur ne peut pas être modifiée et n'est utilisée qu'à des fins de filtrage. Si une unité dépendante et une opération d'unité sont créées dans le cadre d'une autre opération d'unité, elles utiliseront le même rolloutId.
cancel

boolean

Facultatif. Si la valeur est "true", tentez d'annuler l'opération. L'annulation peut échouer si l'opération est déjà en cours d'exécution. (Facultatif)
state

enum (UnitOperationState)

Facultatif. Uniquement en sortie. UnitOperationState décrit l'état actuel de l'opération unitaire.
conditions[]

object (UnitOperationCondition)

Facultatif. Uniquement en sortie. Ensemble de conditions indiquant les différentes conditions que cette ressource peut avoir.
schedule

object (Schedule)

Facultatif. Quand planifier cette opération.
engineState

string

Facultatif. Uniquement en sortie. État du moteur pour les opérations de moteur de déploiement en cours. Ce champ est opaque pour une utilisation externe.
errorCategory

enum (UnitOperationErrorCategory)

Facultatif. Uniquement en sortie. UnitOperationErrorCategory décrit la catégorie d'erreur.
labels

map (key: string, value: string)

Facultatif. Libellés de la ressource, qui peuvent être utilisés pour la catégorisation. Ils sont semblables aux libellés de ressources Kubernetes.

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

map (key: string, value: string)

Facultatif. Les annotations sont un mappage clé-valeur non structuré stocké avec une ressource. Elles peuvent être définies par des outils externes pour stocker et récupérer des métadonnées arbitraires. Elles ne peuvent pas faire l'objet de requêtes et doivent être conservées lors de la modification d'objets.

Pour en savoir plus, consultez https://kubernetes.io/docs/user-guide/annotations.

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

string

Uniquement en sortie. Identifiant unique de la ressource. L'UID est unique dans le temps et l'espace pour cette ressource dans le cadre du service. Il est habituellement généré par le serveur lors de la création réussie d'une ressource et ne doit pas être modifié. L'UID permet d'identifier de manière unique les ressources avec réutilisation du nom. Il doit être un UUID4.
etag

string

Uniquement en sortie. Valeur opaque qui identifie de manière unique la version ou la génération d'une ressource. Cet identifiant permet de confirmer que le client et le serveur sont d'accord sur l'ordre d'écriture d'une 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. Toute modification de la ressource par les utilisateurs doit actualiser cette valeur. Les modifications d'une ressource par le service doivent actualiser cette valeur.

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".
deleteTime

string (Timestamp format)

Uniquement en sortie. Code temporel indiquant le moment où la ressource a été marquée pour suppression (la suppression est une opération asynchrone).

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".

Champ d'union unit_operation_type.

unit_operation_type ne peut être qu'un des éléments suivants :
provision

object (Provision)
upgrade

object (Upgrade)
deprovision

object (Deprovision)

Provisionner

Le provisionnement est l'opération d'unité qui provisionne les ressources sous-jacentes représentées par une unité. Ne peut être exécuté que si l'unité n'est pas actuellement provisionnée.

Représentation JSON 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Champs
release

string

Facultatif. Référence à l'objet Release à utiliser pour l'unité. (Facultatif).
inputVariables[]

object (UnitVariable)

Facultatif. Ensemble de variables d'entrée. 100 au maximum. (facultatif)

Mettre à niveau

La mise à niveau est l'opération d'unité qui met à niveau une unité provisionnée, ce qui peut également inclure les ressources sous-jacentes représentées par une unité. Ne peut être exécuté que si l'unité est actuellement provisionnée.

Représentation JSON 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Champs
release

string

Facultatif. Référence à l'objet Release à utiliser pour l'unité. (Facultatif).
inputVariables[]

object (UnitVariable)

Facultatif. Ensemble de variables d'entrée. 100 au maximum. (facultatif)

Déprovisionner

Ce type ne comporte aucun champ.

Le déprovisionnement est l'opération d'unité qui déprovisionne les ressources sous-jacentes représentées par une unité. Ne peut être exécuté que si l'unité est actuellement provisionnée.

UnitOperationState

UnitOperationState décrit l'état actuel de l'opération unitaire.

Enums
UNIT_OPERATION_STATE_UNKNOWN
UNIT_OPERATION_STATE_PENDING L'opération d'unité est acceptée, mais n'est pas prête à être exécutée.
UNIT_OPERATION_STATE_SCHEDULED L'opération de l'unité est acceptée et planifiée.
UNIT_OPERATION_STATE_RUNNING L'opération unitaire est en cours d'exécution.
UNIT_OPERATION_STATE_SUCCEEDED L'opération de l'unité a bien été effectuée.
UNIT_OPERATION_STATE_FAILED Échec de l'opération de l'unité.
UNIT_OPERATION_STATE_CANCELLED L'opération de l'unité a été annulée.

UnitOperationCondition

UnitOperationCondition décrit l'état d'une opération d'unité. UnitOperationCondition est un composant individuel qui contribue à un état global.

Représentation JSON 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Champs
status

enum (Status)

Obligatoire. État de la condition.
type

enum (Type)

Obligatoire. Type de la condition.
lastTransitionTime

string (Timestamp format)

Obligatoire. Dernière transition de la condition d'un état à un autre.

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".
message

string

Obligatoire. Message lisible par l'humain indiquant des détails sur la dernière transition.
reason

string

Obligatoire. Brève raison de la dernière transition de la condition.

État

Énumération des états de condition.

Enums
STATUS_UNSPECIFIED L'état de la condition n'est pas spécifié.
STATUS_UNKNOWN L'état est inconnu.
STATUS_TRUE La condition est vraie.
STATUS_FALSE La condition est "false" (faux).

Type

Énumération des types de conditions.

Enums
TYPE_UNSPECIFIED Le type de condition n'est pas spécifié.
TYPE_SCHEDULED un type de condition est planifié ;
TYPE_RUNNING Le type de condition est "En cours d'exécution".
TYPE_SUCCEEDED Le type de condition a été respecté.
TYPE_CANCELLED Le type de condition est annulé.
TYPE_APP_CREATED Indique si l'application AppHub a été créée.
TYPE_APP_COMPONENTS_REGISTERED Indique si des services et des charges de travail ont été enregistrés dans App Hub.

Planification

Spécification de l'heure à laquelle planifier la maintenance.

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

string (Timestamp format)

Facultatif. Début de l'opération. Si elle n'est pas définie, elle sera définie sur le début de la fenêtre suivante. (facultatif)

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".

UnitOperationErrorCategory

UnitOperationErrorCategory décrit la catégorie d'erreur de l'opération unitaire.

Enums
UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED La catégorie d'erreur d'opération d'unité n'est pas spécifiée
NOT_APPLICABLE La catégorie d'erreur d'opération d'unité n'est pas applicable ou il ne s'agit pas d'une erreur
FATAL La catégorie d'erreur d'opération de l'unité est fatale
RETRIABLE La catégorie d'erreur d'opération de l'unité peut être retentée
IGNORABLE La catégorie d'erreur d'opération d'unité peut être ignorée
STANDARD La catégorie d'erreur de l'opération d'unité est standard et est comptabilisée dans la marge d'erreur de déploiement.

Méthodes

create

 Créez une opération unitaire.

delete

 Supprimez une seule opération d'unité.

get

 Récupérez une seule opération d'unité.

list

 Récupérer une collection d'opérations unitaires.

patch

 Mettez à jour une seule opération unitaire.