Network Connectivity v1 API - Class VpnTunnelName (2.7.0) 

public sealed class VpnTunnelName : IResourceName, IEquatable<VpnTunnelName>

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

Resource name for the VpnTunnel resource.

Inheritance

object > VpnTunnelName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

VpnTunnelName(string, string, string)

public VpnTunnelName(string projectId, string regionId, string resourceId)

Constructs a new instance of a VpnTunnelName class from the component parts of pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
regionId string

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

RegionId

public string RegionId { get; }

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

The VpnTunnelName.ResourceNameType of the contained resource name.

Property Value
Type Description
VpnTunnelNameResourceNameType

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 regionId, string resourceId)

Formats the IDs into the string representation of this VpnTunnelName with pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
regionId string

The Region 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 VpnTunnelName with pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}.

FormatProjectRegionResource(string, string, string)

public static string FormatProjectRegionResource(string projectId, string regionId, string resourceId)

Formats the IDs into the string representation of this VpnTunnelName with pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
regionId string

The Region 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 VpnTunnelName with pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}.

FromProjectRegionResource(string, string, string)

public static VpnTunnelName FromProjectRegionResource(string projectId, string regionId, string resourceId)

Creates a VpnTunnelName with the pattern projects/{project}/regions/{region}/vpnTunnels/{resource_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
regionId string

The Region ID. Must not be null or empty.
resourceId string

The Resource ID. Must not be null or empty.
Returns
Type Description
VpnTunnelName

A new instance of VpnTunnelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VpnTunnelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VpnTunnelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
vpnTunnelName string

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

The parsed VpnTunnelName if successful.
Remarks

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

  • projects/{project}/regions/{region}/vpnTunnels/{resource_id}

Parse(string, bool)

public static VpnTunnelName Parse(string vpnTunnelName, bool allowUnparsed)

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

Parameters
Name Description
vpnTunnelName 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
VpnTunnelName

The parsed VpnTunnelName if successful.
Remarks

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

  • projects/{project}/regions/{region}/vpnTunnels/{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

TryParse(string, out VpnTunnelName)

public static bool TryParse(string vpnTunnelName, out VpnTunnelName result)

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

Parameters
Name Description
vpnTunnelName string

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

When this method returns, the parsed VpnTunnelName, 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}/regions/{region}/vpnTunnels/{resource_id}

TryParse(string, bool, out VpnTunnelName)

public static bool TryParse(string vpnTunnelName, bool allowUnparsed, out VpnTunnelName result)

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

Parameters
Name Description
vpnTunnelName 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 VpnTunnelName

When this method returns, the parsed VpnTunnelName, 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}/regions/{region}/vpnTunnels/{resource_id}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(VpnTunnelName, VpnTunnelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a VpnTunnelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a VpnTunnelName

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

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.