Class protos.google.container.v1.Operation (4.2.0)

Represents an Operation.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1.IOperation);

Constructs a new Operation.

Parameter
NameDescription
properties IOperation

Properties to set

Properties

clusterConditions

public clusterConditions: google.container.v1.IStatusCondition[];

Operation clusterConditions.

detail

public detail: string;

Operation detail.

endTime

public endTime: string;

Operation endTime.

error

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

Operation error.

location

public location: string;

Operation location.

name

public name: string;

Operation name.

nodepoolConditions

public nodepoolConditions: google.container.v1.IStatusCondition[];

Operation nodepoolConditions.

operationType

public operationType: (google.container.v1.Operation.Type|keyof typeof google.container.v1.Operation.Type);

Operation operationType.

progress

public progress?: (google.container.v1.IOperationProgress|null);

Operation progress.

public selfLink: string;

Operation selfLink.

startTime

public startTime: string;

Operation startTime.

status

public status: (google.container.v1.Operation.Status|keyof typeof google.container.v1.Operation.Status);

Operation status.

statusMessage

public statusMessage: string;

Operation statusMessage.

public targetLink: string;

Operation targetLink.

zone

public zone: string;

Operation zone.

Methods

create(properties)

public static create(properties?: google.container.v1.IOperation): google.container.v1.Operation;

Creates a new Operation instance using the specified properties.

Parameter
NameDescription
properties IOperation

Properties to set

Returns
TypeDescription
google.container.v1.Operation

Operation instance

decode(reader, length)

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

Decodes an Operation message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.container.v1.Operation

Operation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.Operation;

Decodes an Operation message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.container.v1.Operation

Operation

encode(message, writer)

public static encode(message: google.container.v1.IOperation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Operation message. Does not implicitly messages.

Parameters
NameDescription
message IOperation

Operation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.container.v1.IOperation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IOperation

Operation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.container.v1.Operation;

Creates an Operation message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.container.v1.Operation

Operation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Operation

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Operation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.container.v1.Operation

Operation

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Operation message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not