Class protos.google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest (0.11.0)

Represents a SqlInstancesVerifyExternalSyncSettingsRequest.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new SqlInstancesVerifyExternalSyncSettingsRequest.

Parameter
Name Description
properties ISqlInstancesVerifyExternalSyncSettingsRequest

Properties to set

Properties

instance

public instance: string;

SqlInstancesVerifyExternalSyncSettingsRequest instance.

migrationType

public migrationType: (google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType|keyof typeof google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest.MigrationType);

SqlInstancesVerifyExternalSyncSettingsRequest migrationType.

mysqlSyncConfig

public mysqlSyncConfig?: (google.cloud.sql.v1.IMySqlSyncConfig|null);

SqlInstancesVerifyExternalSyncSettingsRequest mysqlSyncConfig.

project

public project: string;

SqlInstancesVerifyExternalSyncSettingsRequest project.

syncConfig

public syncConfig?: "mysqlSyncConfig";

SqlInstancesVerifyExternalSyncSettingsRequest syncConfig.

syncMode

public syncMode: (google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode|keyof typeof google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest.ExternalSyncMode);

SqlInstancesVerifyExternalSyncSettingsRequest syncMode.

syncParallelLevel

public syncParallelLevel: (google.cloud.sql.v1.ExternalSyncParallelLevel|keyof typeof google.cloud.sql.v1.ExternalSyncParallelLevel);

SqlInstancesVerifyExternalSyncSettingsRequest syncParallelLevel.

verifyConnectionOnly

public verifyConnectionOnly: boolean;

SqlInstancesVerifyExternalSyncSettingsRequest verifyConnectionOnly.

verifyReplicationOnly

public verifyReplicationOnly: boolean;

SqlInstancesVerifyExternalSyncSettingsRequest verifyReplicationOnly.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.ISqlInstancesVerifyExternalSyncSettingsRequest): google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsRequest;

Creates a new SqlInstancesVerifyExternalSyncSettingsRequest instance using the specified properties.

Parameter
Name Description
properties ISqlInstancesVerifyExternalSyncSettingsRequest

Properties to set

Returns
Type Description
SqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest instance

decode(reader, length)

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

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

SqlInstancesVerifyExternalSyncSettingsRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest

encode(message, writer)

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

Encodes the specified SqlInstancesVerifyExternalSyncSettingsRequest message. Does not implicitly messages.

Parameters
Name Description
message ISqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest 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.ISqlInstancesVerifyExternalSyncSettingsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest 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.SqlInstancesVerifyExternalSyncSettingsRequest;

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

SqlInstancesVerifyExternalSyncSettingsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlInstancesVerifyExternalSyncSettingsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest

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