Bare Metal Solution v2 API - Class NetworkConfigName (1.7.0) 

public sealed class NetworkConfigName : IResourceName, IEquatable<NetworkConfigName>

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

Resource name for the NetworkConfig resource.

Inheritance

object > NetworkConfigName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

NetworkConfigName(string, string, string)

public NetworkConfigName(string projectId, string locationId, string networkConfigId)

Constructs a new instance of a NetworkConfigName class from the component parts of pattern projects/{project}/locations/{location}/networkConfigs/{network_config}

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

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

NetworkConfigId

public string NetworkConfigId { get; }

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

The NetworkConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
NetworkConfigNameResourceNameType

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 networkConfigId)

Formats the IDs into the string representation of this NetworkConfigName with pattern projects/{project}/locations/{location}/networkConfigs/{network_config}.

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

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

The string representation of this NetworkConfigName with pattern projects/{project}/locations/{location}/networkConfigs/{network_config}.

FormatProjectLocationNetworkConfig(string, string, string)

public static string FormatProjectLocationNetworkConfig(string projectId, string locationId, string networkConfigId)

Formats the IDs into the string representation of this NetworkConfigName with pattern projects/{project}/locations/{location}/networkConfigs/{network_config}.

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

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

The string representation of this NetworkConfigName with pattern projects/{project}/locations/{location}/networkConfigs/{network_config}.

FromProjectLocationNetworkConfig(string, string, string)

public static NetworkConfigName FromProjectLocationNetworkConfig(string projectId, string locationId, string networkConfigId)

Creates a NetworkConfigName with the pattern projects/{project}/locations/{location}/networkConfigs/{network_config}.

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

The NetworkConfig ID. Must not be null or empty.
Returns
Type Description
NetworkConfigName

A new instance of NetworkConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NetworkConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworkConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
networkConfigName string

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

The parsed NetworkConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/networkConfigs/{network_config}

Parse(string, bool)

public static NetworkConfigName Parse(string networkConfigName, bool allowUnparsed)

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

Parameters
Name Description
networkConfigName 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
NetworkConfigName

The parsed NetworkConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/networkConfigs/{network_config}
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 NetworkConfigName)

public static bool TryParse(string networkConfigName, out NetworkConfigName result)

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

Parameters
Name Description
networkConfigName string

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

When this method returns, the parsed NetworkConfigName, 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}/networkConfigs/{network_config}

TryParse(string, bool, out NetworkConfigName)

public static bool TryParse(string networkConfigName, bool allowUnparsed, out NetworkConfigName result)

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

Parameters
Name Description
networkConfigName 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 NetworkConfigName

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

Operators

operator ==(NetworkConfigName, NetworkConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NetworkConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NetworkConfigName

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

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.