Class protos.google.container.v1.SetMaintenancePolicyRequest (2.3.2)

Represents a SetMaintenancePolicyRequest.

Package

@google-cloud/container!

Constructors

(constructor)(properties)

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

Constructs a new SetMaintenancePolicyRequest.

Parameter

Name	Description
properties	`google.container.v1.ISetMaintenancePolicyRequest` Properties to set

Properties

clusterId

public clusterId: string;

SetMaintenancePolicyRequest clusterId.

Property Value

Type	Description
string

maintenancePolicy

public maintenancePolicy?: (google.container.v1.IMaintenancePolicy|null);

SetMaintenancePolicyRequest maintenancePolicy.

Property Value

Type	Description
(google.container.v1.IMaintenancePolicy\|null)

name

public name: string;

SetMaintenancePolicyRequest name.

Property Value

Type	Description
string

projectId

public projectId: string;

SetMaintenancePolicyRequest projectId.

Property Value

Type	Description
string

zone

public zone: string;

SetMaintenancePolicyRequest zone.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.container.v1.ISetMaintenancePolicyRequest): google.container.v1.SetMaintenancePolicyRequest;

Creates a new SetMaintenancePolicyRequest instance using the specified properties.

Parameter

Name	Description
properties	`google.container.v1.ISetMaintenancePolicyRequest` Properties to set

Returns

Type	Description
google.container.v1.SetMaintenancePolicyRequest	SetMaintenancePolicyRequest instance

decode(reader, length)

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

Decodes a SetMaintenancePolicyRequest 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.container.v1.SetMaintenancePolicyRequest	SetMaintenancePolicyRequest

decodeDelimited(reader)

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

Decodes a SetMaintenancePolicyRequest 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.container.v1.SetMaintenancePolicyRequest	SetMaintenancePolicyRequest

encode(message, writer)

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

Encodes the specified SetMaintenancePolicyRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`google.container.v1.ISetMaintenancePolicyRequest` SetMaintenancePolicyRequest 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.container.v1.ISetMaintenancePolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.container.v1.ISetMaintenancePolicyRequest` SetMaintenancePolicyRequest 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.container.v1.SetMaintenancePolicyRequest;

Creates a SetMaintenancePolicyRequest 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.container.v1.SetMaintenancePolicyRequest	SetMaintenancePolicyRequest

toJSON()

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

Converts this SetMaintenancePolicyRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.container.v1.SetMaintenancePolicyRequest` SetMaintenancePolicyRequest
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 SetMaintenancePolicyRequest 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