Class protos.grafeas.v1.Command (3.2.0)

Represents a Command.

Package

@google-cloud/containeranalysis

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.ICommand);

Constructs a new Command.

Parameter
Name Description
properties ICommand

Properties to set

Properties

args

public args: string[];

Command args.

Property Value
Type Description
string[]

dir

public dir: string;

Command dir.

Property Value
Type Description
string

env

public env: string[];

Command env.

Property Value
Type Description
string[]

id

public id: string;

Command id.

Property Value
Type Description
string

name

public name: string;

Command name.

Property Value
Type Description
string

waitFor

public waitFor: string[];

Command waitFor.

Property Value
Type Description
string[]

Methods

create(properties)

public static create(properties?: grafeas.v1.ICommand): grafeas.v1.Command;

Creates a new Command instance using the specified properties.

Parameter
Name Description
properties ICommand

Properties to set
Returns
Type Description
grafeas.v1.Command

Command instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.Command;

Decodes a Command 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
grafeas.v1.Command

Command

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.Command;

Decodes a Command 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
grafeas.v1.Command

Command

encode(message, writer)

public static encode(message: grafeas.v1.ICommand, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Command message. Does not implicitly messages.

Parameters
Name Description
message ICommand

Command 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: grafeas.v1.ICommand, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICommand

Command 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 }): grafeas.v1.Command;

Creates a Command 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
grafeas.v1.Command

Command

toJSON()

public toJSON(): { [k: string]: any };

Converts this Command to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.Command, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message grafeas.v1.Command

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