Class protos.google.container.v1.SetLocationsRequest (5.5.0)

Represents a SetLocationsRequest.

Package

@google-cloud/container

Constructors

(constructor)(properties)

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

Constructs a new SetLocationsRequest.

Parameter
NameDescription
properties ISetLocationsRequest

Properties to set

Properties

clusterId

public clusterId: string;

SetLocationsRequest clusterId.

locations

public locations: string[];

SetLocationsRequest locations.

name

public name: string;

SetLocationsRequest name.

projectId

public projectId: string;

SetLocationsRequest projectId.

zone

public zone: string;

SetLocationsRequest zone.

Methods

create(properties)

public static create(properties?: google.container.v1.ISetLocationsRequest): google.container.v1.SetLocationsRequest;

Creates a new SetLocationsRequest instance using the specified properties.

Parameter
NameDescription
properties ISetLocationsRequest

Properties to set

Returns
TypeDescription
SetLocationsRequest

SetLocationsRequest instance

decode(reader, length)

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

Decodes a SetLocationsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SetLocationsRequest

SetLocationsRequest

decodeDelimited(reader)

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

Decodes a SetLocationsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SetLocationsRequest

SetLocationsRequest

encode(message, writer)

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

Encodes the specified SetLocationsRequest message. Does not implicitly messages.

Parameters
NameDescription
message ISetLocationsRequest

SetLocationsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message ISetLocationsRequest

SetLocationsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.container.v1.SetLocationsRequest;

Creates a SetLocationsRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SetLocationsRequest

SetLocationsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SetLocationsRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this SetLocationsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SetLocationsRequest

SetLocationsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SetLocationsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not