REST Resource: projects.locations.unitOperations

Ressource: UnitOperation

UnitOperation kapselt die Absicht, die Dienstkomponente zu ändern oder mit ihr zu interagieren, die durch die jeweilige Einheit dargestellt wird. Es können mehrere UnitOperations erstellt (angefordert) und für die Zukunft geplant werden. Es darf jedoch jeweils nur eine ausgeführt werden. Das kann sich in Zukunft für nicht mutierende Vorgänge ändern.

Mit UnitOperations können sich verschiedene Akteure, die mit derselben Einheit interagieren, nur auf die von ihnen angeforderte Änderung konzentrieren.

Dies ist ein Basisobjekt, das die gemeinsamen Felder in allen Einheitsvorgängen enthält. Nächste: 22

JSON-Darstellung 
{
  "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.
}
Felder
name

string

ID. Der Ressourcenname (vollständiger URI der Ressource) gemäß dem Standardbenennungsschema:

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

string

Erforderlich. Nicht veränderbar. Die Einheit, auf die sich ein bestimmter UnitOperation bezieht.
parentUnitOperation

string

Optional. Verweis auf die übergeordnete Ressource: UnitOperation. Wenn bei einem Vorgang im Rahmen seines Workflows andere Vorgänge erstellt werden müssen, sollte dieses Feld für jeden der untergeordneten Vorgänge auf den übergeordneten Vorgang festgelegt werden. Dies kann für das Tracing verwendet werden. (Optional)
rollout

string

Optional. Gibt an, durch welchen Roll-out dieser Vorgang erstellt wurde. Dieser Wert kann nicht geändert werden und wird nur zum Filtern verwendet. Wenn eine abhängige Einheit und ein Einheitsvorgang als Teil eines anderen Einheitsvorgangs erstellt werden, verwenden sie dieselbe rolloutId.
cancel

boolean

Optional. Wenn „true“, wird versucht, den Vorgang abzubrechen. Der Abbruch kann fehlschlagen, wenn der Vorgang bereits ausgeführt wird. (Optional)
state

enum (UnitOperationState)

Optional. Nur Ausgabe. UnitOperationState beschreibt den aktuellen Status des Unit-Vorgangs.
conditions[]

object (UnitOperationCondition)

Optional. Nur Ausgabe. Eine Reihe von Bedingungen, die die verschiedenen Bedingungen angeben, die diese Ressource haben kann.
schedule

object (Schedule)

Optional. Wann dieser Vorgang geplant werden soll.
engineState

string

Optional. Nur Ausgabe. Der Engine-Status für laufende Bereitstellungs-Engine-Vorgänge. Dieses Feld ist für die externe Nutzung nicht sichtbar.
errorCategory

enum (UnitOperationErrorCategory)

Optional. Nur Ausgabe. UnitOperationErrorCategory beschreibt die Fehlerkategorie.
labels

map (key: string, value: string)

Optional. Die Labels der Ressource, die zur Kategorisierung verwendet werden können, ähnlich wie Kubernetes-Ressourcenlabels.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Optional. „Annotations“ ist eine unstrukturierte Schlüssel/Wert-Zuordnung, die mit einer Ressource gespeichert wird und von externen Tools festgelegt werden kann, um beliebige Metadaten zu speichern und abzurufen. Sie können nicht abgefragt werden und sollten beim Ändern von Objekten beibehalten werden.

Weitere Informationen: https://kubernetes.io/docs/user-guide/annotations

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Nur Ausgabe. Die eindeutige Kennzeichnung der Ressource. Die UID gilt zeitlich und räumlich im Rahmen des Dienstes nur für diese eine Ressource. Sie wird in der Regel nach dem Erstellen der Ressource vom Server generiert und darf nicht geändert werden. Die UID dient dazu, Ressourcen, deren Namen wiederverwendet werden, eindeutig zu kennzeichnen. Dies sollte eine UUID4 sein.
etag

string

Nur Ausgabe. Ein opaker Wert, der eine Version oder Generation einer Ressource eindeutig kennzeichnet. Damit kann bestätigt werden, dass Client und Server der Reihenfolge einer Ressource, die gerade geschrieben wird, zustimmen.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource zuletzt aktualisiert wurde. Wenn Nutzer Änderungen an der Ressource vornehmen, muss dieser Wert aktualisiert werden. Gleiches gilt bei Änderungen an der Ressource durch den Dienst.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
deleteTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource zum Löschen markiert wurde. Das Löschen ist ein asynchroner Vorgang.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Union-Feld unit_operation_type.

Für unit_operation_type ist nur einer der folgenden Werte zulässig:
provision

object (Provision)
upgrade

object (Upgrade)
deprovision

object (Deprovision)

Bereitstellung

„Provision“ ist der Einheitsvorgang, mit dem die zugrunde liegenden Ressourcen bereitgestellt werden, die durch eine Einheit dargestellt werden. Kann nur ausgeführt werden, wenn die Einheit derzeit nicht bereitgestellt wird.

JSON-Darstellung 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Felder
release

string

Optional. Verweis auf das Release-Objekt, das für die Einheit verwendet werden soll. Optional:
inputVariables[]

object (UnitVariable)

Optional. Satz von Eingabevariablen. Maximal 100. (optional)

Upgrade

„Upgrade“ ist der Einheitsvorgang, mit dem eine bereitgestellte Einheit aktualisiert wird. Dies kann auch die zugrunde liegenden Ressourcen umfassen, die durch eine Einheit dargestellt werden. Kann nur ausgeführt werden, wenn die Einheit derzeit bereitgestellt wird.

JSON-Darstellung 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Felder
release

string

Optional. Verweis auf das Release-Objekt, das für die Einheit verwendet werden soll. Optional:
inputVariables[]

object (UnitVariable)

Optional. Satz von Eingabevariablen. Maximal 100. (optional)

Bereitstellung aufheben

Dieser Typ hat keine Felder.

„Deprovision“ ist der Einheitsvorgang, mit dem die Bereitstellung der zugrunde liegenden Ressourcen aufgehoben wird, die durch eine Einheit dargestellt werden. Kann nur ausgeführt werden, wenn die Einheit derzeit bereitgestellt wird.

UnitOperationState

UnitOperationState beschreibt den aktuellen Status des Unit-Vorgangs.

Enums
UNIT_OPERATION_STATE_UNKNOWN
UNIT_OPERATION_STATE_PENDING Der Vorgang wurde akzeptiert, kann aber noch nicht ausgeführt werden.
UNIT_OPERATION_STATE_SCHEDULED Der Einheitsvorgang wird akzeptiert und geplant.
UNIT_OPERATION_STATE_RUNNING Der Vorgang wird ausgeführt.
UNIT_OPERATION_STATE_SUCCEEDED Der Vorgang wurde erfolgreich abgeschlossen.
UNIT_OPERATION_STATE_FAILED Der Vorgang ist fehlgeschlagen.
UNIT_OPERATION_STATE_CANCELLED Der Einheitsvorgang wurde abgebrochen.

UnitOperationCondition

„UnitOperationCondition“ beschreibt den Status eines Unit-Vorgangs. „UnitOperationCondition“ sind einzelne Komponenten, die zu einem Gesamtzustand beitragen.

JSON-Darstellung 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Felder
status

enum (Status)

Erforderlich. Status der Bedingung.
type

enum (Type)

Erforderlich. Typ der Bedingung.
lastTransitionTime

string (Timestamp format)

Erforderlich. Der Zeitpunkt der letzten Änderung der Bedingung von einem Status in einen anderen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
message

string

Erforderlich. Eine menschenlesbare Nachricht mit Details zur letzten Statusänderung.
reason

string

Erforderlich. Kurzer Grund für die letzte Statusänderung der Bedingung.

Status

Aufzählung der Status von Bedingungen.

Enums
STATUS_UNSPECIFIED Der Status der Bedingung ist nicht angegeben.
STATUS_UNKNOWN Die Bedingung ist unbekannt.
STATUS_TRUE Die Bedingung ist wahr.
STATUS_FALSE Die Bedingung ist falsch.

Typ

Aufzählung der Bedingungstypen.

Enums
TYPE_UNSPECIFIED Der Bedingungstyp ist nicht angegeben.
TYPE_SCHEDULED Der Bedingungstyp ist geplant.
TYPE_RUNNING Der Bedingungstyp wird ausgeführt.
TYPE_SUCCEEDED Der Bedingungstyp wurde erfolgreich ausgeführt.
TYPE_CANCELLED Der Bedingungstyp wurde abgebrochen.
TYPE_APP_CREATED Gibt an, ob eine AppHub-App erstellt wurde.
TYPE_APP_COMPONENTS_REGISTERED Gibt an, ob Dienste und Arbeitslasten bei App Hub registriert wurden.

Zeitplan

Eine Zeitangabe zum Planen der Wartung.

JSON-Darstellung 
{
  "startTime": string
}
Felder
startTime

string (Timestamp format)

Optional. Beginn des Vorgangs. Wenn nicht festgelegt, wird der Wert auf den Beginn des nächsten Fensters gesetzt. (optional)

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

UnitOperationErrorCategory

UnitOperationErrorCategory beschreibt die Fehlerkategorie des Unit-Vorgangs.

Enums
UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED Fehlerkategorie für Vorgang für Einheit nicht angegeben
NOT_APPLICABLE Die Fehlerkategorie für den Einheitsvorgang ist nicht anwendbar oder es handelt sich nicht um einen Fehler.
FATAL Fehlerkategorie für Einheitsvorgang ist schwerwiegend
RETRIABLE Fehlerkategorie für Einheitsvorgang kann wiederholt werden
IGNORABLE Die Fehlerkategorie für den Vorgang für Einheiten kann ignoriert werden
STANDARD Die Fehlerkategorie für den Vorgang für die Einheit ist Standard und wird auf das Roll‑out-Fehlerbudget angerechnet.

Methoden

create

 Erstellen Sie einen neuen Verfahrensschritt.

delete

 Einzelnen Vorgang für eine Einheit löschen.

get

 Einzelnen Einheitsvorgang abrufen

list

 Eine Sammlung von Einheitsvorgängen abrufen.

patch

 Einzelnen Unit-Vorgang aktualisieren