Unit

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

A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

interface Unit {

annotations?: {

[key: string]: string;

};

readonly conditions?: UnitCondition[];

readonly createTime?: Date;

readonly dependencies?: UnitDependency[];

readonly dependents?: UnitDependency[];

readonly etag?: string;

readonly inputVariables?: UnitVariable[];

labels?: {

[key: string]: string;

};

maintenance?: MaintenanceSettings;

managementMode?: "MANAGEMENT_MODE_UNSPECIFIED" | "MANAGEMENT_MODE_USER" | "MANAGEMENT_MODE_SYSTEM";

name?: string;

readonly ongoingOperations?: string[];

readonly outputVariables?: UnitVariable[];

readonly pendingOperations?: string[];

readonly release?: string;

readonly scheduledOperations?: string[];

readonly state?:

| "UNIT_STATE_UNSPECIFIED"

| "UNIT_STATE_NOT_PROVISIONED"

| "UNIT_STATE_PROVISIONING"

| "UNIT_STATE_UPDATING"

| "UNIT_STATE_DEPROVISIONING"

| "UNIT_STATE_READY"

| "UNIT_STATE_ERROR";

readonly systemCleanupAt?: Date;

readonly systemManagedState?:

| "SYSTEM_MANAGED_STATE_UNSPECIFIED"

| "SYSTEM_MANAGED_STATE_ACTIVE"

| "SYSTEM_MANAGED_STATE_INACTIVE"

| "SYSTEM_MANAGED_STATE_DECOMMISSIONED";

tenant?: string;

readonly uid?: string;

unitKind?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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

readonly conditions?: UnitCondition[]

[src]

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

readonly createTime?: Date

[src]

Output only. The timestamp when the resource was created.

readonly dependencies?: UnitDependency[]

[src]

Optional. Output only. Set of dependencies for this unit. Maximum 10.

readonly dependents?: UnitDependency[]

[src]

Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.

readonly etag?: string

[src]

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.

readonly inputVariables?: UnitVariable[]

[src]

Optional. Output only. Indicates the current input variables deployed by the unit

labels?: {

[key: string]: string;

}

[src]

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

maintenance?: MaintenanceSettings

[src]

Optional. Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.

managementMode?: "MANAGEMENT_MODE_UNSPECIFIED" | "MANAGEMENT_MODE_USER" | "MANAGEMENT_MODE_SYSTEM"

[src]

Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.

name?: string

[src]

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

readonly ongoingOperations?: string[]

[src]

Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

readonly outputVariables?: UnitVariable[]

[src]

Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.

readonly pendingOperations?: string[]

[src]

Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

readonly release?: string

[src]

Optional. Output only. The current Release object for this Unit.

readonly scheduledOperations?: string[]

[src]

Optional. Output only. List of scheduled UnitOperations for this unit.

[src]

Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).

readonly systemCleanupAt?: Date

[src]

Optional. Output only. If set, indicates the time when the system will start removing the unit.

readonly systemManagedState?: "SYSTEM_MANAGED_STATE_UNSPECIFIED" | "SYSTEM_MANAGED_STATE_ACTIVE" | "SYSTEM_MANAGED_STATE_INACTIVE" | "SYSTEM_MANAGED_STATE_DECOMMISSIONED"

[src]

Optional. Output only. Indicates the system managed state of the unit.

tenant?: string

[src]

Optional. Reference to the Saas Tenant resource this unit belongs to. This for example informs the maintenance policies to use for scheduling future updates on a unit. (optional and immutable once created)

readonly uid?: string

[src]

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.

unitKind?: string

[src]

Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

readonly updateTime?: Date

[src]

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.