public sealed class Unit : IMessage<Unit>, IEquatable<Unit>, IDeepCloneable<Unit>, IBufferMessage, IMessage
Reference documentation and code samples for the SaaS Runtime v1beta1 API 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.
Namespace
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1Assembly
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll
Constructors
Unit()
public Unit()
Unit(Unit)
public Unit(Unit other)
Parameter | |
---|---|
Name | Description |
other |
Unit |
Properties
Annotations
public MapField<string, string> Annotations { get; }
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
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
Conditions
public RepeatedField<UnitCondition> Conditions { get; }
Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
Property Value | |
---|---|
Type | Description |
RepeatedFieldUnitCondition |
CreateTime
public Timestamp CreateTime { get; set; }
Output only. The timestamp when the resource was created.
Property Value | |
---|---|
Type | Description |
Timestamp |
Dependencies
public RepeatedField<UnitDependency> Dependencies { get; }
Optional. Output only. Set of dependencies for this unit. Maximum 10.
Property Value | |
---|---|
Type | Description |
RepeatedFieldUnitDependency |
Dependents
public RepeatedField<UnitDependency> Dependents { get; }
Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
Property Value | |
---|---|
Type | Description |
RepeatedFieldUnitDependency |
Etag
public string Etag { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
InputVariables
public RepeatedField<UnitVariable> InputVariables { get; }
Optional. Output only. Indicates the current input variables deployed by the unit
Property Value | |
---|---|
Type | Description |
RepeatedFieldUnitVariable |
Labels
public MapField<string, string> Labels { get; }
Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
Maintenance
public Unit.Types.MaintenanceSettings Maintenance { get; set; }
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.
Property Value | |
---|---|
Type | Description |
UnitTypesMaintenanceSettings |
ManagementMode
public Unit.Types.ManagementMode ManagementMode { get; set; }
Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
Property Value | |
---|---|
Type | Description |
UnitTypesManagementMode |
Name
public string Name { get; set; }
Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/units/{unit}"
Property Value | |
---|---|
Type | Description |
string |
OngoingOperations
public RepeatedField<string> OngoingOperations { get; }
Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
Property Value | |
---|---|
Type | Description |
RepeatedFieldstring |
OngoingOperationsAsUnitOperationNames
public ResourceNameList<UnitOperationName> OngoingOperationsAsUnitOperationNames { get; }
UnitOperationName-typed view over the OngoingOperations resource name property.
Property Value | |
---|---|
Type | Description |
ResourceNameListUnitOperationName |
OutputVariables
public RepeatedField<UnitVariable> OutputVariables { get; }
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.
Property Value | |
---|---|
Type | Description |
RepeatedFieldUnitVariable |
PendingOperations
public RepeatedField<string> PendingOperations { get; }
Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
Property Value | |
---|---|
Type | Description |
RepeatedFieldstring |
PendingOperationsAsUnitOperationNames
public ResourceNameList<UnitOperationName> PendingOperationsAsUnitOperationNames { get; }
UnitOperationName-typed view over the PendingOperations resource name property.
Property Value | |
---|---|
Type | Description |
ResourceNameListUnitOperationName |
Release
public string Release { get; set; }
Optional. Output only. The current Release object for this Unit.
Property Value | |
---|---|
Type | Description |
string |
ReleaseAsReleaseName
public ReleaseName ReleaseAsReleaseName { get; set; }
ReleaseName-typed view over the Release resource name property.
Property Value | |
---|---|
Type | Description |
ReleaseName |
ScheduledOperations
public RepeatedField<string> ScheduledOperations { get; }
Optional. Output only. List of scheduled UnitOperations for this unit.
Property Value | |
---|---|
Type | Description |
RepeatedFieldstring |
ScheduledOperationsAsUnitOperationNames
public ResourceNameList<UnitOperationName> ScheduledOperationsAsUnitOperationNames { get; }
UnitOperationName-typed view over the ScheduledOperations resource name property.
Property Value | |
---|---|
Type | Description |
ResourceNameListUnitOperationName |
State
public Unit.Types.UnitState State { get; set; }
Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
Property Value | |
---|---|
Type | Description |
UnitTypesUnitState |
SystemCleanupAt
public Timestamp SystemCleanupAt { get; set; }
Optional. Output only. If set, indicates the time when the system will start removing the unit.
Property Value | |
---|---|
Type | Description |
Timestamp |
SystemManagedState
public Unit.Types.SystemManagedState SystemManagedState { get; set; }
Optional. Output only. Indicates the system managed state of the unit.
Property Value | |
---|---|
Type | Description |
UnitTypesSystemManagedState |
Tenant
public string Tenant { get; set; }
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)
Property Value | |
---|---|
Type | Description |
string |
TenantAsTenantName
public TenantName TenantAsTenantName { get; set; }
TenantName-typed view over the Tenant resource name property.
Property Value | |
---|---|
Type | Description |
TenantName |
Uid
public string Uid { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
UnitKind
public string UnitKind { get; set; }
Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
Property Value | |
---|---|
Type | Description |
string |
UnitKindAsUnitKindName
public UnitKindName UnitKindAsUnitKindName { get; set; }
UnitKindName-typed view over the UnitKind resource name property.
Property Value | |
---|---|
Type | Description |
UnitKindName |
UnitName
public UnitName UnitName { get; set; }
Property Value | |
---|---|
Type | Description |
UnitName |
UpdateTime
public Timestamp UpdateTime { get; set; }
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.
Property Value | |
---|---|
Type | Description |
Timestamp |