MappingRule class

Creates a new mapping rule for a given conversion workspace.

Constructors

MappingRule(String name, {MappingRuleArgs? args, CustomResourceOptions? options})

Creates a new MappingRule. name The Pulumi resource name. args Arguments used to configure this MappingRule. The set of arguments for MappingRule. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

conditionalColumnSetValue ↔ Output<ConditionalColumnSetValueResponse>

Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.

late, final

conversionWorkspaceId ↔ Output<String>

late, final

convertRowidColumn ↔ Output<ConvertRowIdToColumnResponse>

Optional. Rule to specify how multiple tables should be converted with an additional rowid column.

late, final

displayName ↔ Output<String>

Optional. A human readable name

late, final

entityMove ↔ Output<EntityMoveResponse>

Optional. Rule to specify how multiple entities should be relocated into a different schema.

late, final

filter ↔ Output<MappingRuleFilterResponse>

The rule filter

late, final

filterTableColumns ↔ Output<FilterTableColumnsResponse>

Optional. Rule to specify the list of columns to include or exclude from a table.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

late, final

mappingRuleId ↔ Output<String>

Required. The ID of the rule to create.

late, final

multiColumnDataTypeChange ↔ Output<MultiColumnDatatypeChangeResponse>

Optional. Rule to specify how multiple columns should be converted to a different data type.

late, final

multiEntityRename ↔ Output<MultiEntityRenameResponse>

Optional. Rule to specify how multiple entities should be renamed.

late, final

name ↔ Output<String>

Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.

late, final

project ↔ Output<String>

late, final

requestId ↔ Output<String?>

A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

revisionCreateTime ↔ Output<String>

The timestamp that the revision was created.

late, final

revisionId ↔ Output<String>

The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.

late, final

ruleOrder ↔ Output<String>

The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.

late, final

ruleScope ↔ Output<String>

The rule scope

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setTablePrimaryKey ↔ Output<SetTablePrimaryKeyResponse>

Optional. Rule to specify the primary key for a table

late, final

singleColumnChange ↔ Output<SingleColumnChangeResponse>

Optional. Rule to specify how a single column is converted.

late, final

singleEntityRename ↔ Output<SingleEntityRenameResponse>

Optional. Rule to specify how a single entity should be renamed.

late, final

singlePackageChange ↔ Output<SinglePackageChangeResponse>

Optional. Rule to specify how a single package is converted.

late, final

sourceSqlChange ↔ Output<SourceSqlChangeResponse>

Optional. Rule to change the sql code for an entity, for example, function, procedure.

late, final

state ↔ Output<String>

Optional. The mapping rule state

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited