Bare Metal Solution v2 API - Class NetworkName (1.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class NetworkName : IResourceName, IEquatable<NetworkName>

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

Resource name for the Network resource.

Inheritance

Object > NetworkName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

NetworkName(String, String, String)

public NetworkName(string projectId, string locationId, string networkId)

Constructs a new instance of a NetworkName class from the component parts of pattern projects/{project}/locations/{location}/networks/{network}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

networkIdString

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

NetworkId

public string NetworkId { get; }

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

The NetworkName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
NetworkName.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 networkId)

Formats the IDs into the string representation of this NetworkName with pattern projects/{project}/locations/{location}/networks/{network}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

networkIdString

The Network ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NetworkName with pattern projects/{project}/locations/{location}/networks/{network}.

FormatProjectLocationNetwork(String, String, String)

public static string FormatProjectLocationNetwork(string projectId, string locationId, string networkId)

Formats the IDs into the string representation of this NetworkName with pattern projects/{project}/locations/{location}/networks/{network}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

networkIdString

The Network ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NetworkName with pattern projects/{project}/locations/{location}/networks/{network}.

FromProjectLocationNetwork(String, String, String)

public static NetworkName FromProjectLocationNetwork(string projectId, string locationId, string networkId)

Creates a NetworkName with the pattern projects/{project}/locations/{location}/networks/{network}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

networkIdString

The Network ID. Must not be null or empty.

Returns
TypeDescription
NetworkName

A new instance of NetworkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NetworkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworkName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
NetworkName

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

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

Parameter
NameDescription
networkNameString

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

Returns
TypeDescription
NetworkName

The parsed NetworkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/networks/{network}

Parse(String, Boolean)

public static NetworkName Parse(string networkName, bool allowUnparsed)

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

Parameters
NameDescription
networkNameString

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
NetworkName

The parsed NetworkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/networks/{network}
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 NetworkName)

public static bool TryParse(string networkName, out NetworkName result)

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

Parameters
NameDescription
networkNameString

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

resultNetworkName

When this method returns, the parsed NetworkName, 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}/networks/{network}

TryParse(String, Boolean, out NetworkName)

public static bool TryParse(string networkName, bool allowUnparsed, out NetworkName result)

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

Parameters
NameDescription
networkNameString

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.

resultNetworkName

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

Operators

Equality(NetworkName, NetworkName)

public static bool operator ==(NetworkName a, NetworkName b)
Parameters
NameDescription
aNetworkName
bNetworkName
Returns
TypeDescription
Boolean

Inequality(NetworkName, NetworkName)

public static bool operator !=(NetworkName a, NetworkName b)
Parameters
NameDescription
aNetworkName
bNetworkName
Returns
TypeDescription
Boolean