Network Connectivity v1 API - Class VpnTunnelName (2.2.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

Implements

IResourceName, IEquatable<VpnTunnelName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`VpnTunnelName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`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}/regions/{region}/vpnTunnels/{resource_id}

TryParse(String, Boolean, 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`	`Boolean` 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
`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}/regions/{region}/vpnTunnels/{resource_id}

Or may be in any format if allowUnparsed is true.

Operators

Equality(VpnTunnelName, VpnTunnelName)

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

Parameters
Name	Description
`a`	`VpnTunnelName`
`b`	`VpnTunnelName`

Returns
Type	Description
`Boolean`

Inequality(VpnTunnelName, VpnTunnelName)

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

Parameters
Name	Description
`a`	`VpnTunnelName`
`b`	`VpnTunnelName`

Returns
Type	Description
`Boolean`