Class protos.google.cloud.sql.v1beta4.SqlInstancesStartExternalSyncRequest (0.11.0)

Represents a SqlInstancesStartExternalSyncRequest.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1beta4.ISqlInstancesStartExternalSyncRequest);

Constructs a new SqlInstancesStartExternalSyncRequest.

Parameter
Name Description
properties ISqlInstancesStartExternalSyncRequest

Properties to set

Properties

instance

public instance: string;

SqlInstancesStartExternalSyncRequest instance.

migrationType

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

SqlInstancesStartExternalSyncRequest migrationType.

mysqlSyncConfig

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

SqlInstancesStartExternalSyncRequest mysqlSyncConfig.

project

public project: string;

SqlInstancesStartExternalSyncRequest project.

skipVerification

public skipVerification: boolean;

SqlInstancesStartExternalSyncRequest skipVerification.

syncConfig

public syncConfig?: "mysqlSyncConfig";

SqlInstancesStartExternalSyncRequest syncConfig.

syncMode

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

SqlInstancesStartExternalSyncRequest syncMode.

syncParallelLevel

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

SqlInstancesStartExternalSyncRequest syncParallelLevel.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1beta4.ISqlInstancesStartExternalSyncRequest): google.cloud.sql.v1beta4.SqlInstancesStartExternalSyncRequest;

Creates a new SqlInstancesStartExternalSyncRequest instance using the specified properties.

Parameter
Name Description
properties ISqlInstancesStartExternalSyncRequest

Properties to set
Returns
Type Description
SqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest instance

decode(reader, length)

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

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

SqlInstancesStartExternalSyncRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
SqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest

encode(message, writer)

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

Encodes the specified SqlInstancesStartExternalSyncRequest message. Does not implicitly messages.

Parameters
Name Description
message ISqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest 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.v1beta4.ISqlInstancesStartExternalSyncRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest 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.v1beta4.SqlInstancesStartExternalSyncRequest;

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

SqlInstancesStartExternalSyncRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlInstancesStartExternalSyncRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SqlInstancesStartExternalSyncRequest

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