Represents a DeliveryPipeline.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.IDeliveryPipeline);Constructs a new DeliveryPipeline.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDeliveryPipeline
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };DeliveryPipeline annotations.
condition
public condition?: (google.cloud.deploy.v1.IPipelineCondition|null);DeliveryPipeline condition.
createTime
public createTime?: (google.protobuf.ITimestamp|null);DeliveryPipeline createTime.
description
public description: string;DeliveryPipeline description.
etag
public etag: string;DeliveryPipeline etag.
labels
public labels: { [k: string]: string };DeliveryPipeline labels.
name
public name: string;DeliveryPipeline name.
pipeline
public pipeline?: "serialPipeline";DeliveryPipeline pipeline.
serialPipeline
public serialPipeline?: (google.cloud.deploy.v1.ISerialPipeline|null);DeliveryPipeline serialPipeline.
suspended
public suspended: boolean;DeliveryPipeline suspended.
uid
public uid: string;DeliveryPipeline uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);DeliveryPipeline updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.IDeliveryPipeline): google.cloud.deploy.v1.DeliveryPipeline;Creates a new DeliveryPipeline instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDeliveryPipeline
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.deploy.v1.DeliveryPipeline | DeliveryPipeline instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.DeliveryPipeline;Decodes a DeliveryPipeline message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.deploy.v1.DeliveryPipeline | DeliveryPipeline |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.DeliveryPipeline;Decodes a DeliveryPipeline message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.deploy.v1.DeliveryPipeline | DeliveryPipeline |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.IDeliveryPipeline, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DeliveryPipeline message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDeliveryPipeline
DeliveryPipeline 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.IDeliveryPipeline, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DeliveryPipeline message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDeliveryPipeline
DeliveryPipeline 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.DeliveryPipeline;Creates a DeliveryPipeline 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 |
google.cloud.deploy.v1.DeliveryPipeline | DeliveryPipeline |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DeliveryPipeline
| 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 DeliveryPipeline to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.DeliveryPipeline, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DeliveryPipeline message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.deploy.v1.DeliveryPipeline
DeliveryPipeline |
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 DeliveryPipeline message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|