Class CutoverJobName

public sealed class CutoverJobName : IResourceName, IEquatable<CutoverJobName>

Resource name for the CutoverJob resource.

Inheritance

Object > CutoverJobName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

migratingVmIdString

The MigratingVm ID. Must not be null or empty.

cutoverJobIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

MigratingVmId

public string MigratingVmId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SourceId

public string SourceId { get; }

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

Property Value
TypeDescription
String

Type

public CutoverJobName.ResourceNameType Type { get; }

The CutoverJobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CutoverJobName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

migratingVmIdString

The MigratingVm ID. Must not be null or empty.

cutoverJobIdString

The CutoverJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

migratingVmIdString

The MigratingVm ID. Must not be null or empty.

cutoverJobIdString

The CutoverJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

sourceIdString

The Source ID. Must not be null or empty.

migratingVmIdString

The MigratingVm ID. Must not be null or empty.

cutoverJobIdString

The CutoverJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CutoverJobName

A new instance of CutoverJobName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static CutoverJobName Parse(string cutoverJobName)

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

Parameter
NameDescription
cutoverJobNameString

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

Returns
TypeDescription
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
NameDescription
cutoverJobNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
cutoverJobNameString

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

resultCutoverJobName

When this method returns, the parsed CutoverJobName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
cutoverJobNameString

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

allowUnparsedBoolean

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.

resultCutoverJobName

When this method returns, the parsed CutoverJobName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
aCutoverJobName
bCutoverJobName
Returns
TypeDescription
Boolean

Inequality(CutoverJobName, CutoverJobName)

public static bool operator !=(CutoverJobName a, CutoverJobName b)
Parameters
NameDescription
aCutoverJobName
bCutoverJobName
Returns
TypeDescription
Boolean