Represents an AutomationRun.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.IAutomationRun);Constructs a new AutomationRun.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAutomationRun
Properties to set |
Properties
advanceRolloutOperation
public advanceRolloutOperation?: (google.cloud.deploy.v1.IAdvanceRolloutOperation|null);AutomationRun advanceRolloutOperation.
automationId
public automationId: string;AutomationRun automationId.
automationSnapshot
public automationSnapshot?: (google.cloud.deploy.v1.IAutomation|null);AutomationRun automationSnapshot.
createTime
public createTime?: (google.protobuf.ITimestamp|null);AutomationRun createTime.
etag
public etag: string;AutomationRun etag.
expireTime
public expireTime?: (google.protobuf.ITimestamp|null);AutomationRun expireTime.
name
public name: string;AutomationRun name.
operation
public operation?: ("promoteReleaseOperation"|"advanceRolloutOperation"|"repairRolloutOperation");AutomationRun operation.
promoteReleaseOperation
public promoteReleaseOperation?: (google.cloud.deploy.v1.IPromoteReleaseOperation|null);AutomationRun promoteReleaseOperation.
repairRolloutOperation
public repairRolloutOperation?: (google.cloud.deploy.v1.IRepairRolloutOperation|null);AutomationRun repairRolloutOperation.
ruleId
public ruleId: string;AutomationRun ruleId.
serviceAccount
public serviceAccount: string;AutomationRun serviceAccount.
state
public state: (google.cloud.deploy.v1.AutomationRun.State|keyof typeof google.cloud.deploy.v1.AutomationRun.State);AutomationRun state.
stateDescription
public stateDescription: string;AutomationRun stateDescription.
targetId
public targetId: string;AutomationRun targetId.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);AutomationRun updateTime.
waitUntilTime
public waitUntilTime?: (google.protobuf.ITimestamp|null);AutomationRun waitUntilTime.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.IAutomationRun): google.cloud.deploy.v1.AutomationRun;Creates a new AutomationRun instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAutomationRun
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AutomationRun | AutomationRun instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.AutomationRun;Decodes an AutomationRun message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AutomationRun | AutomationRun |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.AutomationRun;Decodes an AutomationRun message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AutomationRun | AutomationRun |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.IAutomationRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AutomationRun message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAutomationRun
AutomationRun message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.deploy.v1.IAutomationRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AutomationRun message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAutomationRun
AutomationRun message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.deploy.v1.AutomationRun;Creates an AutomationRun message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
AutomationRun | AutomationRun |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AutomationRun
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AutomationRun to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.AutomationRun, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AutomationRun message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AutomationRun
AutomationRun |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AutomationRun message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|