Network Connectivity v1beta API - Class GatewayAdvertisedRouteName (1.0.0-beta01) 

public sealed class GatewayAdvertisedRouteName : IResourceName, IEquatable<GatewayAdvertisedRouteName>

Reference documentation and code samples for the Network Connectivity v1beta API class GatewayAdvertisedRouteName.

Resource name for the GatewayAdvertisedRoute resource.

Inheritance

object > GatewayAdvertisedRouteName

Namespace

Google.Cloud.NetworkConnectivity.V1Beta

Assembly

Google.Cloud.NetworkConnectivity.V1Beta.dll

Constructors

GatewayAdvertisedRouteName(string, string, string, string)

public GatewayAdvertisedRouteName(string projectId, string locationId, string spokeId, string gatewayAdvertisedRouteId)

Constructs a new instance of a GatewayAdvertisedRouteName class from the component parts of pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
spokeId string

The Spoke ID. Must not be null or empty.
gatewayAdvertisedRouteId string

The GatewayAdvertisedRoute ID. Must not be null or empty.

Properties

GatewayAdvertisedRouteId

public string GatewayAdvertisedRouteId { get; }

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

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

SpokeId

public string SpokeId { get; }

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

Property Value
Type Description
string

Type

public GatewayAdvertisedRouteName.ResourceNameType Type { get; }

The GatewayAdvertisedRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
GatewayAdvertisedRouteNameResourceNameType

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 locationId, string spokeId, string gatewayAdvertisedRouteId)

Formats the IDs into the string representation of this GatewayAdvertisedRouteName with pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
spokeId string

The Spoke ID. Must not be null or empty.
gatewayAdvertisedRouteId string

The GatewayAdvertisedRoute ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this GatewayAdvertisedRouteName with pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route} .

FormatProjectLocationSpokeGatewayAdvertisedRoute(string, string, string, string)

public static string FormatProjectLocationSpokeGatewayAdvertisedRoute(string projectId, string locationId, string spokeId, string gatewayAdvertisedRouteId)

Formats the IDs into the string representation of this GatewayAdvertisedRouteName with pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
spokeId string

The Spoke ID. Must not be null or empty.
gatewayAdvertisedRouteId string

The GatewayAdvertisedRoute ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this GatewayAdvertisedRouteName with pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route} .

FromProjectLocationSpokeGatewayAdvertisedRoute(string, string, string, string)

public static GatewayAdvertisedRouteName FromProjectLocationSpokeGatewayAdvertisedRoute(string projectId, string locationId, string spokeId, string gatewayAdvertisedRouteId)

Creates a GatewayAdvertisedRouteName with the pattern projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
spokeId string

The Spoke ID. Must not be null or empty.
gatewayAdvertisedRouteId string

The GatewayAdvertisedRoute ID. Must not be null or empty.
Returns
Type Description
GatewayAdvertisedRouteName

A new instance of GatewayAdvertisedRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GatewayAdvertisedRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GatewayAdvertisedRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
GatewayAdvertisedRouteName

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

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

Parameter
Name Description
gatewayAdvertisedRouteName string

The resource name in string form. Must not be null.
Returns
Type Description
GatewayAdvertisedRouteName

The parsed GatewayAdvertisedRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route}

Parse(string, bool)

public static GatewayAdvertisedRouteName Parse(string gatewayAdvertisedRouteName, bool allowUnparsed)

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

Parameters
Name Description
gatewayAdvertisedRouteName 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
GatewayAdvertisedRouteName

The parsed GatewayAdvertisedRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_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

TryParse(string, out GatewayAdvertisedRouteName)

public static bool TryParse(string gatewayAdvertisedRouteName, out GatewayAdvertisedRouteName result)

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

Parameters
Name Description
gatewayAdvertisedRouteName string

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

When this method returns, the parsed GatewayAdvertisedRouteName, 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/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route}

TryParse(string, bool, out GatewayAdvertisedRouteName)

public static bool TryParse(string gatewayAdvertisedRouteName, bool allowUnparsed, out GatewayAdvertisedRouteName result)

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

Parameters
Name Description
gatewayAdvertisedRouteName 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 GatewayAdvertisedRouteName

When this method returns, the parsed GatewayAdvertisedRouteName, 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/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GatewayAdvertisedRouteName, GatewayAdvertisedRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GatewayAdvertisedRouteName

The first resource name to compare, or null.
b GatewayAdvertisedRouteName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GatewayAdvertisedRouteName

The first resource name to compare, or null.
b GatewayAdvertisedRouteName

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.