Class protos.google.cloud.osconfig.v1.CancelPatchJobRequest (1.8.0)

Version 1.8.0

• 2.2.2 (latest)
• 2.2.1
• 2.1.2
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.6

Represents a CancelPatchJobRequest.

Package

@google-cloud/os-config!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1.ICancelPatchJobRequest);

Constructs a new CancelPatchJobRequest.

Parameter

Name	Description
properties	ICancelPatchJobRequest Properties to set

Properties

name

public name: string;

CancelPatchJobRequest name.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.ICancelPatchJobRequest): google.cloud.osconfig.v1.CancelPatchJobRequest;

Creates a new CancelPatchJobRequest instance using the specified properties.

Parameter

Name	Description
properties	ICancelPatchJobRequest Properties to set

Returns

Type	Description
google.cloud.osconfig.v1.CancelPatchJobRequest	CancelPatchJobRequest instance

decode(reader, length)

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

Decodes a CancelPatchJobRequest 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.osconfig.v1.CancelPatchJobRequest	CancelPatchJobRequest

decodeDelimited(reader)

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

Decodes a CancelPatchJobRequest 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.osconfig.v1.CancelPatchJobRequest	CancelPatchJobRequest

encode(message, writer)

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

Encodes the specified CancelPatchJobRequest message. Does not implicitly messages.

Parameters

Name	Description
message	ICancelPatchJobRequest CancelPatchJobRequest 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.osconfig.v1.ICancelPatchJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	ICancelPatchJobRequest CancelPatchJobRequest 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.osconfig.v1.CancelPatchJobRequest;

Creates a CancelPatchJobRequest 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.osconfig.v1.CancelPatchJobRequest	CancelPatchJobRequest

toJSON()

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

Converts this CancelPatchJobRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.osconfig.v1.CancelPatchJobRequest CancelPatchJobRequest
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 CancelPatchJobRequest 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