Network Connectivity v1 API - Class RouteTableName (2.5.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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

hubIdstring

The Hub ID. Must not be null or empty.

routeTableIdstring

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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

RouteTableId

public string RouteTableId { get; }

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

Property Value
TypeDescription
string

Type

public RouteTableName.ResourceNameType Type { get; }

The RouteTableName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RouteTableNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

hubIdstring

The Hub ID. Must not be null or empty.

routeTableIdstring

The RouteTable ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

hubIdstring

The Hub ID. Must not be null or empty.

routeTableIdstring

The RouteTable ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

hubIdstring

The Hub ID. Must not be null or empty.

routeTableIdstring

The RouteTable ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RouteTableName

A new instance of RouteTableName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static RouteTableName Parse(string routeTableName)

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

Parameter
NameDescription
routeTableNamestring

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

Returns
TypeDescription
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
NameDescription
routeTableNamestring

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

allowUnparsedbool

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
TypeDescription
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
TypeDescription
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
NameDescription
routeTableNamestring

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

resultRouteTableName

When this method returns, the parsed RouteTableName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
routeTableNamestring

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

allowUnparsedbool

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.

resultRouteTableName

When this method returns, the parsed RouteTableName, or null if parsing failed.

Returns
TypeDescription
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)
Parameters
NameDescription
aRouteTableName
bRouteTableName
Returns
TypeDescription
bool

operator !=(RouteTableName, RouteTableName)

public static bool operator !=(RouteTableName a, RouteTableName b)
Parameters
NameDescription
aRouteTableName
bRouteTableName
Returns
TypeDescription
bool