VM Migration v1 API - Class CutoverJobName (2.3.0)

public sealed class CutoverJobName : IResourceName, IEquatable<CutoverJobName>

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

Resource name for the CutoverJob resource.

Inheritance

Object > CutoverJobName

Implements

IResourceName, IEquatable<CutoverJobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

CutoverJobName(String, String, String, String, String)

public CutoverJobName(string projectId, string locationId, string sourceId, string migratingVmId, string cutoverJobId)

Constructs a new instance of a CutoverJobName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_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.
`cutoverJobId`	`String` The `CutoverJob` ID. Must not be `null` or empty.

Properties

CutoverJobId

public string CutoverJobId { get; }

The CutoverJob 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
`Boolean`

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 CutoverJobName.ResourceNameType Type { get; }

The CutoverJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CutoverJobName.ResourceNameType`

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 cutoverJobId)

Formats the IDs into the string representation of this CutoverJobName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_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.
`cutoverJobId`	`String` The `CutoverJob` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this CutoverJobName with pattern `projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_job}` .

FormatProjectLocationSourceMigratingVmCutoverJob(String, String, String, String, String)

public static string FormatProjectLocationSourceMigratingVmCutoverJob(string projectId, string locationId, string sourceId, string migratingVmId, string cutoverJobId)

Formats the IDs into the string representation of this CutoverJobName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_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.
`cutoverJobId`	`String` The `CutoverJob` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this CutoverJobName with pattern `projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_job}` .

FromProjectLocationSourceMigratingVmCutoverJob(String, String, String, String, String)

public static CutoverJobName FromProjectLocationSourceMigratingVmCutoverJob(string projectId, string locationId, string sourceId, string migratingVmId, string cutoverJobId)

Creates a CutoverJobName with the pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/cutoverJobs/{cutover_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.
`cutoverJobId`	`String` The `CutoverJob` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static CutoverJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CutoverJobName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static CutoverJobName Parse(string cutoverJobName)

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

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

Returns
Type	Description
`CutoverJobName`	The parsed CutoverJobName 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}/cutoverJobs/{cutover_job}

Parse(String, Boolean)

public static CutoverJobName Parse(string cutoverJobName, bool allowUnparsed)

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

Parameters
Name	Description
`cutoverJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`CutoverJobName`	The parsed CutoverJobName 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}/cutoverJobs/{cutover_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 CutoverJobName)

public static bool TryParse(string cutoverJobName, out CutoverJobName result)

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

Parameters
Name	Description
`cutoverJobName`	`String` The resource name in string form. Must not be `null`.
`result`	`CutoverJobName` When this method returns, the parsed CutoverJobName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/cutoverJobs/{cutover_job}

TryParse(String, Boolean, out CutoverJobName)

public static bool TryParse(string cutoverJobName, bool allowUnparsed, out CutoverJobName result)

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

Parameters
Name	Description
`cutoverJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`CutoverJobName` When this method returns, the parsed CutoverJobName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/cutoverJobs/{cutover_job}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CutoverJobName, CutoverJobName)

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

Parameters
Name	Description
`a`	`CutoverJobName`
`b`	`CutoverJobName`

Returns
Type	Description
`Boolean`

Inequality(CutoverJobName, CutoverJobName)

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

Parameters
Name	Description
`a`	`CutoverJobName`
`b`	`CutoverJobName`

Returns
Type	Description
`Boolean`