Network Services v1 API - Class GatewayRouteViewName (1.5.0) 

public sealed class GatewayRouteViewName : IResourceName, IEquatable<GatewayRouteViewName>

Reference documentation and code samples for the Network Services v1 API class GatewayRouteViewName.

Resource name for the GatewayRouteView resource.

Inheritance

object > GatewayRouteViewName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

GatewayRouteViewName(string, string, string, string)

public GatewayRouteViewName(string projectId, string locationId, string gatewayId, string routeViewId)

Constructs a new instance of a GatewayRouteViewName class from the component parts of pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}

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.
gatewayId string

The Gateway ID. Must not be null or empty.
routeViewId string

The RouteView ID. Must not be null or empty.

Properties

GatewayId

public string GatewayId { get; }

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

RouteViewId

public string RouteViewId { get; }

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

Property Value
Type Description
string

Type

public GatewayRouteViewName.ResourceNameType Type { get; }

The GatewayRouteViewName.ResourceNameType of the contained resource name.

Property Value
Type Description
GatewayRouteViewNameResourceNameType

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

Formats the IDs into the string representation of this GatewayRouteViewName with pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}.

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.
gatewayId string

The Gateway ID. Must not be null or empty.
routeViewId string

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

The string representation of this GatewayRouteViewName with pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}.

FormatProjectLocationGatewayRouteView(string, string, string, string)

public static string FormatProjectLocationGatewayRouteView(string projectId, string locationId, string gatewayId, string routeViewId)

Formats the IDs into the string representation of this GatewayRouteViewName with pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}.

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.
gatewayId string

The Gateway ID. Must not be null or empty.
routeViewId string

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

The string representation of this GatewayRouteViewName with pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}.

FromProjectLocationGatewayRouteView(string, string, string, string)

public static GatewayRouteViewName FromProjectLocationGatewayRouteView(string projectId, string locationId, string gatewayId, string routeViewId)

Creates a GatewayRouteViewName with the pattern projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}.

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.
gatewayId string

The Gateway ID. Must not be null or empty.
routeViewId string

The RouteView ID. Must not be null or empty.
Returns
Type Description
GatewayRouteViewName

A new instance of GatewayRouteViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GatewayRouteViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GatewayRouteViewName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
gatewayRouteViewName string

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

The parsed GatewayRouteViewName if successful.
Remarks

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

  • projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}

Parse(string, bool)

public static GatewayRouteViewName Parse(string gatewayRouteViewName, bool allowUnparsed)

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

Parameters
Name Description
gatewayRouteViewName 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
GatewayRouteViewName

The parsed GatewayRouteViewName if successful.
Remarks

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

  • projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}
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 GatewayRouteViewName)

public static bool TryParse(string gatewayRouteViewName, out GatewayRouteViewName result)

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

Parameters
Name Description
gatewayRouteViewName string

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

When this method returns, the parsed GatewayRouteViewName, 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}/gateways/{gateway}/routeViews/{route_view}

TryParse(string, bool, out GatewayRouteViewName)

public static bool TryParse(string gatewayRouteViewName, bool allowUnparsed, out GatewayRouteViewName result)

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

Parameters
Name Description
gatewayRouteViewName 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 GatewayRouteViewName

When this method returns, the parsed GatewayRouteViewName, 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}/gateways/{gateway}/routeViews/{route_view}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GatewayRouteViewName, GatewayRouteViewName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GatewayRouteViewName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GatewayRouteViewName

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

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.