Represents a JobRun.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.IJobRun);Constructs a new JobRun.
| Parameter | |
|---|---|
| Name | Description |
properties |
IJobRun
Properties to set |
Properties
advanceChildRolloutJobRun
public advanceChildRolloutJobRun?: (google.cloud.deploy.v1.IAdvanceChildRolloutJobRun|null);JobRun advanceChildRolloutJobRun.
createChildRolloutJobRun
public createChildRolloutJobRun?: (google.cloud.deploy.v1.ICreateChildRolloutJobRun|null);JobRun createChildRolloutJobRun.
createTime
public createTime?: (google.protobuf.ITimestamp|null);JobRun createTime.
deployJobRun
public deployJobRun?: (google.cloud.deploy.v1.IDeployJobRun|null);JobRun deployJobRun.
endTime
public endTime?: (google.protobuf.ITimestamp|null);JobRun endTime.
etag
public etag: string;JobRun etag.
jobId
public jobId: string;JobRun jobId.
jobRun
public jobRun?: ("deployJobRun"|"verifyJobRun"|"predeployJobRun"|"postdeployJobRun"|"createChildRolloutJobRun"|"advanceChildRolloutJobRun");JobRun jobRun.
name
public name: string;JobRun name.
phaseId
public phaseId: string;JobRun phaseId.
postdeployJobRun
public postdeployJobRun?: (google.cloud.deploy.v1.IPostdeployJobRun|null);JobRun postdeployJobRun.
predeployJobRun
public predeployJobRun?: (google.cloud.deploy.v1.IPredeployJobRun|null);JobRun predeployJobRun.
startTime
public startTime?: (google.protobuf.ITimestamp|null);JobRun startTime.
state
public state: (google.cloud.deploy.v1.JobRun.State|keyof typeof google.cloud.deploy.v1.JobRun.State);JobRun state.
uid
public uid: string;JobRun uid.
verifyJobRun
public verifyJobRun?: (google.cloud.deploy.v1.IVerifyJobRun|null);JobRun verifyJobRun.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.IJobRun): google.cloud.deploy.v1.JobRun;Creates a new JobRun instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IJobRun
Properties to set |
| Returns | |
|---|---|
| Type | Description |
JobRun |
JobRun instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.JobRun;Decodes a JobRun 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 |
JobRun |
JobRun |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.JobRun;Decodes a JobRun message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
JobRun |
JobRun |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.IJobRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified JobRun message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IJobRun
JobRun 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.IJobRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified JobRun message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IJobRun
JobRun 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.JobRun;Creates a JobRun 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 |
JobRun |
JobRun |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for JobRun
| 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 JobRun to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.JobRun, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a JobRun message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
JobRun
JobRun |
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 a JobRun message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|