Interface UnitOperationOrBuilder (0.2.0)

public interface UnitOperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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
Returns
Type Description
boolean

containsLabels(String key)

public abstract 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
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract 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

getAnnotationsMap()

public abstract 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];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract 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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract 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

getCancel()

public abstract 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.

getConditions(int index)

public abstract 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
Returns
Type Description
UnitOperationCondition

getConditionsCount()

public abstract 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

getConditionsList()

public abstract 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];

Returns
Type Description
List<UnitOperationCondition>

getConditionsOrBuilder(int index)

public abstract 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
Returns
Type Description
UnitOperationConditionOrBuilder

getConditionsOrBuilderList()

public abstract 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>

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDeprovision()

public abstract Deprovision getDeprovision()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Deprovision deprovision = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Deprovision

The deprovision.

getDeprovisionOrBuilder()

public abstract DeprovisionOrBuilder getDeprovisionOrBuilder()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Deprovision deprovision = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeprovisionOrBuilder

getEngineState()

public abstract 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.

getEngineStateBytes()

public abstract 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.

getErrorCategory()

public abstract 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];

Returns
Type Description
UnitOperationErrorCategory

The errorCategory.

getErrorCategoryValue()

public abstract 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.

getEtag()

public abstract String getEtag()

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.

getEtagBytes()

public abstract 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.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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

getLabelsMap()

public abstract 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];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract 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

getName()

public abstract String getName()

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.

getNameBytes()

public abstract 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.

getParentUnitOperation()

public abstract 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.

getParentUnitOperationBytes()

public abstract 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.

getProvision()

public abstract Provision getProvision()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Provision provision = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Provision

The provision.

getProvisionOrBuilder()

public abstract ProvisionOrBuilder getProvisionOrBuilder()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Provision provision = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProvisionOrBuilder

getRollout()

public abstract 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.

getRolloutBytes()

public abstract 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.

getSchedule()

public abstract 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.

getScheduleOrBuilder()

public abstract ScheduleOrBuilder getScheduleOrBuilder()

Optional. When to schedule this operation.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Schedule schedule = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ScheduleOrBuilder

getState()

public abstract 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];

Returns
Type Description
UnitOperation.UnitOperationState

The state.

getStateValue()

public abstract 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.

getUid()

public abstract String getUid()

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.

getUidBytes()

public abstract 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.

getUnit()

public abstract String getUnit()

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.

getUnitBytes()

public abstract 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.

getUnitOperationTypeCase()

public abstract UnitOperation.UnitOperationTypeCase getUnitOperationTypeCase()
Returns
Type Description
UnitOperation.UnitOperationTypeCase

getUpdateTime()

public abstract 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.

getUpdateTimeOrBuilder()

public abstract 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];

Returns
Type Description
TimestampOrBuilder

getUpgrade()

public abstract Upgrade getUpgrade()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Upgrade upgrade = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Upgrade

The upgrade.

getUpgradeOrBuilder()

public abstract UpgradeOrBuilder getUpgradeOrBuilder()

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Upgrade upgrade = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpgradeOrBuilder

hasCreateTime()

public abstract 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.

hasDeprovision()

public abstract 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.

hasProvision()

public abstract 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.

hasSchedule()

public abstract 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.

hasUpdateTime()

public abstract 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.

hasUpgrade()

public abstract 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.