Network Services v1 API - Class HttpRouteName (1.5.0) 

public sealed class HttpRouteName : IResourceName, IEquatable<HttpRouteName>

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

Resource name for the HttpRoute resource.

Inheritance

object > HttpRouteName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

HttpRouteName(string, string, string)

public HttpRouteName(string projectId, string locationId, string httpRouteId)

Constructs a new instance of a HttpRouteName class from the component parts of pattern projects/{project}/locations/{location}/httpRoutes/{http_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.
httpRouteId string

The HttpRoute ID. Must not be null or empty.

Properties

HttpRouteId

public string HttpRouteId { get; }

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

Property Value
Type Description
string

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

Type

public HttpRouteName.ResourceNameType Type { get; }

The HttpRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
HttpRouteNameResourceNameType

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

Formats the IDs into the string representation of this HttpRouteName with pattern projects/{project}/locations/{location}/httpRoutes/{http_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.
httpRouteId string

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

The string representation of this HttpRouteName with pattern projects/{project}/locations/{location}/httpRoutes/{http_route}.

FormatProjectLocationHttpRoute(string, string, string)

public static string FormatProjectLocationHttpRoute(string projectId, string locationId, string httpRouteId)

Formats the IDs into the string representation of this HttpRouteName with pattern projects/{project}/locations/{location}/httpRoutes/{http_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.
httpRouteId string

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

The string representation of this HttpRouteName with pattern projects/{project}/locations/{location}/httpRoutes/{http_route}.

FromProjectLocationHttpRoute(string, string, string)

public static HttpRouteName FromProjectLocationHttpRoute(string projectId, string locationId, string httpRouteId)

Creates a HttpRouteName with the pattern projects/{project}/locations/{location}/httpRoutes/{http_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.
httpRouteId string

The HttpRoute ID. Must not be null or empty.
Returns
Type Description
HttpRouteName

A new instance of HttpRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HttpRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HttpRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
httpRouteName string

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

The parsed HttpRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/httpRoutes/{http_route}

Parse(string, bool)

public static HttpRouteName Parse(string httpRouteName, bool allowUnparsed)

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

Parameters
Name Description
httpRouteName 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
HttpRouteName

The parsed HttpRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/httpRoutes/{http_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 HttpRouteName)

public static bool TryParse(string httpRouteName, out HttpRouteName result)

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

Parameters
Name Description
httpRouteName string

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

When this method returns, the parsed HttpRouteName, 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}/httpRoutes/{http_route}

TryParse(string, bool, out HttpRouteName)

public static bool TryParse(string httpRouteName, bool allowUnparsed, out HttpRouteName result)

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

Parameters
Name Description
httpRouteName 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 HttpRouteName

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

Operators

operator ==(HttpRouteName, HttpRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a HttpRouteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a HttpRouteName

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

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.