VM Migration v1 API - Class DiskMigrationJobName (2.8.0) 

public sealed class DiskMigrationJobName : IResourceName, IEquatable<DiskMigrationJobName>

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

Resource name for the DiskMigrationJob resource.

Inheritance

object > DiskMigrationJobName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

DiskMigrationJobName(string, string, string, string)

public DiskMigrationJobName(string projectId, string locationId, string sourceId, string diskMigrationJobId)

Constructs a new instance of a DiskMigrationJobName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_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.
diskMigrationJobId string

The DiskMigrationJob ID. Must not be null or empty.

Properties

DiskMigrationJobId

public string DiskMigrationJobId { get; }

The DiskMigrationJob 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

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

The DiskMigrationJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
DiskMigrationJobNameResourceNameType

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

Formats the IDs into the string representation of this DiskMigrationJobName with pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_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.
diskMigrationJobId string

The DiskMigrationJob ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DiskMigrationJobName with pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_job}.

FormatProjectLocationSourceDiskMigrationJob(string, string, string, string)

public static string FormatProjectLocationSourceDiskMigrationJob(string projectId, string locationId, string sourceId, string diskMigrationJobId)

Formats the IDs into the string representation of this DiskMigrationJobName with pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_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.
diskMigrationJobId string

The DiskMigrationJob ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DiskMigrationJobName with pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_job}.

FromProjectLocationSourceDiskMigrationJob(string, string, string, string)

public static DiskMigrationJobName FromProjectLocationSourceDiskMigrationJob(string projectId, string locationId, string sourceId, string diskMigrationJobId)

Creates a DiskMigrationJobName with the pattern projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_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.
diskMigrationJobId string

The DiskMigrationJob ID. Must not be null or empty.
Returns
Type Description
DiskMigrationJobName

A new instance of DiskMigrationJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DiskMigrationJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiskMigrationJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
diskMigrationJobName string

The resource name in string form. Must not be null.
Returns
Type Description
DiskMigrationJobName

The parsed DiskMigrationJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_job}

Parse(string, bool)

public static DiskMigrationJobName Parse(string diskMigrationJobName, bool allowUnparsed)

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

Parameters
Name Description
diskMigrationJobName 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
DiskMigrationJobName

The parsed DiskMigrationJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/diskMigrationJobs/{disk_migration_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

TryParse(string, out DiskMigrationJobName)

public static bool TryParse(string diskMigrationJobName, out DiskMigrationJobName result)

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

Parameters
Name Description
diskMigrationJobName string

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

When this method returns, the parsed DiskMigrationJobName, 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}/diskMigrationJobs/{disk_migration_job}

TryParse(string, bool, out DiskMigrationJobName)

public static bool TryParse(string diskMigrationJobName, bool allowUnparsed, out DiskMigrationJobName result)

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

Parameters
Name Description
diskMigrationJobName 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 DiskMigrationJobName

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

Operators

operator ==(DiskMigrationJobName, DiskMigrationJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DiskMigrationJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DiskMigrationJobName

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

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.