NetApp v1 API - Class ReplicationName (1.11.0) 

public sealed class ReplicationName : IResourceName, IEquatable<ReplicationName>

Reference documentation and code samples for the NetApp v1 API class ReplicationName.

Resource name for the Replication resource.

Inheritance

object > ReplicationName

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

ReplicationName(string, string, string, string)

public ReplicationName(string projectId, string locationId, string volumeId, string replicationId)

Constructs a new instance of a ReplicationName class from the component parts of pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}

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.
volumeId string

The Volume ID. Must not be null or empty.
replicationId string

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

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

ReplicationId

public string ReplicationId { get; }

The Replication ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ReplicationName.ResourceNameType Type { get; }

The ReplicationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReplicationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

VolumeId

public string VolumeId { get; }

The Volume ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string volumeId, string replicationId)

Formats the IDs into the string representation of this ReplicationName with pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}.

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.
volumeId string

The Volume ID. Must not be null or empty.
replicationId string

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

The string representation of this ReplicationName with pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}.

FormatProjectLocationVolumeReplication(string, string, string, string)

public static string FormatProjectLocationVolumeReplication(string projectId, string locationId, string volumeId, string replicationId)

Formats the IDs into the string representation of this ReplicationName with pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}.

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.
volumeId string

The Volume ID. Must not be null or empty.
replicationId string

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

The string representation of this ReplicationName with pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}.

FromProjectLocationVolumeReplication(string, string, string, string)

public static ReplicationName FromProjectLocationVolumeReplication(string projectId, string locationId, string volumeId, string replicationId)

Creates a ReplicationName with the pattern projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}.

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.
volumeId string

The Volume ID. Must not be null or empty.
replicationId string

The Replication ID. Must not be null or empty.
Returns
Type Description
ReplicationName

A new instance of ReplicationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReplicationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReplicationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
replicationName string

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

The parsed ReplicationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}

Parse(string, bool)

public static ReplicationName Parse(string replicationName, bool allowUnparsed)

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

Parameters
Name Description
replicationName 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
ReplicationName

The parsed ReplicationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/volumes/{volume}/replications/{replication}
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 ReplicationName)

public static bool TryParse(string replicationName, out ReplicationName result)

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

Parameters
Name Description
replicationName string

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

When this method returns, the parsed ReplicationName, 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}/volumes/{volume}/replications/{replication}

TryParse(string, bool, out ReplicationName)

public static bool TryParse(string replicationName, bool allowUnparsed, out ReplicationName result)

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

Parameters
Name Description
replicationName 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 ReplicationName

When this method returns, the parsed ReplicationName, 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}/volumes/{volume}/replications/{replication}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReplicationName, ReplicationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReplicationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReplicationName

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

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.