VM Migration v1 API - Class ReplicationCycleName (2.3.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

Implements

IResourceName, IEquatable<ReplicationCycleName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
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.
`replicationCycleId`	`String` 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
Type	Description
`Boolean`

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`

ReplicationCycleId

public string ReplicationCycleId { get; }

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

The ReplicationCycleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ReplicationCycleName.ResourceNameType`

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, 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
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.
`replicationCycleId`	`String` The `ReplicationCycle` ID. Must not be `null` or empty.

Returns
Type	Description
`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)

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.
`replicationCycleId`	`String` The `ReplicationCycle` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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.
`replicationCycleId`	`String` The `ReplicationCycle` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ReplicationCycleName`	A new instance of ReplicationCycleName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ReplicationCycleName Parse(string replicationCycleName)

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

Parameter
Name	Description
`replicationCycleName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, Boolean)

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
Name	Description
`replicationCycleName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`replicationCycleName`	`String` The resource name in string form. Must not be `null`.
`result`	`ReplicationCycleName` When this method returns, the parsed ReplicationCycleName, or `null` if parsing failed.

Returns
Type	Description
`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}/replicationCycles/{replication_cycle}

TryParse(String, Boolean, 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
Name	Description
`replicationCycleName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ReplicationCycleName` When this method returns, the parsed ReplicationCycleName, or `null` if parsing failed.

Returns
Type	Description
`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}/replicationCycles/{replication_cycle}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ReplicationCycleName, ReplicationCycleName)

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

Parameters
Name	Description
`a`	`ReplicationCycleName`
`b`	`ReplicationCycleName`

Returns
Type	Description
`Boolean`

Inequality(ReplicationCycleName, ReplicationCycleName)

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

Parameters
Name	Description
`a`	`ReplicationCycleName`
`b`	`ReplicationCycleName`

Returns
Type	Description
`Boolean`