Network Services v1 API - Class TlsRouteName (1.0.0)

public sealed class TlsRouteName : IResourceName, IEquatable<TlsRouteName>

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

Resource name for the TlsRoute resource.

Inheritance

object > TlsRouteName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

TlsRouteName(string, string, string)

public TlsRouteName(string projectId, string locationId, string tlsRouteId)

Constructs a new instance of a TlsRouteName class from the component parts of pattern projects/{project}/locations/{location}/tlsRoutes/{tls_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.

tlsRouteId string

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

TlsRouteId

public string TlsRouteId { get; }

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

Property Value
Type Description
string

Type

public TlsRouteName.ResourceNameType Type { get; }

The TlsRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
TlsRouteNameResourceNameType

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

Formats the IDs into the string representation of this TlsRouteName with pattern projects/{project}/locations/{location}/tlsRoutes/{tls_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.

tlsRouteId string

The TlsRoute ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TlsRouteName with pattern projects/{project}/locations/{location}/tlsRoutes/{tls_route}.

FormatProjectLocationTlsRoute(string, string, string)

public static string FormatProjectLocationTlsRoute(string projectId, string locationId, string tlsRouteId)

Formats the IDs into the string representation of this TlsRouteName with pattern projects/{project}/locations/{location}/tlsRoutes/{tls_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.

tlsRouteId string

The TlsRoute ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TlsRouteName with pattern projects/{project}/locations/{location}/tlsRoutes/{tls_route}.

FromProjectLocationTlsRoute(string, string, string)

public static TlsRouteName FromProjectLocationTlsRoute(string projectId, string locationId, string tlsRouteId)

Creates a TlsRouteName with the pattern projects/{project}/locations/{location}/tlsRoutes/{tls_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.

tlsRouteId string

The TlsRoute ID. Must not be null or empty.

Returns
Type Description
TlsRouteName

A new instance of TlsRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TlsRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TlsRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TlsRouteName

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

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

Parameter
Name Description
tlsRouteName string

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

Returns
Type Description
TlsRouteName

The parsed TlsRouteName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tlsRoutes/{tls_route}

Parse(string, bool)

public static TlsRouteName Parse(string tlsRouteName, bool allowUnparsed)

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

Parameters
Name Description
tlsRouteName 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
TlsRouteName

The parsed TlsRouteName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tlsRoutes/{tls_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 TlsRouteName)

public static bool TryParse(string tlsRouteName, out TlsRouteName result)

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

Parameters
Name Description
tlsRouteName string

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

result TlsRouteName

When this method returns, the parsed TlsRouteName, 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}/tlsRoutes/{tls_route}

TryParse(string, bool, out TlsRouteName)

public static bool TryParse(string tlsRouteName, bool allowUnparsed, out TlsRouteName result)

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

Parameters
Name Description
tlsRouteName 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 TlsRouteName

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

Operators

operator ==(TlsRouteName, TlsRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TlsRouteName

The first resource name to compare, or null.

b TlsRouteName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TlsRouteName

The first resource name to compare, or null.

b TlsRouteName

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.