VM Migration v1 API - Class MigratingVmName (2.8.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
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.

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

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

The MigratingVmName.ResourceNameType of the contained resource name.

Property Value
Type Description
MigratingVmNameResourceNameType

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)

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
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.
Returns
Type Description
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
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.
Returns
Type Description
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
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.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MigratingVmName

A new instance of MigratingVmName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static MigratingVmName Parse(string migratingVmName)

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

Parameter
Name Description
migratingVmName string

The resource name in string form. Must not be null.
Returns
Type Description
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, bool)

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
Name Description
migratingVmName 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
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
Type Description
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
Name Description
migratingVmName string

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

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

TryParse(string, bool, 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
Name Description
migratingVmName 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 MigratingVmName

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

Operators

operator ==(MigratingVmName, MigratingVmName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MigratingVmName

The first resource name to compare, or null.
b MigratingVmName

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 !=(MigratingVmName, MigratingVmName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MigratingVmName

The first resource name to compare, or null.
b MigratingVmName

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.