Class protos.google.cloud.sql.v1.SqlInstancesPromoteReplicaRequest (0.19.0)

Represents a SqlInstancesPromoteReplicaRequest.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1.ISqlInstancesPromoteReplicaRequest);

Constructs a new SqlInstancesPromoteReplicaRequest.

Parameter
Name Description
properties ISqlInstancesPromoteReplicaRequest

Properties to set

Properties

failover

public failover: boolean;

SqlInstancesPromoteReplicaRequest failover.

instance

public instance: string;

SqlInstancesPromoteReplicaRequest instance.

project

public project: string;

SqlInstancesPromoteReplicaRequest project.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.ISqlInstancesPromoteReplicaRequest): google.cloud.sql.v1.SqlInstancesPromoteReplicaRequest;

Creates a new SqlInstancesPromoteReplicaRequest instance using the specified properties.

Parameter
Name Description
properties ISqlInstancesPromoteReplicaRequest

Properties to set

Returns
Type Description
SqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest instance

decode(reader, length)

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

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

SqlInstancesPromoteReplicaRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest

encode(message, writer)

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

Encodes the specified SqlInstancesPromoteReplicaRequest message. Does not implicitly messages.

Parameters
Name Description
message ISqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest 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.sql.v1.ISqlInstancesPromoteReplicaRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest 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.sql.v1.SqlInstancesPromoteReplicaRequest;

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

SqlInstancesPromoteReplicaRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlInstancesPromoteReplicaRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest

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