public sealed class UnitOperation : IMessage<UnitOperation>, IEquatable<UnitOperation>, IDeepCloneable<UnitOperation>, IBufferMessage, IMessageReference documentation and code samples for the SaaS Runtime v1beta1 API class UnitOperation.
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. Next: 19
Implements
IMessageUnitOperation, IEquatableUnitOperation, IDeepCloneableUnitOperation, IBufferMessage, IMessageNamespace
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1Assembly
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll
Constructors
UnitOperation()
public UnitOperation()UnitOperation(UnitOperation)
public UnitOperation(UnitOperation other)| Parameter | |
|---|---|
| Name | Description |
other |
UnitOperation |
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 |
|
Cancel
public bool Cancel { get; set; }Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Conditions
public RepeatedField<UnitOperationCondition> Conditions { get; }Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldUnitOperationCondition |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp when the resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Deprovision
public Deprovision Deprovision { get; set; }| Property Value | |
|---|---|
| Type | Description |
Deprovision |
|
EngineState
public string EngineState { get; set; }Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ErrorCategory
public UnitOperationErrorCategory ErrorCategory { get; set; }Optional. Output only. UnitOperationErrorCategory describe the error category.
| Property Value | |
|---|---|
| Type | Description |
UnitOperationErrorCategory |
|
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 |
|
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 |
|
Name
public string Name { get; set; }Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/unitOperations/{unitOperation}"
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentUnitOperation
public string ParentUnitOperation { get; set; }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)
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentUnitOperationAsUnitOperationName
public UnitOperationName ParentUnitOperationAsUnitOperationName { get; set; }UnitOperationName-typed view over the ParentUnitOperation resource name property.
| Property Value | |
|---|---|
| Type | Description |
UnitOperationName |
|
Provision
public Provision Provision { get; set; }| Property Value | |
|---|---|
| Type | Description |
Provision |
|
Rollout
public string Rollout { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
RolloutAsRolloutName
public RolloutName RolloutAsRolloutName { get; set; }RolloutName-typed view over the Rollout resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutName |
|
Schedule
public Schedule Schedule { get; set; }Optional. When to schedule this operation.
| Property Value | |
|---|---|
| Type | Description |
Schedule |
|
State
public UnitOperation.Types.UnitOperationState State { get; set; }Optional. Output only. UnitOperationState describes the current state of the unit operation.
| Property Value | |
|---|---|
| Type | Description |
UnitOperationTypesUnitOperationState |
|
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 |
|
Unit
public string Unit { get; set; }Required. Immutable. The Unit a given UnitOperation will act upon.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UnitAsUnitName
public UnitName UnitAsUnitName { get; set; }| Property Value | |
|---|---|
| Type | Description |
UnitName |
|
UnitOperationName
public UnitOperationName UnitOperationName { get; set; }UnitOperationName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
UnitOperationName |
|
UnitOperationTypeCase
public UnitOperation.UnitOperationTypeOneofCase UnitOperationTypeCase { get; }| Property Value | |
|---|---|
| Type | Description |
UnitOperationUnitOperationTypeOneofCase |
|
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 |
|
Upgrade
public Upgrade Upgrade { get; set; }| Property Value | |
|---|---|
| Type | Description |
Upgrade |
|