Class protos.google.cloud.compute.v1.UpdateRegionCommitmentRequest (4.5.0)

Represents an UpdateRegionCommitmentRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IUpdateRegionCommitmentRequest);

Constructs a new UpdateRegionCommitmentRequest.

Parameter
Name Description
properties IUpdateRegionCommitmentRequest

Properties to set

Properties

_paths

public _paths?: "paths";

UpdateRegionCommitmentRequest _paths.

_requestId

public _requestId?: "requestId";

UpdateRegionCommitmentRequest _requestId.

_updateMask

public _updateMask?: "updateMask";

UpdateRegionCommitmentRequest _updateMask.

commitment

public commitment: string;

UpdateRegionCommitmentRequest commitment.

commitmentResource

public commitmentResource?: (google.cloud.compute.v1.ICommitment|null);

UpdateRegionCommitmentRequest commitmentResource.

paths

public paths?: (string|null);

UpdateRegionCommitmentRequest paths.

project

public project: string;

UpdateRegionCommitmentRequest project.

region

public region: string;

UpdateRegionCommitmentRequest region.

requestId

public requestId?: (string|null);

UpdateRegionCommitmentRequest requestId.

updateMask

public updateMask?: (string|null);

UpdateRegionCommitmentRequest updateMask.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IUpdateRegionCommitmentRequest): google.cloud.compute.v1.UpdateRegionCommitmentRequest;

Creates a new UpdateRegionCommitmentRequest instance using the specified properties.

Parameter
Name Description
properties IUpdateRegionCommitmentRequest

Properties to set

Returns
Type Description
UpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest instance

decode(reader, length)

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

Decodes an UpdateRegionCommitmentRequest 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
UpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest

encode(message, writer)

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

Encodes the specified UpdateRegionCommitmentRequest message. Does not implicitly messages.

Parameters
Name Description
message IUpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest 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.compute.v1.IUpdateRegionCommitmentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IUpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest 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.compute.v1.UpdateRegionCommitmentRequest;

Creates an UpdateRegionCommitmentRequest 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
UpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UpdateRegionCommitmentRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message UpdateRegionCommitmentRequest

UpdateRegionCommitmentRequest

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 an UpdateRegionCommitmentRequest 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