Database Migration v1 API - Class MigrationJobName (2.2.0)

public sealed class MigrationJobName : IResourceName, IEquatable<MigrationJobName>

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

Resource name for the MigrationJob resource.

Inheritance

object > MigrationJobName

Implements

IResourceName, IEquatable MigrationJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

MigrationJobName(string, string, string)

public MigrationJobName(string projectId, string locationId, string migrationJobId)

Constructs a new instance of a MigrationJobName class from the component parts of pattern projects/{project}/locations/{location}/migrationJobs/{migration_job}

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.
`migrationJobId`	`string` The `MigrationJob` ID. Must not be `null` or empty.

Properties

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`

MigrationJobId

public string MigrationJobId { get; }

The MigrationJob 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 MigrationJobName.ResourceNameType Type { get; }

The MigrationJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MigrationJobNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string migrationJobId)

Formats the IDs into the string representation of this MigrationJobName with pattern projects/{project}/locations/{location}/migrationJobs/{migration_job}.

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.
`migrationJobId`	`string` The `MigrationJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MigrationJobName with pattern `projects/{project}/locations/{location}/migrationJobs/{migration_job}`.

FormatProjectLocationMigrationJob(string, string, string)

public static string FormatProjectLocationMigrationJob(string projectId, string locationId, string migrationJobId)

Formats the IDs into the string representation of this MigrationJobName with pattern projects/{project}/locations/{location}/migrationJobs/{migration_job}.

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.
`migrationJobId`	`string` The `MigrationJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MigrationJobName with pattern `projects/{project}/locations/{location}/migrationJobs/{migration_job}`.

FromProjectLocationMigrationJob(string, string, string)

public static MigrationJobName FromProjectLocationMigrationJob(string projectId, string locationId, string migrationJobId)

Creates a MigrationJobName with the pattern projects/{project}/locations/{location}/migrationJobs/{migration_job}.

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.
`migrationJobId`	`string` The `MigrationJob` ID. Must not be `null` or empty.

Returns
Type	Description
`MigrationJobName`	A new instance of MigrationJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MigrationJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MigrationJobName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`MigrationJobName`	A new instance of MigrationJobName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static MigrationJobName Parse(string migrationJobName)

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

Parameter
Name	Description
`migrationJobName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`MigrationJobName`	The parsed MigrationJobName if successful.

Remarks

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

projects/{project}/locations/{location}/migrationJobs/{migration_job}

Parse(string, bool)

public static MigrationJobName Parse(string migrationJobName, bool allowUnparsed)

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

Parameters
Name	Description
`migrationJobName`	`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
`MigrationJobName`	The parsed MigrationJobName if successful.

Remarks

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

projects/{project}/locations/{location}/migrationJobs/{migration_job}

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

object.ToString()

TryParse(string, out MigrationJobName)

public static bool TryParse(string migrationJobName, out MigrationJobName result)

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

Parameters
Name	Description
`migrationJobName`	`string` The resource name in string form. Must not be `null`.
`result`	`MigrationJobName` When this method returns, the parsed MigrationJobName, 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}/migrationJobs/{migration_job}

TryParse(string, bool, out MigrationJobName)

public static bool TryParse(string migrationJobName, bool allowUnparsed, out MigrationJobName result)

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

Parameters
Name	Description
`migrationJobName`	`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`	`MigrationJobName` When this method returns, the parsed MigrationJobName, 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}/migrationJobs/{migration_job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MigrationJobName, MigrationJobName)

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

Parameters
Name	Description
`a`	`MigrationJobName`
`b`	`MigrationJobName`

Returns
Type	Description
`bool`

operator !=(MigrationJobName, MigrationJobName)

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

Parameters
Name	Description
`a`	`MigrationJobName`
`b`	`MigrationJobName`

Returns
Type	Description
`bool`