Cloud Identity-Aware Proxy v1 API - Class TunnelLocationName (2.4.0)

public sealed class TunnelLocationName : IResourceName, IEquatable<TunnelLocationName>

Reference documentation and code samples for the Cloud Identity-Aware Proxy v1 API class TunnelLocationName.

Resource name for the TunnelLocation resource.

Inheritance

object > TunnelLocationName

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Constructors

TunnelLocationName(string, string)

public TunnelLocationName(string projectId, string locationId)

Constructs a new instance of a TunnelLocationName class from the component parts of pattern projects/{project}/iap_tunnel/locations/{location}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location 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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public TunnelLocationName.ResourceNameType Type { get; }

The TunnelLocationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TunnelLocationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this TunnelLocationName with pattern projects/{project}/iap_tunnel/locations/{location}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TunnelLocationName with pattern projects/{project}/iap_tunnel/locations/{location}.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this TunnelLocationName with pattern projects/{project}/iap_tunnel/locations/{location}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TunnelLocationName with pattern projects/{project}/iap_tunnel/locations/{location}.

FromProjectLocation(string, string)

public static TunnelLocationName FromProjectLocation(string projectId, string locationId)

Creates a TunnelLocationName with the pattern projects/{project}/iap_tunnel/locations/{location}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
TunnelLocationName

A new instance of TunnelLocationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TunnelLocationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TunnelLocationName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TunnelLocationName

A new instance of TunnelLocationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TunnelLocationName Parse(string tunnelLocationName)

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

Parameter
NameDescription
tunnelLocationNamestring

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

Returns
TypeDescription
TunnelLocationName

The parsed TunnelLocationName if successful.

Remarks

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

  • projects/{project}/iap_tunnel/locations/{location}

Parse(string, bool)

public static TunnelLocationName Parse(string tunnelLocationName, bool allowUnparsed)

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

Parameters
NameDescription
tunnelLocationNamestring

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

allowUnparsedbool

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
TypeDescription
TunnelLocationName

The parsed TunnelLocationName if successful.

Remarks

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

  • projects/{project}/iap_tunnel/locations/{location}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out TunnelLocationName)

public static bool TryParse(string tunnelLocationName, out TunnelLocationName result)

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

Parameters
NameDescription
tunnelLocationNamestring

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

resultTunnelLocationName

When this method returns, the parsed TunnelLocationName, or null if parsing failed.

Returns
TypeDescription
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}/iap_tunnel/locations/{location}

TryParse(string, bool, out TunnelLocationName)

public static bool TryParse(string tunnelLocationName, bool allowUnparsed, out TunnelLocationName result)

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

Parameters
NameDescription
tunnelLocationNamestring

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

allowUnparsedbool

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.

resultTunnelLocationName

When this method returns, the parsed TunnelLocationName, or null if parsing failed.

Returns
TypeDescription
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}/iap_tunnel/locations/{location}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TunnelLocationName, TunnelLocationName)

public static bool operator ==(TunnelLocationName a, TunnelLocationName b)
Parameters
NameDescription
aTunnelLocationName
bTunnelLocationName
Returns
TypeDescription
bool

operator !=(TunnelLocationName, TunnelLocationName)

public static bool operator !=(TunnelLocationName a, TunnelLocationName b)
Parameters
NameDescription
aTunnelLocationName
bTunnelLocationName
Returns
TypeDescription
bool