Class protos.google.cloud.datastream.v1.SqlServerSourceConfig (3.3.0)

Represents a SqlServerSourceConfig.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

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

Constructs a new SqlServerSourceConfig.

Parameter
Name Description
properties ISqlServerSourceConfig

Properties to set

Properties

cdcMethod

public cdcMethod?: ("transactionLogs"|"changeTables");

SqlServerSourceConfig cdcMethod.

changeTables

public changeTables?: (google.cloud.datastream.v1.ISqlServerChangeTables|null);

SqlServerSourceConfig changeTables.

excludeObjects

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

SqlServerSourceConfig excludeObjects.

includeObjects

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

SqlServerSourceConfig includeObjects.

maxConcurrentBackfillTasks

public maxConcurrentBackfillTasks: number;

SqlServerSourceConfig maxConcurrentBackfillTasks.

maxConcurrentCdcTasks

public maxConcurrentCdcTasks: number;

SqlServerSourceConfig maxConcurrentCdcTasks.

transactionLogs

public transactionLogs?: (google.cloud.datastream.v1.ISqlServerTransactionLogs|null);

SqlServerSourceConfig transactionLogs.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.ISqlServerSourceConfig): google.cloud.datastream.v1.SqlServerSourceConfig;

Creates a new SqlServerSourceConfig instance using the specified properties.

Parameter
Name Description
properties ISqlServerSourceConfig

Properties to set

Returns
Type Description
SqlServerSourceConfig

SqlServerSourceConfig instance

decode(reader, length)

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

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

SqlServerSourceConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SqlServerSourceConfig

SqlServerSourceConfig

encode(message, writer)

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

Encodes the specified SqlServerSourceConfig message. Does not implicitly messages.

Parameters
Name Description
message ISqlServerSourceConfig

SqlServerSourceConfig 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.datastream.v1.ISqlServerSourceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISqlServerSourceConfig

SqlServerSourceConfig 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.datastream.v1.SqlServerSourceConfig;

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

SqlServerSourceConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlServerSourceConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SqlServerSourceConfig

SqlServerSourceConfig

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