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.
Namespace
Google.Cloud.EdgeNetwork.V1Assembly
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
zoneId | string The |
routerId | string The |
Properties
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 |
RouterId
public string RouterId { get; }
The Router
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public RouterName.ResourceNameType Type { get; }
The RouterName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
RouterNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
UnparsedResourceName |
ZoneId
public string ZoneId { get; }
The Zone
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
zoneId | string The |
routerId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RouterName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
zoneId | string The |
routerId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this RouterName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
zoneId | string The |
routerId | string The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
RouterName | A new instance of RouterName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static RouterName Parse(string routerName)
Parses the given resource name string into a new RouterName instance.
Parameter | |
---|---|
Name | Description |
routerName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
RouterName | The parsed RouterName if successful. |
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 | |
---|---|
Name | Description |
routerName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
RouterName | The parsed RouterName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/zones/{zone}/routers/{router}
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. |
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 | |
---|---|
Name | Description |
routerName | string The resource name in string form. Must not be |
result | RouterName When this method returns, the parsed RouterName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 | |
---|---|
Name | Description |
routerName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | RouterName When this method returns, the parsed RouterName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/zones/{zone}/routers/{router}
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 | |
---|---|
Name | Description |
a | RouterName The first resource name to compare, or null. |
b | RouterName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |
operator !=(RouterName, RouterName)
public static bool operator !=(RouterName a, RouterName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a | RouterName The first resource name to compare, or null. |
b | RouterName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |