VMware Engine v1 API - Class NetworkPeeringName (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class NetworkPeeringName : IResourceName, IEquatable<NetworkPeeringName>

Reference documentation and code samples for the VMware Engine v1 API class NetworkPeeringName.

Resource name for the NetworkPeering resource.

Inheritance

object > NetworkPeeringName

Implements

IResourceName, IEquatableNetworkPeeringName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

NetworkPeeringName(string, string, string)

public NetworkPeeringName(string projectId, string locationId, string networkPeeringId)

Constructs a new instance of a NetworkPeeringName class from the component parts of pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}

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.
networkPeeringId	string The NetworkPeering 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

NetworkPeeringId

public string NetworkPeeringId { get; }

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

The NetworkPeeringName.ResourceNameType of the contained resource name.

Property Value
Type	Description
NetworkPeeringNameResourceNameType

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

Formats the IDs into the string representation of this NetworkPeeringName with pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}.

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.
networkPeeringId	string The NetworkPeering ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this NetworkPeeringName with pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}.

FormatProjectLocationNetworkPeering(string, string, string)

public static string FormatProjectLocationNetworkPeering(string projectId, string locationId, string networkPeeringId)

Formats the IDs into the string representation of this NetworkPeeringName with pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}.

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.
networkPeeringId	string The NetworkPeering ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this NetworkPeeringName with pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}.

FromProjectLocationNetworkPeering(string, string, string)

public static NetworkPeeringName FromProjectLocationNetworkPeering(string projectId, string locationId, string networkPeeringId)

Creates a NetworkPeeringName with the pattern projects/{project}/locations/{location}/networkPeerings/{network_peering}.

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.
networkPeeringId	string The NetworkPeering ID. Must not be null or empty.

Returns
Type	Description
NetworkPeeringName	A new instance of NetworkPeeringName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NetworkPeeringName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworkPeeringName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
NetworkPeeringName	A new instance of NetworkPeeringName 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 NetworkPeeringName Parse(string networkPeeringName)

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

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

Returns
Type	Description
NetworkPeeringName	The parsed NetworkPeeringName if successful.

Remarks

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

• projects/{project}/locations/{location}/networkPeerings/{network_peering}

Parse(string, bool)

public static NetworkPeeringName Parse(string networkPeeringName, bool allowUnparsed)

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

Parameters
Name	Description
networkPeeringName	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
NetworkPeeringName	The parsed NetworkPeeringName if successful.

Remarks

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

• projects/{project}/locations/{location}/networkPeerings/{network_peering}

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

public static bool TryParse(string networkPeeringName, out NetworkPeeringName result)

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

Parameters
Name	Description
networkPeeringName	string The resource name in string form. Must not be null.
result	NetworkPeeringName When this method returns, the parsed NetworkPeeringName, 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}/networkPeerings/{network_peering}

TryParse(string, bool, out NetworkPeeringName)

public static bool TryParse(string networkPeeringName, bool allowUnparsed, out NetworkPeeringName result)

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

Parameters
Name	Description
networkPeeringName	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	NetworkPeeringName When this method returns, the parsed NetworkPeeringName, 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}/networkPeerings/{network_peering}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NetworkPeeringName, NetworkPeeringName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	NetworkPeeringName The first resource name to compare, or null.
b	NetworkPeeringName 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 !=(NetworkPeeringName, NetworkPeeringName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	NetworkPeeringName The first resource name to compare, or null.
b	NetworkPeeringName 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.