Class protos.google.cloud.config.v1.DeploymentUnitProgress (0.12.0)

Represents a DeploymentUnitProgress.

Package

@google-cloud/config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.config.v1.IDeploymentUnitProgress);

Constructs a new DeploymentUnitProgress.

Parameter
Name Description
properties IDeploymentUnitProgress

Properties to set

Properties

deployment

public deployment: string;

DeploymentUnitProgress deployment.

deploymentOperationSummary

public deploymentOperationSummary?: (google.cloud.config.v1.IDeploymentOperationSummary|null);

DeploymentUnitProgress deploymentOperationSummary.

error

public error?: (google.rpc.IStatus|null);

DeploymentUnitProgress error.

intent

public intent: (google.cloud.config.v1.DeploymentUnitProgress.Intent|keyof typeof google.cloud.config.v1.DeploymentUnitProgress.Intent);

DeploymentUnitProgress intent.

state

public state: (google.cloud.config.v1.DeploymentUnitProgress.State|keyof typeof google.cloud.config.v1.DeploymentUnitProgress.State);

DeploymentUnitProgress state.

stateDescription

public stateDescription: string;

DeploymentUnitProgress stateDescription.

unitId

public unitId: string;

DeploymentUnitProgress unitId.

Methods

create(properties)

public static create(properties?: google.cloud.config.v1.IDeploymentUnitProgress): google.cloud.config.v1.DeploymentUnitProgress;

Creates a new DeploymentUnitProgress instance using the specified properties.

Parameter
Name Description
properties IDeploymentUnitProgress

Properties to set

Returns
Type Description
DeploymentUnitProgress

DeploymentUnitProgress instance

decode(reader, length)

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

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

DeploymentUnitProgress

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DeploymentUnitProgress

DeploymentUnitProgress

encode(message, writer)

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

Encodes the specified DeploymentUnitProgress message. Does not implicitly messages.

Parameters
Name Description
message IDeploymentUnitProgress

DeploymentUnitProgress 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.config.v1.IDeploymentUnitProgress, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDeploymentUnitProgress

DeploymentUnitProgress 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.config.v1.DeploymentUnitProgress;

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

DeploymentUnitProgress

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DeploymentUnitProgress

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DeploymentUnitProgress

DeploymentUnitProgress

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 DeploymentUnitProgress 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