public final class UnitOperation extends GeneratedMessageV3 implements UnitOperationOrBuilder
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
Protobuf type google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CANCEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CONDITIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DEPROVISION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENGINE_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ERROR_CATEGORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_UNIT_OPERATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROVISION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ROLLOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCHEDULE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UNIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPGRADE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static UnitOperation getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static UnitOperation.Builder newBuilder()
public static UnitOperation.Builder newBuilder(UnitOperation prototype)
public static UnitOperation parseDelimitedFrom(InputStream input)
public static UnitOperation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UnitOperation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static UnitOperation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UnitOperation parseFrom(ByteString data)
public static UnitOperation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UnitOperation parseFrom(CodedInputStream input)
public static UnitOperation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UnitOperation parseFrom(InputStream input)
public static UnitOperation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UnitOperation parseFrom(ByteBuffer data)
public static UnitOperation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<UnitOperation> parser()
Methods
public boolean containsAnnotations(String key)
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
map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public boolean containsLabels(String key)
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Map<String,String> getAnnotations()
public int getAnnotationsCount()
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
map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getAnnotationsMap()
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
map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];
public String getAnnotationsOrDefault(String key, String defaultValue)
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
map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
public String getAnnotationsOrThrow(String key)
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
map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public boolean getCancel()
Optional. When true, attempt to cancel the operation. Cancellation may fail
if the operation is already executing. (Optional)
bool cancel = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The cancel.
|
public UnitOperationCondition getConditions(int index)
Optional. Output only. A set of conditions which indicate the various
conditions this resource can have.
repeated .google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationCondition conditions = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public int getConditionsCount()
Optional. Output only. A set of conditions which indicate the various
conditions this resource can have.
repeated .google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationCondition conditions = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public List<UnitOperationCondition> getConditionsList()
Optional. Output only. A set of conditions which indicate the various
conditions this resource can have.
repeated .google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationCondition conditions = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
public UnitOperationConditionOrBuilder getConditionsOrBuilder(int index)
Optional. Output only. A set of conditions which indicate the various
conditions this resource can have.
repeated .google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationCondition conditions = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends UnitOperationConditionOrBuilder> getConditionsOrBuilderList()
Optional. Output only. A set of conditions which indicate the various
conditions this resource can have.
repeated .google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationCondition conditions = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationConditionOrBuilder> |
|
public Timestamp getCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UnitOperation getDefaultInstanceForType()
public Deprovision getDeprovision()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Deprovision deprovision = 10 [(.google.api.field_behavior) = OPTIONAL];
public DeprovisionOrBuilder getDeprovisionOrBuilder()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Deprovision deprovision = 10 [(.google.api.field_behavior) = OPTIONAL];
public String getEngineState()
Optional. Output only. The engine state for on-going
deployment engine operation(s).
This field is opaque for external usage.
string engine_state = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The engineState.
|
public ByteString getEngineStateBytes()
Optional. Output only. The engine state for on-going
deployment engine operation(s).
This field is opaque for external usage.
string engine_state = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for engineState.
|
public UnitOperationErrorCategory getErrorCategory()
Optional. Output only. UnitOperationErrorCategory describe the error
category.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationErrorCategory error_category = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
public int getErrorCategoryValue()
Optional. Output only. UnitOperationErrorCategory describe the error
category.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperationErrorCategory error_category = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for errorCategory.
|
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.
string etag = 10202 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The etag.
|
public ByteString getEtagBytes()
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.
string etag = 10202 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
public Map<String,String> getLabels()
public int getLabelsCount()
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getLabelsMap()
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelsOrDefault(String key, String defaultValue)
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
public String getLabelsOrThrow(String key)
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
Identifier. The resource name (full URI of the resource) following the
standard naming scheme:
"projects/{project}/locations/{___location}/unitOperations/{unitOperation}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The resource name (full URI of the resource) following the
standard naming scheme:
"projects/{project}/locations/{___location}/unitOperations/{unitOperation}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public String getParentUnitOperation()
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)
string parent_unit_operation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parentUnitOperation.
|
public ByteString getParentUnitOperationBytes()
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)
string parent_unit_operation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parentUnitOperation.
|
public Parser<UnitOperation> getParserForType()
Overrides
public Provision getProvision()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Provision provision = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Provision |
The provision.
|
public ProvisionOrBuilder getProvisionOrBuilder()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Provision provision = 8 [(.google.api.field_behavior) = OPTIONAL];
public String getRollout()
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.
string rollout = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The rollout.
|
public ByteString getRolloutBytes()
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.
string rollout = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for rollout.
|
public Schedule getSchedule()
Optional. When to schedule this operation.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Schedule schedule = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Schedule |
The schedule.
|
public ScheduleOrBuilder getScheduleOrBuilder()
Optional. When to schedule this operation.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Schedule schedule = 12 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public UnitOperation.UnitOperationState getState()
Optional. Output only. UnitOperationState describes the current state of
the unit operation.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperation.UnitOperationState state = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Optional. Output only. UnitOperationState describes the current state of
the unit operation.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.UnitOperation.UnitOperationState state = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
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.
string uid = 10201 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
String |
The uid.
|
public ByteString getUidBytes()
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.
string uid = 10201 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for uid.
|
Required. Immutable. The Unit a given UnitOperation will act upon.
string unit = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The unit.
|
public ByteString getUnitBytes()
Required. Immutable. The Unit a given UnitOperation will act upon.
string unit = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for unit.
|
public UnitOperation.UnitOperationTypeCase getUnitOperationTypeCase()
public Timestamp getUpdateTime()
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.
.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
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.
.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Upgrade getUpgrade()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Upgrade upgrade = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Upgrade |
The upgrade.
|
public UpgradeOrBuilder getUpgradeOrBuilder()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Upgrade upgrade = 9 [(.google.api.field_behavior) = OPTIONAL];
public boolean hasCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasDeprovision()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Deprovision deprovision = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the deprovision field is set.
|
public boolean hasProvision()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Provision provision = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the provision field is set.
|
public boolean hasSchedule()
Optional. When to schedule this operation.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Schedule schedule = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the schedule field is set.
|
public boolean hasUpdateTime()
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.
.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
public boolean hasUpgrade()
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Upgrade upgrade = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the upgrade field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public UnitOperation.Builder newBuilderForType()
protected UnitOperation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public UnitOperation.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
