VM Migration v1 API - Class CloneJobName (2.4.0)

public sealed class CloneJobName : IResourceName, IEquatable<CloneJobName>

Reference documentation and code samples for the VM Migration v1 API class CloneJobName.

Resource name for the CloneJob resource.

Inheritance

object > CloneJobName

Implements

IResourceName, IEquatable CloneJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

CloneJobName(string, string, string, string, string)

public CloneJobName(string projectId, string locationId, string sourceId, string migratingVmId, string cloneJobId)

Constructs a new instance of a CloneJobName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_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.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`migratingVmId`	`string` The `MigratingVm` ID. Must not be `null` or empty.
`cloneJobId`	`string` The `CloneJob` ID. Must not be `null` or empty.

Properties

CloneJobId

public string CloneJobId { get; }

The CloneJob 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`

MigratingVmId

public string MigratingVmId { get; }

The MigratingVm 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`

SourceId

public string SourceId { get; }

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

Property Value
Type	Description
`string`

Type

public CloneJobName.ResourceNameType Type { get; }

The CloneJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CloneJobNameResourceNameType`

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, string)

public static string Format(string projectId, string locationId, string sourceId, string migratingVmId, string cloneJobId)

Formats the IDs into the string representation of this CloneJobName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_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.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`migratingVmId`	`string` The `MigratingVm` ID. Must not be `null` or empty.
`cloneJobId`	`string` The `CloneJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this CloneJobName with pattern `projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_job}` .

FormatProjectLocationSourceMigratingVmCloneJob(string, string, string, string, string)

public static string FormatProjectLocationSourceMigratingVmCloneJob(string projectId, string locationId, string sourceId, string migratingVmId, string cloneJobId)

Formats the IDs into the string representation of this CloneJobName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_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.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`migratingVmId`	`string` The `MigratingVm` ID. Must not be `null` or empty.
`cloneJobId`	`string` The `CloneJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this CloneJobName with pattern `projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_job}` .

FromProjectLocationSourceMigratingVmCloneJob(string, string, string, string, string)

public static CloneJobName FromProjectLocationSourceMigratingVmCloneJob(string projectId, string locationId, string sourceId, string migratingVmId, string cloneJobId)

Creates a CloneJobName with the pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_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.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`migratingVmId`	`string` The `MigratingVm` ID. Must not be `null` or empty.
`cloneJobId`	`string` The `CloneJob` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static CloneJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloneJobName containing an unparsed resource name.

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

Returns
Type	Description
`CloneJobName`	A new instance of CloneJobName 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 CloneJobName Parse(string cloneJobName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_job}

Parse(string, bool)

public static CloneJobName Parse(string cloneJobName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_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 CloneJobName)

public static bool TryParse(string cloneJobName, out CloneJobName result)

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

Parameters
Name	Description
`cloneJobName`	`string` The resource name in string form. Must not be `null`.
`result`	`CloneJobName` When this method returns, the parsed CloneJobName, 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}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_job}

TryParse(string, bool, out CloneJobName)

public static bool TryParse(string cloneJobName, bool allowUnparsed, out CloneJobName result)

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

Parameters
Name	Description
`cloneJobName`	`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`	`CloneJobName` When this method returns, the parsed CloneJobName, 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}/sources/{source}/migratingVms/{migrating_vm}/cloneJobs/{clone_job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CloneJobName, CloneJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`CloneJobName` The first resource name to compare, or null.
`b`	`CloneJobName` 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 !=(CloneJobName, CloneJobName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`CloneJobName` The first resource name to compare, or null.
`b`	`CloneJobName` 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.