Represents a Rollout.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.IRollout);
Constructs a new Rollout.
Name | Description |
properties |
IRollout
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };
Rollout annotations.
approvalState
public approvalState: (google.cloud.deploy.v1.Rollout.ApprovalState|keyof typeof google.cloud.deploy.v1.Rollout.ApprovalState);
Rollout approvalState.
approveTime
public approveTime?: (google.protobuf.ITimestamp|null);
Rollout approveTime.
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Rollout createTime.
deployEndTime
public deployEndTime?: (google.protobuf.ITimestamp|null);
Rollout deployEndTime.
deployingBuild
public deployingBuild: string;
Rollout deployingBuild.
deployStartTime
public deployStartTime?: (google.protobuf.ITimestamp|null);
Rollout deployStartTime.
description
public description: string;
Rollout description.
enqueueTime
public enqueueTime?: (google.protobuf.ITimestamp|null);
Rollout enqueueTime.
etag
public etag: string;
Rollout etag.
failureReason
public failureReason: string;
Rollout failureReason.
labels
public labels: { [k: string]: string };
Rollout labels.
name
public name: string;
Rollout name.
state
public state: (google.cloud.deploy.v1.Rollout.State|keyof typeof google.cloud.deploy.v1.Rollout.State);
Rollout state.
targetId
public targetId: string;
Rollout targetId.
uid
public uid: string;
Rollout uid.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.IRollout): google.cloud.deploy.v1.Rollout;
Creates a new Rollout instance using the specified properties.
Name | Description |
properties |
IRollout
Properties to set |
Type | Description |
google.cloud.deploy.v1.Rollout | Rollout instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.Rollout;
Decodes a Rollout message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.deploy.v1.Rollout | Rollout |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.Rollout;
Decodes a Rollout message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.deploy.v1.Rollout | Rollout |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.IRollout, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Rollout message. Does not implicitly messages.
Name | Description |
message |
IRollout
Rollout message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.deploy.v1.IRollout, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Rollout message, length delimited. Does not implicitly messages.
Name | Description |
message |
IRollout
Rollout message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.deploy.v1.Rollout;
Creates a Rollout message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.deploy.v1.Rollout | Rollout |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Rollout to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.Rollout, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Rollout message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.deploy.v1.Rollout
Rollout |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Rollout message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|