Distributed Cloud Edge Network v1 API - Class RouterName (1.1.0)

public sealed class RouterName : IResourceName, IEquatable<RouterName>

Reference documentation and code samples for the Distributed Cloud Edge Network v1 API class RouterName.

Resource name for the Router resource.

Inheritance

object > RouterName

Namespace

Google.Cloud.EdgeNetwork.V1

Assembly

Google.Cloud.EdgeNetwork.V1.dll

Constructors

RouterName(string, string, string, string)

public RouterName(string projectId, string locationId, string zoneId, string routerId)

Constructs a new instance of a RouterName class from the component parts of pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

zoneIdstring

The Zone ID. Must not be null or empty.

routerIdstring

The Router 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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

RouterId

public string RouterId { get; }

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

Property Value
TypeDescription
string

Type

public RouterName.ResourceNameType Type { get; }

The RouterName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RouterNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

ZoneId

public string ZoneId { get; }

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

Property Value
TypeDescription
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string zoneId, string routerId)

Formats the IDs into the string representation of this RouterName with pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

zoneIdstring

The Zone ID. Must not be null or empty.

routerIdstring

The Router ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RouterName with pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}.

FormatProjectLocationZoneRouter(string, string, string, string)

public static string FormatProjectLocationZoneRouter(string projectId, string locationId, string zoneId, string routerId)

Formats the IDs into the string representation of this RouterName with pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

zoneIdstring

The Zone ID. Must not be null or empty.

routerIdstring

The Router ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RouterName with pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}.

FromProjectLocationZoneRouter(string, string, string, string)

public static RouterName FromProjectLocationZoneRouter(string projectId, string locationId, string zoneId, string routerId)

Creates a RouterName with the pattern projects/{project}/locations/{location}/zones/{zone}/routers/{router}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

zoneIdstring

The Zone ID. Must not be null or empty.

routerIdstring

The Router ID. Must not be null or empty.

Returns
TypeDescription
RouterName

A new instance of RouterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RouterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RouterName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RouterName

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

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

Parameter
NameDescription
routerNamestring

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

Returns
TypeDescription
RouterName

The parsed RouterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/zones/{zone}/routers/{router}

Parse(string, bool)

public static RouterName Parse(string routerName, bool allowUnparsed)

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

Parameters
NameDescription
routerNamestring

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
RouterName

The parsed RouterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/zones/{zone}/routers/{router}
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 RouterName)

public static bool TryParse(string routerName, out RouterName result)

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

Parameters
NameDescription
routerNamestring

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

resultRouterName

When this method returns, the parsed RouterName, 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/{location}/zones/{zone}/routers/{router}

TryParse(string, bool, out RouterName)

public static bool TryParse(string routerName, bool allowUnparsed, out RouterName result)

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

Parameters
NameDescription
routerNamestring

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.

resultRouterName

When this method returns, the parsed RouterName, 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/{location}/zones/{zone}/routers/{router}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RouterName, RouterName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aRouterName

The first resource name to compare, or null.

bRouterName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(RouterName, RouterName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aRouterName

The first resource name to compare, or null.

bRouterName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.