Bare Metal Solution v2 API - Class NFSShareName (1.7.0)

public sealed class NFSShareName : IResourceName, IEquatable<NFSShareName>

Reference documentation and code samples for the Bare Metal Solution v2 API class NFSShareName.

Resource name for the NFSShare resource.

Inheritance

object > NFSShareName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

NFSShareName(string, string, string)

public NFSShareName(string projectId, string locationId, string nfsShareId)

Constructs a new instance of a NFSShareName class from the component parts of pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}

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

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

NfsShareId

public string NfsShareId { get; }

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

Type

public NFSShareName.ResourceNameType Type { get; }

The NFSShareName.ResourceNameType of the contained resource name.

Property Value
Type Description
NFSShareNameResourceNameType

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)

public static string Format(string projectId, string locationId, string nfsShareId)

Formats the IDs into the string representation of this NFSShareName with pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}.

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

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

The string representation of this NFSShareName with pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}.

FormatProjectLocationNfsShare(string, string, string)

public static string FormatProjectLocationNfsShare(string projectId, string locationId, string nfsShareId)

Formats the IDs into the string representation of this NFSShareName with pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}.

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

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

The string representation of this NFSShareName with pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}.

FromProjectLocationNfsShare(string, string, string)

public static NFSShareName FromProjectLocationNfsShare(string projectId, string locationId, string nfsShareId)

Creates a NFSShareName with the pattern projects/{project}/locations/{location}/nfsShares/{nfs_share}.

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

The NfsShare ID. Must not be null or empty.
Returns
Type Description
NFSShareName

A new instance of NFSShareName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NFSShareName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NFSShareName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
nFSShareName string

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

The parsed NFSShareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/nfsShares/{nfs_share}

Parse(string, bool)

public static NFSShareName Parse(string nFSShareName, bool allowUnparsed)

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

Parameters
Name Description
nFSShareName 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
NFSShareName

The parsed NFSShareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/nfsShares/{nfs_share}
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 NFSShareName)

public static bool TryParse(string nFSShareName, out NFSShareName result)

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

Parameters
Name Description
nFSShareName string

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

When this method returns, the parsed NFSShareName, 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}/nfsShares/{nfs_share}

TryParse(string, bool, out NFSShareName)

public static bool TryParse(string nFSShareName, bool allowUnparsed, out NFSShareName result)

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

Parameters
Name Description
nFSShareName 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 NFSShareName

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

Operators

operator ==(NFSShareName, NFSShareName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NFSShareName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NFSShareName

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

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.