Class protos.google.cloud.redis.cluster.v1.CreateClusterRequest (0.5.0)

Represents a CreateClusterRequest.

Package

@google-cloud/redis-cluster

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.redis.cluster.v1.ICreateClusterRequest);

Constructs a new CreateClusterRequest.

Parameter
Name Description
properties ICreateClusterRequest

Properties to set

Properties

cluster

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

CreateClusterRequest cluster.

clusterId

public clusterId: string;

CreateClusterRequest clusterId.

parent

public parent: string;

CreateClusterRequest parent.

requestId

public requestId: string;

CreateClusterRequest requestId.

Methods

create(properties)

public static create(properties?: google.cloud.redis.cluster.v1.ICreateClusterRequest): google.cloud.redis.cluster.v1.CreateClusterRequest;

Creates a new CreateClusterRequest instance using the specified properties.

Parameter
Name Description
properties ICreateClusterRequest

Properties to set

Returns
Type Description
CreateClusterRequest

CreateClusterRequest instance

decode(reader, length)

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

Decodes a CreateClusterRequest 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
CreateClusterRequest

CreateClusterRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.redis.cluster.v1.CreateClusterRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CreateClusterRequest

CreateClusterRequest

encode(message, writer)

public static encode(message: google.cloud.redis.cluster.v1.ICreateClusterRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateClusterRequest message. Does not implicitly messages.

Parameters
Name Description
message ICreateClusterRequest

CreateClusterRequest 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.redis.cluster.v1.ICreateClusterRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICreateClusterRequest

CreateClusterRequest 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.redis.cluster.v1.CreateClusterRequest;

Creates a CreateClusterRequest 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
CreateClusterRequest

CreateClusterRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreateClusterRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CreateClusterRequest

CreateClusterRequest

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 CreateClusterRequest 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