Database Migration v1 API - Class MappingRuleName (2.4.0) 

public sealed class MappingRuleName : IResourceName, IEquatable<MappingRuleName>

Reference documentation and code samples for the Database Migration v1 API class MappingRuleName.

Resource name for the MappingRule resource.

Inheritance

object > MappingRuleName

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

MappingRuleName(string, string, string, string)

public MappingRuleName(string projectId, string locationId, string conversionWorkspaceId, string mappingRuleId)

Constructs a new instance of a MappingRuleName class from the component parts of pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
conversionWorkspaceId string

The ConversionWorkspace ID. Must not be null or empty.
mappingRuleId string

The MappingRule ID. Must not be null or empty.

Properties

ConversionWorkspaceId

public string ConversionWorkspaceId { get; }

The ConversionWorkspace ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

MappingRuleId

public string MappingRuleId { get; }

The MappingRule ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public MappingRuleName.ResourceNameType Type { get; }

The MappingRuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
MappingRuleNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string conversionWorkspaceId, string mappingRuleId)

Formats the IDs into the string representation of this MappingRuleName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
conversionWorkspaceId string

The ConversionWorkspace ID. Must not be null or empty.
mappingRuleId string

The MappingRule ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MappingRuleName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule} .

FormatProjectLocationConversionWorkspaceMappingRule(string, string, string, string)

public static string FormatProjectLocationConversionWorkspaceMappingRule(string projectId, string locationId, string conversionWorkspaceId, string mappingRuleId)

Formats the IDs into the string representation of this MappingRuleName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
conversionWorkspaceId string

The ConversionWorkspace ID. Must not be null or empty.
mappingRuleId string

The MappingRule ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MappingRuleName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule} .

FromProjectLocationConversionWorkspaceMappingRule(string, string, string, string)

public static MappingRuleName FromProjectLocationConversionWorkspaceMappingRule(string projectId, string locationId, string conversionWorkspaceId, string mappingRuleId)

Creates a MappingRuleName with the pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
conversionWorkspaceId string

The ConversionWorkspace ID. Must not be null or empty.
mappingRuleId string

The MappingRule ID. Must not be null or empty.
Returns
Type Description
MappingRuleName

A new instance of MappingRuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MappingRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MappingRuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MappingRuleName

A new instance of MappingRuleName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static MappingRuleName Parse(string mappingRuleName)

Parses the given resource name string into a new MappingRuleName instance.

Parameter
Name Description
mappingRuleName string

The resource name in string form. Must not be null.
Returns
Type Description
MappingRuleName

The parsed MappingRuleName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}

Parse(string, bool)

public static MappingRuleName Parse(string mappingRuleName, bool allowUnparsed)

Parses the given resource name string into a new MappingRuleName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
mappingRuleName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
MappingRuleName

The parsed MappingRuleName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out MappingRuleName)

public static bool TryParse(string mappingRuleName, out MappingRuleName result)

Tries to parse the given resource name string into a new MappingRuleName instance.

Parameters
Name Description
mappingRuleName string

The resource name in string form. Must not be null.
result MappingRuleName

When this method returns, the parsed MappingRuleName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}

TryParse(string, bool, out MappingRuleName)

public static bool TryParse(string mappingRuleName, bool allowUnparsed, out MappingRuleName result)

Tries to parse the given resource name string into a new MappingRuleName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
mappingRuleName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result MappingRuleName

When this method returns, the parsed MappingRuleName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MappingRuleName, MappingRuleName)

public static bool operator ==(MappingRuleName a, MappingRuleName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MappingRuleName

The first resource name to compare, or null.
b MappingRuleName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(MappingRuleName, MappingRuleName)

public static bool operator !=(MappingRuleName a, MappingRuleName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a MappingRuleName

The first resource name to compare, or null.
b MappingRuleName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.