Show / Hide Table of Contents

Class Unit

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.

Inheritance
object
Unit
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SaaSServiceManagement.v1beta1.Data
Assembly: Google.Apis.SaaSServiceManagement.v1beta1.dll
Syntax
public class Unit : IDirectResponseSchema

Properties

Annotations

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

Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type Description
IDictionary<string, string>

Conditions

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

Declaration
[JsonProperty("conditions")]
public virtual IList<UnitCondition> Conditions { get; set; }
Property Value
Type Description
IList<UnitCondition>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The timestamp when the resource was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Dependencies

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

Declaration
[JsonProperty("dependencies")]
public virtual IList<UnitDependency> Dependencies { get; set; }
Property Value
Type Description
IList<UnitDependency>

Dependents

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

Declaration
[JsonProperty("dependents")]
public virtual IList<UnitDependency> Dependents { get; set; }
Property Value
Type Description
IList<UnitDependency>

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

InputVariables

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

Declaration
[JsonProperty("inputVariables")]
public virtual IList<UnitVariable> InputVariables { get; set; }
Property Value
Type Description
IList<UnitVariable>

Labels

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

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Maintenance

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.

Declaration
[JsonProperty("maintenance")]
public virtual MaintenanceSettings Maintenance { get; set; }
Property Value
Type Description
MaintenanceSettings

ManagementMode

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

Declaration
[JsonProperty("managementMode")]
public virtual string ManagementMode { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OngoingOperations

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

Declaration
[JsonProperty("ongoingOperations")]
public virtual IList<string> OngoingOperations { get; set; }
Property Value
Type Description
IList<string>

OutputVariables

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.

Declaration
[JsonProperty("outputVariables")]
public virtual IList<UnitVariable> OutputVariables { get; set; }
Property Value
Type Description
IList<UnitVariable>

PendingOperations

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

Declaration
[JsonProperty("pendingOperations")]
public virtual IList<string> PendingOperations { get; set; }
Property Value
Type Description
IList<string>

Release

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

Declaration
[JsonProperty("release")]
public virtual string Release { get; set; }
Property Value
Type Description
string

ScheduledOperations

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

Declaration
[JsonProperty("scheduledOperations")]
public virtual IList<string> ScheduledOperations { get; set; }
Property Value
Type Description
IList<string>

State

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

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

SystemCleanupAt

object representation of SystemCleanupAtRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use SystemCleanupAtDateTimeOffset instead.")]
public virtual object SystemCleanupAt { get; set; }
Property Value
Type Description
object

SystemCleanupAtDateTimeOffset

DateTimeOffset representation of SystemCleanupAtRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? SystemCleanupAtDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

SystemCleanupAtRaw

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

Declaration
[JsonProperty("systemCleanupAt")]
public virtual string SystemCleanupAtRaw { get; set; }
Property Value
Type Description
string

SystemManagedState

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

Declaration
[JsonProperty("systemManagedState")]
public virtual string SystemManagedState { get; set; }
Property Value
Type Description
string

Tenant

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)

Declaration
[JsonProperty("tenant")]
public virtual string Tenant { get; set; }
Property Value
Type Description
string

Uid

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.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UnitKind

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

Declaration
[JsonProperty("unitKind")]
public virtual string UnitKind { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX