Class protos.google.cloud.redis.v1.FailoverInstanceRequest (2.2.6)

Represents a FailoverInstanceRequest.

Package

@google-cloud/redis!

Constructors

(constructor)(properties)

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

Constructs a new FailoverInstanceRequest.

Parameter

Name	Description
properties	`google.cloud.redis.v1.IFailoverInstanceRequest` Properties to set

Properties

dataProtectionMode

public dataProtectionMode: (google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode|keyof typeof google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode);

FailoverInstanceRequest dataProtectionMode.

Property Value

Type	Description
(google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode\|keyof typeof google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode)

name

public name: string;

FailoverInstanceRequest name.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.redis.v1.IFailoverInstanceRequest): google.cloud.redis.v1.FailoverInstanceRequest;

Creates a new FailoverInstanceRequest instance using the specified properties.

Parameter

Name	Description
properties	`google.cloud.redis.v1.IFailoverInstanceRequest` Properties to set

Returns

Type	Description
google.cloud.redis.v1.FailoverInstanceRequest	FailoverInstanceRequest instance

decode(reader, length)

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

Decodes a FailoverInstanceRequest 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.redis.v1.FailoverInstanceRequest	FailoverInstanceRequest

decodeDelimited(reader)

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

Decodes a FailoverInstanceRequest 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.redis.v1.FailoverInstanceRequest	FailoverInstanceRequest

encode(message, writer)

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

Encodes the specified FailoverInstanceRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`google.cloud.redis.v1.IFailoverInstanceRequest` FailoverInstanceRequest 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.v1.IFailoverInstanceRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.cloud.redis.v1.IFailoverInstanceRequest` FailoverInstanceRequest 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.v1.FailoverInstanceRequest;

Creates a FailoverInstanceRequest 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.redis.v1.FailoverInstanceRequest	FailoverInstanceRequest

toJSON()

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

Converts this FailoverInstanceRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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