Network Connectivity v1 API - Class NetworkName (2.3.0)

Version 2.3.0

• 2.8.0 (latest)
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class NetworkName : IResourceName, IEquatable<NetworkName>

Reference documentation and code samples for the Network Connectivity v1 API class NetworkName.

Resource name for the Network resource.

Inheritance

object > NetworkName

Implements

IResourceName, IEquatableNetworkName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GoogleCloudGoogle.Cloud.NetworkConnectivityV1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

NetworkName(string, string)

public NetworkName(string projectId, string resourceId)

Constructs a new instance of a NetworkName class from the component parts of pattern projects/{project}/global/networks/{resource_id}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
resourceId	string The Resource 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

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

ResourceId

public string ResourceId { get; }

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

Property Value
Type	Description
string

Type

public NetworkName.ResourceNameType Type { get; }

The NetworkName.ResourceNameType of the contained resource name.

Property Value
Type	Description
NetworkNameResourceNameType

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)

public static string Format(string projectId, string resourceId)

Formats the IDs into the string representation of this NetworkName with pattern projects/{project}/global/networks/{resource_id}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
resourceId	string The Resource ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this NetworkName with pattern projects/{project}/global/networks/{resource_id}.

FormatProjectResource(string, string)

public static string FormatProjectResource(string projectId, string resourceId)

Formats the IDs into the string representation of this NetworkName with pattern projects/{project}/global/networks/{resource_id}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
resourceId	string The Resource ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this NetworkName with pattern projects/{project}/global/networks/{resource_id}.

FromProjectResource(string, string)

public static NetworkName FromProjectResource(string projectId, string resourceId)

Creates a NetworkName with the pattern projects/{project}/global/networks/{resource_id} .

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
resourceId	string The Resource ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
NetworkName	A new instance of NetworkName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

Object.GetHashCode()

Parse(string)

public static NetworkName Parse(string networkName)

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

Parameter
Name	Description
networkName	string The resource name in string form. Must not be null.

Returns
Type	Description
NetworkName	The parsed NetworkName if successful.

Remarks

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

• projects/{project}/global/networks/{resource_id}

Parse(string, bool)

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
Name	Description
networkName	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
NetworkName	The parsed NetworkName if successful.

Remarks

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

• projects/{project}/global/networks/{resource_id}

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

Object.ToString()

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
Name	Description
networkName	string The resource name in string form. Must not be null.
result	NetworkName When this method returns, the parsed NetworkName, 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}/global/networks/{resource_id}

TryParse(string, bool, 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
Name	Description
networkName	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	NetworkName When this method returns, the parsed NetworkName, 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}/global/networks/{resource_id}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NetworkName, NetworkName)

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

Parameters
Name	Description
a	NetworkName
b	NetworkName

Returns
Type	Description
bool

operator !=(NetworkName, NetworkName)

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

Parameters
Name	Description
a	NetworkName
b	NetworkName

Returns
Type	Description
bool