Class protos.google.cloud.datastream.v1.MysqlSourceConfig (3.1.0)

Represents a MysqlSourceConfig.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1.IMysqlSourceConfig);

Constructs a new MysqlSourceConfig.

Parameter
NameDescription
properties IMysqlSourceConfig

Properties to set

Properties

excludeObjects

public excludeObjects?: (google.cloud.datastream.v1.IMysqlRdbms|null);

MysqlSourceConfig excludeObjects.

includeObjects

public includeObjects?: (google.cloud.datastream.v1.IMysqlRdbms|null);

MysqlSourceConfig includeObjects.

maxConcurrentBackfillTasks

public maxConcurrentBackfillTasks: number;

MysqlSourceConfig maxConcurrentBackfillTasks.

maxConcurrentCdcTasks

public maxConcurrentCdcTasks: number;

MysqlSourceConfig maxConcurrentCdcTasks.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.IMysqlSourceConfig): google.cloud.datastream.v1.MysqlSourceConfig;

Creates a new MysqlSourceConfig instance using the specified properties.

Parameter
NameDescription
properties IMysqlSourceConfig

Properties to set

Returns
TypeDescription
MysqlSourceConfig

MysqlSourceConfig instance

decode(reader, length)

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

Decodes a MysqlSourceConfig message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
MysqlSourceConfig

MysqlSourceConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
MysqlSourceConfig

MysqlSourceConfig

encode(message, writer)

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

Encodes the specified MysqlSourceConfig message. Does not implicitly messages.

Parameters
NameDescription
message IMysqlSourceConfig

MysqlSourceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datastream.v1.IMysqlSourceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMysqlSourceConfig

MysqlSourceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datastream.v1.MysqlSourceConfig;

Creates a MysqlSourceConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
MysqlSourceConfig

MysqlSourceConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MysqlSourceConfig

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this MysqlSourceConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message MysqlSourceConfig

MysqlSourceConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MysqlSourceConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not