Class AutomationRun (1.53.0) 

public final class AutomationRun extends GeneratedMessageV3 implements AutomationRunOrBuilder

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

Protobuf type google.cloud.deploy.v1.AutomationRun

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AutomationRun

Static Fields

ADVANCE_ROLLOUT_OPERATION_FIELD_NUMBER

public static final int ADVANCE_ROLLOUT_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

AUTOMATION_ID_FIELD_NUMBER

public static final int AUTOMATION_ID_FIELD_NUMBER
Field Value
Type Description
int

AUTOMATION_SNAPSHOT_FIELD_NUMBER

public static final int AUTOMATION_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

POLICY_VIOLATION_FIELD_NUMBER

public static final int POLICY_VIOLATION_FIELD_NUMBER
Field Value
Type Description
int

PROMOTE_RELEASE_OPERATION_FIELD_NUMBER

public static final int PROMOTE_RELEASE_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

REPAIR_ROLLOUT_OPERATION_FIELD_NUMBER

public static final int REPAIR_ROLLOUT_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

RULE_ID_FIELD_NUMBER

public static final int RULE_ID_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_DESCRIPTION_FIELD_NUMBER

public static final int STATE_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_ID_FIELD_NUMBER

public static final int TARGET_ID_FIELD_NUMBER
Field Value
Type Description
int

TIMED_PROMOTE_RELEASE_OPERATION_FIELD_NUMBER

public static final int TIMED_PROMOTE_RELEASE_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WAIT_UNTIL_TIME_FIELD_NUMBER

public static final int WAIT_UNTIL_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutomationRun getDefaultInstance()
Returns
Type Description
AutomationRun

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AutomationRun.Builder newBuilder()
Returns
Type Description
AutomationRun.Builder

newBuilder(AutomationRun prototype)

public static AutomationRun.Builder newBuilder(AutomationRun prototype)
Parameter
Name Description
prototype AutomationRun
Returns
Type Description
AutomationRun.Builder

parseDelimitedFrom(InputStream input)

public static AutomationRun parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AutomationRun parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutomationRun parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutomationRun parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AutomationRun parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AutomationRun parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutomationRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutomationRun
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AutomationRun> parser()
Returns
Type Description
Parser<AutomationRun>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdvanceRolloutOperation()

public AdvanceRolloutOperation getAdvanceRolloutOperation()

Output only. Advances a rollout to the next phase.

.google.cloud.deploy.v1.AdvanceRolloutOperation advance_rollout_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AdvanceRolloutOperation

The advanceRolloutOperation.

getAdvanceRolloutOperationOrBuilder()

public AdvanceRolloutOperationOrBuilder getAdvanceRolloutOperationOrBuilder()

Output only. Advances a rollout to the next phase.

.google.cloud.deploy.v1.AdvanceRolloutOperation advance_rollout_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AdvanceRolloutOperationOrBuilder

getAutomationId()

public String getAutomationId()

Output only. The ID of the automation that initiated the operation.

string automation_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The automationId.

getAutomationIdBytes()

public ByteString getAutomationIdBytes()

Output only. The ID of the automation that initiated the operation.

string automation_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for automationId.

getAutomationSnapshot()

public Automation getAutomationSnapshot()

Output only. Snapshot of the Automation taken at AutomationRun creation time.

.google.cloud.deploy.v1.Automation automation_snapshot = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Automation

The automationSnapshot.

getAutomationSnapshotOrBuilder()

public AutomationOrBuilder getAutomationSnapshotOrBuilder()

Output only. Snapshot of the Automation taken at AutomationRun creation time.

.google.cloud.deploy.v1.Automation automation_snapshot = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AutomationOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Time at which the AutomationRun was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the AutomationRun was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AutomationRun getDefaultInstanceForType()
Returns
Type Description
AutomationRun

getEtag()

public String getEtag()

Output only. The weak etag of the AutomationRun resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. The weak etag of the AutomationRun resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getExpireTime()

public Timestamp getExpireTime()

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

.google.protobuf.Timestamp expire_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

.google.protobuf.Timestamp expire_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOperationCase()

public AutomationRun.OperationCase getOperationCase()
Returns
Type Description
AutomationRun.OperationCase

getParserForType()

public Parser<AutomationRun> getParserForType()
Returns
Type Description
Parser<AutomationRun>
Overrides

getPolicyViolation()

public PolicyViolation getPolicyViolation()

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

.google.cloud.deploy.v1.PolicyViolation policy_violation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyViolation

The policyViolation.

getPolicyViolationOrBuilder()

public PolicyViolationOrBuilder getPolicyViolationOrBuilder()

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

.google.cloud.deploy.v1.PolicyViolation policy_violation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyViolationOrBuilder

getPromoteReleaseOperation()

public PromoteReleaseOperation getPromoteReleaseOperation()

Output only. Promotes a release to a specified 'Target'.

.google.cloud.deploy.v1.PromoteReleaseOperation promote_release_operation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PromoteReleaseOperation

The promoteReleaseOperation.

getPromoteReleaseOperationOrBuilder()

public PromoteReleaseOperationOrBuilder getPromoteReleaseOperationOrBuilder()

Output only. Promotes a release to a specified 'Target'.

.google.cloud.deploy.v1.PromoteReleaseOperation promote_release_operation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PromoteReleaseOperationOrBuilder

getRepairRolloutOperation()

public RepairRolloutOperation getRepairRolloutOperation()

Output only. Repairs a failed 'Rollout'.

.google.cloud.deploy.v1.RepairRolloutOperation repair_rollout_operation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RepairRolloutOperation

The repairRolloutOperation.

getRepairRolloutOperationOrBuilder()

public RepairRolloutOperationOrBuilder getRepairRolloutOperationOrBuilder()

Output only. Repairs a failed 'Rollout'.

.google.cloud.deploy.v1.RepairRolloutOperation repair_rollout_operation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RepairRolloutOperationOrBuilder

getRuleId()

public String getRuleId()

Output only. The ID of the automation rule that initiated the operation.

string rule_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The ruleId.

getRuleIdBytes()

public ByteString getRuleIdBytes()

Output only. The ID of the automation rule that initiated the operation.

string rule_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for ruleId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

string service_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

string service_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccount.

getState()

public AutomationRun.State getState()

Output only. Current state of the AutomationRun.

.google.cloud.deploy.v1.AutomationRun.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AutomationRun.State

The state.

getStateDescription()

public String getStateDescription()

Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

string state_description = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDescription.

getStateDescriptionBytes()

public ByteString getStateDescriptionBytes()

Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

string state_description = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDescription.

getStateValue()

public int getStateValue()

Output only. Current state of the AutomationRun.

.google.cloud.deploy.v1.AutomationRun.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTargetId()

public String getTargetId()

Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.

string target_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The targetId.

getTargetIdBytes()

public ByteString getTargetIdBytes()

Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.

string target_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for targetId.

getTimedPromoteReleaseOperation()

public TimedPromoteReleaseOperation getTimedPromoteReleaseOperation()

Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.

.google.cloud.deploy.v1.TimedPromoteReleaseOperation timed_promote_release_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimedPromoteReleaseOperation

The timedPromoteReleaseOperation.

getTimedPromoteReleaseOperationOrBuilder()

public TimedPromoteReleaseOperationOrBuilder getTimedPromoteReleaseOperationOrBuilder()

Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.

.google.cloud.deploy.v1.TimedPromoteReleaseOperation timed_promote_release_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimedPromoteReleaseOperationOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time at which the automationRun was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time at which the automationRun was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWaitUntilTime()

public Timestamp getWaitUntilTime()

Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

.google.protobuf.Timestamp wait_until_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The waitUntilTime.

getWaitUntilTimeOrBuilder()

public TimestampOrBuilder getWaitUntilTimeOrBuilder()

Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

.google.protobuf.Timestamp wait_until_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAdvanceRolloutOperation()

public boolean hasAdvanceRolloutOperation()

Output only. Advances a rollout to the next phase.

.google.cloud.deploy.v1.AdvanceRolloutOperation advance_rollout_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the advanceRolloutOperation field is set.

hasAutomationSnapshot()

public boolean hasAutomationSnapshot()

Output only. Snapshot of the Automation taken at AutomationRun creation time.

.google.cloud.deploy.v1.Automation automation_snapshot = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the automationSnapshot field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time at which the AutomationRun was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

.google.protobuf.Timestamp expire_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasPolicyViolation()

public boolean hasPolicyViolation()

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

.google.cloud.deploy.v1.PolicyViolation policy_violation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the policyViolation field is set.

hasPromoteReleaseOperation()

public boolean hasPromoteReleaseOperation()

Output only. Promotes a release to a specified 'Target'.

.google.cloud.deploy.v1.PromoteReleaseOperation promote_release_operation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the promoteReleaseOperation field is set.

hasRepairRolloutOperation()

public boolean hasRepairRolloutOperation()

Output only. Repairs a failed 'Rollout'.

.google.cloud.deploy.v1.RepairRolloutOperation repair_rollout_operation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the repairRolloutOperation field is set.

hasTimedPromoteReleaseOperation()

public boolean hasTimedPromoteReleaseOperation()

Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.

.google.cloud.deploy.v1.TimedPromoteReleaseOperation timed_promote_release_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the timedPromoteReleaseOperation field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time at which the automationRun was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasWaitUntilTime()

public boolean hasWaitUntilTime()

Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

.google.protobuf.Timestamp wait_until_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the waitUntilTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AutomationRun.Builder newBuilderForType()
Returns
Type Description
AutomationRun.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutomationRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AutomationRun.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AutomationRun.Builder toBuilder()
Returns
Type Description
AutomationRun.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException