Class protos.google.cloud.deploy.v1.Release (4.3.0)

Represents a Release.

Package

@google-cloud/deploy

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.deploy.v1.IRelease);

Constructs a new Release.

Parameter
Name Description
properties IRelease

Properties to set

Properties

abandoned

public abandoned: boolean;

Release abandoned.

annotations

public annotations: { [k: string]: string };

Release annotations.

buildArtifacts

public buildArtifacts: google.cloud.deploy.v1.IBuildArtifact[];

Release buildArtifacts.

condition

public condition?: (google.cloud.deploy.v1.Release.IReleaseCondition|null);

Release condition.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Release createTime.

customTargetTypeSnapshots

public customTargetTypeSnapshots: google.cloud.deploy.v1.ICustomTargetType[];

Release customTargetTypeSnapshots.

deliveryPipelineSnapshot

public deliveryPipelineSnapshot?: (google.cloud.deploy.v1.IDeliveryPipeline|null);

Release deliveryPipelineSnapshot.

deployParameters

public deployParameters: { [k: string]: string };

Release deployParameters.

description

public description: string;

Release description.

etag

public etag: string;

Release etag.

labels

public labels: { [k: string]: string };

Release labels.

name

public name: string;

Release name.

renderEndTime

public renderEndTime?: (google.protobuf.ITimestamp|null);

Release renderEndTime.

renderStartTime

public renderStartTime?: (google.protobuf.ITimestamp|null);

Release renderStartTime.

renderState

public renderState: (google.cloud.deploy.v1.Release.RenderState|keyof typeof google.cloud.deploy.v1.Release.RenderState);

Release renderState.

skaffoldConfigPath

public skaffoldConfigPath: string;

Release skaffoldConfigPath.

skaffoldConfigUri

public skaffoldConfigUri: string;

Release skaffoldConfigUri.

skaffoldVersion

public skaffoldVersion: string;

Release skaffoldVersion.

targetArtifacts

public targetArtifacts: { [k: string]: google.cloud.deploy.v1.ITargetArtifact };

Release targetArtifacts.

targetRenders

public targetRenders: { [k: string]: google.cloud.deploy.v1.Release.ITargetRender };

Release targetRenders.

targetSnapshots

public targetSnapshots: google.cloud.deploy.v1.ITarget[];

Release targetSnapshots.

uid

public uid: string;

Release uid.

Methods

create(properties)

public static create(properties?: google.cloud.deploy.v1.IRelease): google.cloud.deploy.v1.Release;

Creates a new Release instance using the specified properties.

Parameter
Name Description
properties IRelease

Properties to set

Returns
Type Description
Release

Release instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.Release;

Decodes a Release 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
Release

Release

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.Release;

Decodes a Release message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Release

Release

encode(message, writer)

public static encode(message: google.cloud.deploy.v1.IRelease, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Release message. Does not implicitly messages.

Parameters
Name Description
message IRelease

Release 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.IRelease, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Release message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IRelease

Release 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.Release;

Creates a Release 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
Release

Release

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Release

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 Release to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.deploy.v1.Release, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Release message. Also converts values to other types if specified.

Parameters
Name Description
message Release

Release

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 Release message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not