Class protos.google.devtools.cloudbuild.v1.CancelBuildRequest (2.3.2)

Version 2.3.2

• 4.1.1 (latest)
• 4.0.0
• 3.6.0
• 3.3.0
• 3.2.0
• 3.1.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.2
• 2.2.7

Represents a CancelBuildRequest.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.ICancelBuildRequest);

Constructs a new CancelBuildRequest.

Parameter

Name	Description
properties	ICancelBuildRequest Properties to set

Properties

id

public id: string;

CancelBuildRequest id.

Property Value

Type	Description
string

name

public name: string;

CancelBuildRequest name.

Property Value

Type	Description
string

projectId

public projectId: string;

CancelBuildRequest projectId.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.ICancelBuildRequest): google.devtools.cloudbuild.v1.CancelBuildRequest;

Creates a new CancelBuildRequest instance using the specified properties.

Parameter

Name	Description
properties	ICancelBuildRequest Properties to set

Returns

Type	Description
google.devtools.cloudbuild.v1.CancelBuildRequest	CancelBuildRequest instance

decode(reader, length)

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

Decodes a CancelBuildRequest 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.devtools.cloudbuild.v1.CancelBuildRequest	CancelBuildRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.CancelBuildRequest;

Decodes a CancelBuildRequest 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.devtools.cloudbuild.v1.CancelBuildRequest	CancelBuildRequest

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.ICancelBuildRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CancelBuildRequest message. Does not implicitly messages.

Parameters

Name	Description
message	ICancelBuildRequest CancelBuildRequest 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.devtools.cloudbuild.v1.ICancelBuildRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	ICancelBuildRequest CancelBuildRequest 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.devtools.cloudbuild.v1.CancelBuildRequest;

Creates a CancelBuildRequest 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.devtools.cloudbuild.v1.CancelBuildRequest	CancelBuildRequest

toJSON()

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

Converts this CancelBuildRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.devtools.cloudbuild.v1.CancelBuildRequest CancelBuildRequest
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 CancelBuildRequest 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