VM Migration v1 API - Class ReplicationCycleName (2.5.0)

public sealed class ReplicationCycleName : IResourceName, IEquatable<ReplicationCycleName>

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

Resource name for the ReplicationCycle resource.

Inheritance

object > ReplicationCycleName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

ReplicationCycleName(string, string, string, string, string)

public ReplicationCycleName(string projectId, string locationId, string sourceId, string migratingVmId, string replicationCycleId)

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

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.

replicationCycleIdstring

The ReplicationCycle 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
bool

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

ReplicationCycleId

public string ReplicationCycleId { get; }

The ReplicationCycle 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 ReplicationCycleName.ResourceNameType Type { get; }

The ReplicationCycleName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ReplicationCycleNameResourceNameType

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

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

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.

replicationCycleIdstring

The ReplicationCycle ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationSourceMigratingVmReplicationCycle(string, string, string, string, string)

public static string FormatProjectLocationSourceMigratingVmReplicationCycle(string projectId, string locationId, string sourceId, string migratingVmId, string replicationCycleId)

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

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.

replicationCycleIdstring

The ReplicationCycle ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationSourceMigratingVmReplicationCycle(string, string, string, string, string)

public static ReplicationCycleName FromProjectLocationSourceMigratingVmReplicationCycle(string projectId, string locationId, string sourceId, string migratingVmId, string replicationCycleId)

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

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.

replicationCycleIdstring

The ReplicationCycle ID. Must not be null or empty.

Returns
TypeDescription
ReplicationCycleName

A new instance of ReplicationCycleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReplicationCycleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReplicationCycleName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ReplicationCycleName

A new instance of ReplicationCycleName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ReplicationCycleName Parse(string replicationCycleName)

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

Parameter
NameDescription
replicationCycleNamestring

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

Returns
TypeDescription
ReplicationCycleName

The parsed ReplicationCycleName 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}/replicationCycles/{replication_cycle}

Parse(string, bool)

public static ReplicationCycleName Parse(string replicationCycleName, bool allowUnparsed)

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

Parameters
NameDescription
replicationCycleNamestring

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

allowUnparsedbool

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
ReplicationCycleName

The parsed ReplicationCycleName 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}/replicationCycles/{replication_cycle}
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 ReplicationCycleName)

public static bool TryParse(string replicationCycleName, out ReplicationCycleName result)

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

Parameters
NameDescription
replicationCycleNamestring

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

resultReplicationCycleName

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

Returns
TypeDescription
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}/replicationCycles/{replication_cycle}

TryParse(string, bool, out ReplicationCycleName)

public static bool TryParse(string replicationCycleName, bool allowUnparsed, out ReplicationCycleName result)

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

Parameters
NameDescription
replicationCycleNamestring

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

allowUnparsedbool

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.

resultReplicationCycleName

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

Returns
TypeDescription
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}/replicationCycles/{replication_cycle}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReplicationCycleName, ReplicationCycleName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aReplicationCycleName

The first resource name to compare, or null.

bReplicationCycleName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ReplicationCycleName, ReplicationCycleName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aReplicationCycleName

The first resource name to compare, or null.

bReplicationCycleName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.