Cloud Identity-Aware Proxy v1 API - Class TunnelDestGroupName (2.5.0)

public sealed class TunnelDestGroupName : IResourceName, IEquatable<TunnelDestGroupName>

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

Resource name for the TunnelDestGroup resource.

Inheritance

object > TunnelDestGroupName

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Constructors

TunnelDestGroupName(string, string, string)

public TunnelDestGroupName(string projectId, string locationId, string destGroupId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

destGroupIdstring

The DestGroup ID. Must not be null or empty.

Properties

DestGroupId

public string DestGroupId { get; }

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

Property Value
TypeDescription
string

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

The TunnelDestGroupName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TunnelDestGroupNameResourceNameType

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

public static string Format(string projectId, string locationId, string destGroupId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

destGroupIdstring

The DestGroup ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationDestGroup(string, string, string)

public static string FormatProjectLocationDestGroup(string projectId, string locationId, string destGroupId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

destGroupIdstring

The DestGroup ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationDestGroup(string, string, string)

public static TunnelDestGroupName FromProjectLocationDestGroup(string projectId, string locationId, string destGroupId)

Creates a TunnelDestGroupName with the pattern projects/{project}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

destGroupIdstring

The DestGroup ID. Must not be null or empty.

Returns
TypeDescription
TunnelDestGroupName

A new instance of TunnelDestGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TunnelDestGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TunnelDestGroupName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TunnelDestGroupName

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

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

Parameter
NameDescription
tunnelDestGroupNamestring

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

Returns
TypeDescription
TunnelDestGroupName

The parsed TunnelDestGroupName if successful.

Remarks

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

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

Parse(string, bool)

public static TunnelDestGroupName Parse(string tunnelDestGroupName, bool allowUnparsed)

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

Parameters
NameDescription
tunnelDestGroupNamestring

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
TunnelDestGroupName

The parsed TunnelDestGroupName if successful.

Remarks

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

  • projects/{project}/iap_tunnel/locations/{location}/destGroups/{dest_group}
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 TunnelDestGroupName)

public static bool TryParse(string tunnelDestGroupName, out TunnelDestGroupName result)

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

Parameters
NameDescription
tunnelDestGroupNamestring

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

resultTunnelDestGroupName

When this method returns, the parsed TunnelDestGroupName, 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}/destGroups/{dest_group}

TryParse(string, bool, out TunnelDestGroupName)

public static bool TryParse(string tunnelDestGroupName, bool allowUnparsed, out TunnelDestGroupName result)

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

Parameters
NameDescription
tunnelDestGroupNamestring

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.

resultTunnelDestGroupName

When this method returns, the parsed TunnelDestGroupName, 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}/destGroups/{dest_group}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TunnelDestGroupName, TunnelDestGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aTunnelDestGroupName

The first resource name to compare, or null.

bTunnelDestGroupName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TunnelDestGroupName, TunnelDestGroupName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aTunnelDestGroupName

The first resource name to compare, or null.

bTunnelDestGroupName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.