Class protos.google.cloud.dataproc.v1.UpdateClusterRequest (3.1.0)

Represents an UpdateClusterRequest.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataproc.v1.IUpdateClusterRequest);

Constructs a new UpdateClusterRequest.

Parameter

Name	Description
properties	`IUpdateClusterRequest` Properties to set

Properties

cluster

public cluster?: (google.cloud.dataproc.v1.ICluster|null);

UpdateClusterRequest cluster.

Property Value

Type	Description
(google.cloud.dataproc.v1.ICluster\|null)

clusterName

public clusterName: string;

UpdateClusterRequest clusterName.

Property Value

Type	Description
string

gracefulDecommissionTimeout

public gracefulDecommissionTimeout?: (google.protobuf.IDuration|null);

UpdateClusterRequest gracefulDecommissionTimeout.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

projectId

public projectId: string;

UpdateClusterRequest projectId.

Property Value

Type	Description
string

region

public region: string;

UpdateClusterRequest region.

Property Value

Type	Description
string

requestId

public requestId: string;

UpdateClusterRequest requestId.

Property Value

Type	Description
string

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateClusterRequest updateMask.

Property Value

Type	Description
(google.protobuf.IFieldMask\|null)

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IUpdateClusterRequest): google.cloud.dataproc.v1.UpdateClusterRequest;

Creates a new UpdateClusterRequest instance using the specified properties.

Parameter

Name	Description
properties	`IUpdateClusterRequest` Properties to set

Returns

Type	Description
google.cloud.dataproc.v1.UpdateClusterRequest	UpdateClusterRequest instance

decode(reader, length)

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

Decodes an UpdateClusterRequest 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.dataproc.v1.UpdateClusterRequest	UpdateClusterRequest

decodeDelimited(reader)

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

Decodes an UpdateClusterRequest 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.dataproc.v1.UpdateClusterRequest	UpdateClusterRequest

encode(message, writer)

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

Encodes the specified UpdateClusterRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IUpdateClusterRequest` UpdateClusterRequest 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.dataproc.v1.IUpdateClusterRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IUpdateClusterRequest` UpdateClusterRequest 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.dataproc.v1.UpdateClusterRequest;

Creates an UpdateClusterRequest 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.dataproc.v1.UpdateClusterRequest	UpdateClusterRequest

toJSON()

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

Converts this UpdateClusterRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dataproc.v1.UpdateClusterRequest` UpdateClusterRequest
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 UpdateClusterRequest 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