Cloud Identity-Aware Proxy v1 API - Class TunnelLocationName (2.1.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

Implements

IResourceName, IEquatable<TunnelLocationName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` 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
Type	Description
`Boolean`

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`

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 TunnelLocationName.ResourceNameType Type { get; }

The TunnelLocationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TunnelLocationName.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)

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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.

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

Returns
Type	Description
`TunnelLocationName`	A new instance of TunnelLocationName 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 TunnelLocationName Parse(string tunnelLocationName)

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

Parameter
Name	Description
`tunnelLocationName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, Boolean)

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
Name	Description
`tunnelLocationName`	`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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`tunnelLocationName`	`String` The resource name in string form. Must not be `null`.
`result`	`TunnelLocationName` When this method returns, the parsed TunnelLocationName, 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}/iap_tunnel/locations/{location}

TryParse(String, Boolean, 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
Name	Description
`tunnelLocationName`	`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`	`TunnelLocationName` When this method returns, the parsed TunnelLocationName, 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}/iap_tunnel/locations/{location}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TunnelLocationName, TunnelLocationName)

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

Parameters
Name	Description
`a`	`TunnelLocationName`
`b`	`TunnelLocationName`

Returns
Type	Description
`Boolean`

Inequality(TunnelLocationName, TunnelLocationName)

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

Parameters
Name	Description
`a`	`TunnelLocationName`
`b`	`TunnelLocationName`

Returns
Type	Description
`Boolean`