Class protos.google.cloud.clouddms.v1.MappingRule (5.1.1)

Represents a MappingRule.

Implements

Package

@google-cloud/dms

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.clouddms.v1.IMappingRule);

Constructs a new MappingRule.

Parameter
Name Description
properties IMappingRule

Properties to set

Properties

conditionalColumnSetValue

public conditionalColumnSetValue?: (google.cloud.clouddms.v1.IConditionalColumnSetValue|null);

MappingRule conditionalColumnSetValue.

convertRowidColumn

public convertRowidColumn?: (google.cloud.clouddms.v1.IConvertRowIdToColumn|null);

MappingRule convertRowidColumn.

details

public details?: ("singleEntityRename"|"multiEntityRename"|"entityMove"|"singleColumnChange"|"multiColumnDataTypeChange"|"conditionalColumnSetValue"|"convertRowidColumn"|"setTablePrimaryKey"|"singlePackageChange"|"sourceSqlChange"|"filterTableColumns");

MappingRule details.

displayName

public displayName: string;

MappingRule displayName.

entityMove

public entityMove?: (google.cloud.clouddms.v1.IEntityMove|null);

MappingRule entityMove.

filter

public filter?: (google.cloud.clouddms.v1.IMappingRuleFilter|null);

MappingRule filter.

filterTableColumns

public filterTableColumns?: (google.cloud.clouddms.v1.IFilterTableColumns|null);

MappingRule filterTableColumns.

multiColumnDataTypeChange

public multiColumnDataTypeChange?: (google.cloud.clouddms.v1.IMultiColumnDatatypeChange|null);

MappingRule multiColumnDataTypeChange.

multiEntityRename

public multiEntityRename?: (google.cloud.clouddms.v1.IMultiEntityRename|null);

MappingRule multiEntityRename.

name

public name: string;

MappingRule name.

revisionCreateTime

public revisionCreateTime?: (google.protobuf.ITimestamp|null);

MappingRule revisionCreateTime.

revisionId

public revisionId: string;

MappingRule revisionId.

ruleOrder

public ruleOrder: (number|Long|string);

MappingRule ruleOrder.

ruleScope

public ruleScope: (google.cloud.clouddms.v1.DatabaseEntityType|keyof typeof google.cloud.clouddms.v1.DatabaseEntityType);

MappingRule ruleScope.

setTablePrimaryKey

public setTablePrimaryKey?: (google.cloud.clouddms.v1.ISetTablePrimaryKey|null);

MappingRule setTablePrimaryKey.

singleColumnChange

public singleColumnChange?: (google.cloud.clouddms.v1.ISingleColumnChange|null);

MappingRule singleColumnChange.

singleEntityRename

public singleEntityRename?: (google.cloud.clouddms.v1.ISingleEntityRename|null);

MappingRule singleEntityRename.

singlePackageChange

public singlePackageChange?: (google.cloud.clouddms.v1.ISinglePackageChange|null);

MappingRule singlePackageChange.

sourceSqlChange

public sourceSqlChange?: (google.cloud.clouddms.v1.ISourceSqlChange|null);

MappingRule sourceSqlChange.

state

public state: (google.cloud.clouddms.v1.MappingRule.State|keyof typeof google.cloud.clouddms.v1.MappingRule.State);

MappingRule state.

Methods

create(properties)

public static create(properties?: google.cloud.clouddms.v1.IMappingRule): google.cloud.clouddms.v1.MappingRule;

Creates a new MappingRule instance using the specified properties.

Parameter
Name Description
properties IMappingRule

Properties to set
Returns
Type Description
MappingRule

MappingRule instance

decode(reader, length)

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

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

MappingRule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
MappingRule

MappingRule

encode(message, writer)

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

Encodes the specified MappingRule message. Does not implicitly messages.

Parameters
Name Description
message IMappingRule

MappingRule 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.clouddms.v1.IMappingRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IMappingRule

MappingRule 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.clouddms.v1.MappingRule;

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

MappingRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MappingRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message MappingRule

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