Network Services v1 API - Class TargetTcpProxyName (1.6.0) 

public sealed class TargetTcpProxyName : IResourceName, IEquatable<TargetTcpProxyName>

Reference documentation and code samples for the Network Services v1 API class TargetTcpProxyName.

Resource name for the TargetTcpProxy resource.

Inheritance

object > TargetTcpProxyName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

TargetTcpProxyName(string, string, string)

public TargetTcpProxyName(string projectId, string locationId, string targetTcpProxyId)

Constructs a new instance of a TargetTcpProxyName class from the component parts of pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}

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.
targetTcpProxyId string

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

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

TargetTcpProxyId

public string TargetTcpProxyId { get; }

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

Property Value
Type Description
string

Type

public TargetTcpProxyName.ResourceNameType Type { get; }

The TargetTcpProxyName.ResourceNameType of the contained resource name.

Property Value
Type Description
TargetTcpProxyNameResourceNameType

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

Formats the IDs into the string representation of this TargetTcpProxyName with pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}.

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.
targetTcpProxyId string

The TargetTcpProxy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TargetTcpProxyName with pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}.

FormatProjectLocationTargetTcpProxy(string, string, string)

public static string FormatProjectLocationTargetTcpProxy(string projectId, string locationId, string targetTcpProxyId)

Formats the IDs into the string representation of this TargetTcpProxyName with pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}.

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.
targetTcpProxyId string

The TargetTcpProxy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TargetTcpProxyName with pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}.

FromProjectLocationTargetTcpProxy(string, string, string)

public static TargetTcpProxyName FromProjectLocationTargetTcpProxy(string projectId, string locationId, string targetTcpProxyId)

Creates a TargetTcpProxyName with the pattern projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}.

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.
targetTcpProxyId string

The TargetTcpProxy ID. Must not be null or empty.
Returns
Type Description
TargetTcpProxyName

A new instance of TargetTcpProxyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TargetTcpProxyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TargetTcpProxyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
targetTcpProxyName string

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

The parsed TargetTcpProxyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}

Parse(string, bool)

public static TargetTcpProxyName Parse(string targetTcpProxyName, bool allowUnparsed)

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

Parameters
Name Description
targetTcpProxyName 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
TargetTcpProxyName

The parsed TargetTcpProxyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/targetTcpProxies/{target_tcp_proxy}

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 TargetTcpProxyName)

public static bool TryParse(string targetTcpProxyName, out TargetTcpProxyName result)

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

Parameters
Name Description
targetTcpProxyName string

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

When this method returns, the parsed TargetTcpProxyName, 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}/locations/{location}/targetTcpProxies/{target_tcp_proxy}

TryParse(string, bool, out TargetTcpProxyName)

public static bool TryParse(string targetTcpProxyName, bool allowUnparsed, out TargetTcpProxyName result)

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

Parameters
Name Description
targetTcpProxyName 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 TargetTcpProxyName

When this method returns, the parsed TargetTcpProxyName, 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}/locations/{location}/targetTcpProxies/{target_tcp_proxy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TargetTcpProxyName, TargetTcpProxyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TargetTcpProxyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TargetTcpProxyName

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

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.