VM Migration v1 API - Class MigratingVmName (2.3.0)

public sealed class MigratingVmName : IResourceName, IEquatable<MigratingVmName>

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

Resource name for the MigratingVm resource.

Inheritance

Object > MigratingVmName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

MigratingVmName(String, String, String, String)

public MigratingVmName(string projectId, string locationId, string sourceId, string migratingVmId)

Constructs a new instance of a MigratingVmName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}

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.

Properties

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

The MigratingVmName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MigratingVmName.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)

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

Formats the IDs into the string representation of this MigratingVmName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}.

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.

Returns
TypeDescription
String

The string representation of this MigratingVmName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}.

FormatProjectLocationSourceMigratingVm(String, String, String, String)

public static string FormatProjectLocationSourceMigratingVm(string projectId, string locationId, string sourceId, string migratingVmId)

Formats the IDs into the string representation of this MigratingVmName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}.

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.

Returns
TypeDescription
String

The string representation of this MigratingVmName with pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}.

FromProjectLocationSourceMigratingVm(String, String, String, String)

public static MigratingVmName FromProjectLocationSourceMigratingVm(string projectId, string locationId, string sourceId, string migratingVmId)

Creates a MigratingVmName with the pattern projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}.

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.

Returns
TypeDescription
MigratingVmName

A new instance of MigratingVmName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MigratingVmName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MigratingVmName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MigratingVmName

A new instance of MigratingVmName 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 MigratingVmName Parse(string migratingVmName)

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

Parameter
NameDescription
migratingVmNameString

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

Returns
TypeDescription
MigratingVmName

The parsed MigratingVmName 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}

Parse(String, Boolean)

public static MigratingVmName Parse(string migratingVmName, bool allowUnparsed)

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

Parameters
NameDescription
migratingVmNameString

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
MigratingVmName

The parsed MigratingVmName 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}
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 MigratingVmName)

public static bool TryParse(string migratingVmName, out MigratingVmName result)

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

Parameters
NameDescription
migratingVmNameString

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

resultMigratingVmName

When this method returns, the parsed MigratingVmName, 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}

TryParse(String, Boolean, out MigratingVmName)

public static bool TryParse(string migratingVmName, bool allowUnparsed, out MigratingVmName result)

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

Parameters
NameDescription
migratingVmNameString

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.

resultMigratingVmName

When this method returns, the parsed MigratingVmName, 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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(MigratingVmName, MigratingVmName)

public static bool operator ==(MigratingVmName a, MigratingVmName b)
Parameters
NameDescription
aMigratingVmName
bMigratingVmName
Returns
TypeDescription
Boolean

Inequality(MigratingVmName, MigratingVmName)

public static bool operator !=(MigratingVmName a, MigratingVmName b)
Parameters
NameDescription
aMigratingVmName
bMigratingVmName
Returns
TypeDescription
Boolean