Network Services v1 API - Class TcpRouteName (1.5.0) 

public sealed class TcpRouteName : IResourceName, IEquatable<TcpRouteName>

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

Resource name for the TcpRoute resource.

Inheritance

object > TcpRouteName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

TcpRouteName(string, string, string)

public TcpRouteName(string projectId, string locationId, string tcpRouteId)

Constructs a new instance of a TcpRouteName class from the component parts of pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}

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

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

TcpRouteId

public string TcpRouteId { get; }

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

Property Value
Type Description
string

Type

public TcpRouteName.ResourceNameType Type { get; }

The TcpRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
TcpRouteNameResourceNameType

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

Formats the IDs into the string representation of this TcpRouteName with pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}.

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

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

The string representation of this TcpRouteName with pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}.

FormatProjectLocationTcpRoute(string, string, string)

public static string FormatProjectLocationTcpRoute(string projectId, string locationId, string tcpRouteId)

Formats the IDs into the string representation of this TcpRouteName with pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}.

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

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

The string representation of this TcpRouteName with pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}.

FromProjectLocationTcpRoute(string, string, string)

public static TcpRouteName FromProjectLocationTcpRoute(string projectId, string locationId, string tcpRouteId)

Creates a TcpRouteName with the pattern projects/{project}/locations/{location}/tcpRoutes/{tcp_route}.

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

The TcpRoute ID. Must not be null or empty.
Returns
Type Description
TcpRouteName

A new instance of TcpRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TcpRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TcpRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
tcpRouteName string

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

The parsed TcpRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tcpRoutes/{tcp_route}

Parse(string, bool)

public static TcpRouteName Parse(string tcpRouteName, bool allowUnparsed)

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

Parameters
Name Description
tcpRouteName 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
TcpRouteName

The parsed TcpRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tcpRoutes/{tcp_route}
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 TcpRouteName)

public static bool TryParse(string tcpRouteName, out TcpRouteName result)

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

Parameters
Name Description
tcpRouteName string

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

When this method returns, the parsed TcpRouteName, 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}/tcpRoutes/{tcp_route}

TryParse(string, bool, out TcpRouteName)

public static bool TryParse(string tcpRouteName, bool allowUnparsed, out TcpRouteName result)

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

Parameters
Name Description
tcpRouteName 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 TcpRouteName

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

Operators

operator ==(TcpRouteName, TcpRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TcpRouteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TcpRouteName

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

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.