Network Connectivity v1 API - Class HubRouteName (2.5.0)

public sealed class HubRouteName : IResourceName, IEquatable<HubRouteName>

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

Resource name for the HubRoute resource.

Inheritance

object > HubRouteName

Implements

IResourceName, IEquatable HubRouteName

Inherited Members

object.GetType()

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

HubRouteName(string, string, string, string)

public HubRouteName(string projectId, string hubId, string routeTableId, string routeId)

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

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.
`routeId`	`string` The `Route` 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`

RouteId

public string RouteId { get; }

The Route 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 HubRouteName.ResourceNameType Type { get; }

The HubRouteName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`HubRouteNameResourceNameType`

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

public static string Format(string projectId, string hubId, string routeTableId, string routeId)

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

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.
`routeId`	`string` The `Route` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HubRouteName with pattern `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}`.

FormatProjectHubRouteTableRoute(string, string, string, string)

public static string FormatProjectHubRouteTableRoute(string projectId, string hubId, string routeTableId, string routeId)

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

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.
`routeId`	`string` The `Route` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HubRouteName with pattern `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}`.

FromProjectHubRouteTableRoute(string, string, string, string)

public static HubRouteName FromProjectHubRouteTableRoute(string projectId, string hubId, string routeTableId, string routeId)

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

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.
`routeId`	`string` The `Route` ID. Must not be `null` or empty.

Returns
Type	Description
`HubRouteName`	A new instance of HubRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HubRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HubRouteName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`HubRouteName`	A new instance of HubRouteName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static HubRouteName Parse(string hubRouteName)

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

Parameter
Name	Description
`hubRouteName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`HubRouteName`	The parsed HubRouteName 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}/routes/{route}

Parse(string, bool)

public static HubRouteName Parse(string hubRouteName, bool allowUnparsed)

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

Parameters
Name	Description
`hubRouteName`	`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
`HubRouteName`	The parsed HubRouteName 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}/routes/{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

object.ToString()

TryParse(string, out HubRouteName)

public static bool TryParse(string hubRouteName, out HubRouteName result)

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

Parameters
Name	Description
`hubRouteName`	`string` The resource name in string form. Must not be `null`.
`result`	`HubRouteName` When this method returns, the parsed HubRouteName, 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}/routes/{route}

TryParse(string, bool, out HubRouteName)

public static bool TryParse(string hubRouteName, bool allowUnparsed, out HubRouteName result)

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

Parameters
Name	Description
`hubRouteName`	`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`	`HubRouteName` When this method returns, the parsed HubRouteName, 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}/routes/{route}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HubRouteName, HubRouteName)

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

Parameters
Name	Description
`a`	`HubRouteName`
`b`	`HubRouteName`

Returns
Type	Description
`bool`

operator !=(HubRouteName, HubRouteName)

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

Parameters
Name	Description
`a`	`HubRouteName`
`b`	`HubRouteName`

Returns
Type	Description
`bool`