Bare Metal Solution v2 API - Class NFSShareName (1.0.0)

Stay organized with collections Save and categorize content based on your preferences.
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

nfsShareIdString

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

NfsShareId

public string NfsShareId { get; }

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

Type

public NFSShareName.ResourceNameType Type { get; }

The NFSShareName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
NFSShareName.ResourceNameType

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)

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

nfsShareIdString

The NfsShare ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

nfsShareIdString

The NfsShare ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

nfsShareIdString

The NfsShare ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
NFSShareName

A new instance of NFSShareName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static NFSShareName Parse(string nFSShareName)

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

Parameter
NameDescription
nFSShareNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
nFSShareNameString

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

allowUnparsedBoolean

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
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
TypeDescription
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
NameDescription
nFSShareNameString

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

resultNFSShareName

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

Returns
TypeDescription
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}/nfsShares/{nfs_share}

TryParse(String, Boolean, 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
NameDescription
nFSShareNameString

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

allowUnparsedBoolean

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.

resultNFSShareName

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

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

Operators

Equality(NFSShareName, NFSShareName)

public static bool operator ==(NFSShareName a, NFSShareName b)
Parameters
NameDescription
aNFSShareName
bNFSShareName
Returns
TypeDescription
Boolean

Inequality(NFSShareName, NFSShareName)

public static bool operator !=(NFSShareName a, NFSShareName b)
Parameters
NameDescription
aNFSShareName
bNFSShareName
Returns
TypeDescription
Boolean