Network Connectivity v1 API - Class RouteTableName (2.8.0)

public sealed class RouteTableName : IResourceName, IEquatable<RouteTableName>

Reference documentation and code samples for the Network Connectivity v1 API class RouteTableName.

Resource name for the RouteTable resource.

Inheritance

object > RouteTableName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

RouteTableName(string, string, string)

public RouteTableName(string projectId, string hubId, string routeTableId)

Constructs a new instance of a RouteTableName class from the component parts of pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

hubId string

The Hub ID. Must not be null or empty.

routeTableId string

The RouteTable ID. Must not be null or empty.

Properties

HubId

public string HubId { get; }

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

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

RouteTableId

public string RouteTableId { get; }

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

Property Value
Type Description
string

Type

public RouteTableName.ResourceNameType Type { get; }

The RouteTableName.ResourceNameType of the contained resource name.

Property Value
Type Description
RouteTableNameResourceNameType

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

Formats the IDs into the string representation of this RouteTableName with pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

hubId string

The Hub ID. Must not be null or empty.

routeTableId string

The RouteTable ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RouteTableName with pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}.

FormatProjectHubRouteTable(string, string, string)

public static string FormatProjectHubRouteTable(string projectId, string hubId, string routeTableId)

Formats the IDs into the string representation of this RouteTableName with pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

hubId string

The Hub ID. Must not be null or empty.

routeTableId string

The RouteTable ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RouteTableName with pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}.

FromProjectHubRouteTable(string, string, string)

public static RouteTableName FromProjectHubRouteTable(string projectId, string hubId, string routeTableId)

Creates a RouteTableName with the pattern projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

hubId string

The Hub ID. Must not be null or empty.

routeTableId string

The RouteTable ID. Must not be null or empty.

Returns
Type Description
RouteTableName

A new instance of RouteTableName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RouteTableName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RouteTableName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
RouteTableName

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

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

Parameter
Name Description
routeTableName string

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

Returns
Type Description
RouteTableName

The parsed RouteTableName if successful.

Remarks

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

  • projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}

Parse(string, bool)

public static RouteTableName Parse(string routeTableName, bool allowUnparsed)

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

Parameters
Name Description
routeTableName 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
RouteTableName

The parsed RouteTableName if successful.

Remarks

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

  • projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}
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 RouteTableName)

public static bool TryParse(string routeTableName, out RouteTableName result)

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

Parameters
Name Description
routeTableName string

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

result RouteTableName

When this method returns, the parsed RouteTableName, 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/global/hubs/{hub}/routeTables/{route_table}

TryParse(string, bool, out RouteTableName)

public static bool TryParse(string routeTableName, bool allowUnparsed, out RouteTableName result)

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

Parameters
Name Description
routeTableName 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 RouteTableName

When this method returns, the parsed RouteTableName, 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/global/hubs/{hub}/routeTables/{route_table}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RouteTableName, RouteTableName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RouteTableName

The first resource name to compare, or null.

b RouteTableName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RouteTableName

The first resource name to compare, or null.

b RouteTableName

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.