Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

UnitOperation

import type { UnitOperation } from "https://googleapis.deno.dev/v1/saasservicemgmt:v1beta1.ts";

UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations). UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested. This is a base object that contains the common fields in all unit operations.

interface UnitOperation {

annotations?: {

[key: string]: string;

};

cancel?: boolean;

readonly conditions?: UnitOperationCondition[];

readonly createTime?: Date;

deprovision?: Deprovision;

readonly engineState?: string;

readonly errorCategory?:

| "UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED"

| "NOT_APPLICABLE"

| "FATAL"

| "RETRIABLE"

| "IGNORABLE"

| "STANDARD";

readonly etag?: string;

labels?: {

[key: string]: string;

};

name?: string;

parentUnitOperation?: string;

provision?: Provision;

rollout?: string;

schedule?: Schedule;

readonly state?:

| "UNIT_OPERATION_STATE_UNKNOWN"

| "UNIT_OPERATION_STATE_PENDING"

| "UNIT_OPERATION_STATE_SCHEDULED"

| "UNIT_OPERATION_STATE_RUNNING"

| "UNIT_OPERATION_STATE_SUCCEEDED"

| "UNIT_OPERATION_STATE_FAILED"

| "UNIT_OPERATION_STATE_CANCELLED";

readonly uid?: string;

unit?: string;

readonly updateTime?: Date;

upgrade?: Upgrade;

}

§Properties

annotations?: {

[key: string]: string;

}

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

cancel?: boolean

Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)

readonly conditions?: UnitOperationCondition[]

Optional. Output only. A set of conditions which indicate the various conditions this resource can have.

readonly createTime?: Date

Output only. The timestamp when the resource was created.

deprovision?: Deprovision

readonly engineState?: string

Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.

readonly errorCategory?: "UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED" | "NOT_APPLICABLE" | "FATAL" | "RETRIABLE" | "IGNORABLE" | "STANDARD"

Optional. Output only. UnitOperationErrorCategory describe the error category.

readonly etag?: string

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

labels?: {

[key: string]: string;

}

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

name?: string

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}"

parentUnitOperation?: string

Optional. Reference to parent resource: UnitOperation. If an operation needs to create other operations as part of its workflow, each of the child operations should have this field set to the parent. This can be used for tracing. (Optional)

provision?: Provision

rollout?: string

Optional. Specifies which rollout created this Unit Operation. This cannot be modified and is used for filtering purposes only. If a dependent unit and unit operation are created as part of another unit operation, they will use the same rolloutId.

schedule?: Schedule

Optional. When to schedule this operation.

readonly state?: "UNIT_OPERATION_STATE_UNKNOWN" | "UNIT_OPERATION_STATE_PENDING" | "UNIT_OPERATION_STATE_SCHEDULED" | "UNIT_OPERATION_STATE_RUNNING" | "UNIT_OPERATION_STATE_SUCCEEDED" | "UNIT_OPERATION_STATE_FAILED" | "UNIT_OPERATION_STATE_CANCELLED"

Optional. Output only. UnitOperationState describes the current state of the unit operation.

readonly uid?: string

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

unit?: string

Required. Immutable. The Unit a given UnitOperation will act upon.

readonly updateTime?: Date

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

upgrade?: Upgrade