Network Services v1 API - Class MeshRouteViewName (1.1.0)

public sealed class MeshRouteViewName : IResourceName, IEquatable<MeshRouteViewName>

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

Resource name for the MeshRouteView resource.

Inheritance

object > MeshRouteViewName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

MeshRouteViewName(string, string, string, string)

public MeshRouteViewName(string projectId, string locationId, string meshId, string routeViewId)

Constructs a new instance of a MeshRouteViewName class from the component parts of pattern projects/{project}/locations/{location}/meshes/{mesh}/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.

meshId string

The Mesh ID. Must not be null or empty.

routeViewId string

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

MeshId

public string MeshId { get; }

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

The MeshRouteViewName.ResourceNameType of the contained resource name.

Property Value
Type Description
MeshRouteViewNameResourceNameType

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

Formats the IDs into the string representation of this MeshRouteViewName with pattern projects/{project}/locations/{location}/meshes/{mesh}/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.

meshId string

The Mesh 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 MeshRouteViewName with pattern projects/{project}/locations/{location}/meshes/{mesh}/routeViews/{route_view}.

FormatProjectLocationMeshRouteView(string, string, string, string)

public static string FormatProjectLocationMeshRouteView(string projectId, string locationId, string meshId, string routeViewId)

Formats the IDs into the string representation of this MeshRouteViewName with pattern projects/{project}/locations/{location}/meshes/{mesh}/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.

meshId string

The Mesh 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 MeshRouteViewName with pattern projects/{project}/locations/{location}/meshes/{mesh}/routeViews/{route_view}.

FromProjectLocationMeshRouteView(string, string, string, string)

public static MeshRouteViewName FromProjectLocationMeshRouteView(string projectId, string locationId, string meshId, string routeViewId)

Creates a MeshRouteViewName with the pattern projects/{project}/locations/{location}/meshes/{mesh}/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.

meshId string

The Mesh ID. Must not be null or empty.

routeViewId string

The RouteView ID. Must not be null or empty.

Returns
Type Description
MeshRouteViewName

A new instance of MeshRouteViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MeshRouteViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MeshRouteViewName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
MeshRouteViewName

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

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

Parameter
Name Description
meshRouteViewName string

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

Returns
Type Description
MeshRouteViewName

The parsed MeshRouteViewName if successful.

Remarks

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

  • projects/{project}/locations/{location}/meshes/{mesh}/routeViews/{route_view}

Parse(string, bool)

public static MeshRouteViewName Parse(string meshRouteViewName, bool allowUnparsed)

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

Parameters
Name Description
meshRouteViewName 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
MeshRouteViewName

The parsed MeshRouteViewName if successful.

Remarks

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

  • projects/{project}/locations/{location}/meshes/{mesh}/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 MeshRouteViewName)

public static bool TryParse(string meshRouteViewName, out MeshRouteViewName result)

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

Parameters
Name Description
meshRouteViewName string

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

result MeshRouteViewName

When this method returns, the parsed MeshRouteViewName, 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}/meshes/{mesh}/routeViews/{route_view}

TryParse(string, bool, out MeshRouteViewName)

public static bool TryParse(string meshRouteViewName, bool allowUnparsed, out MeshRouteViewName result)

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

Parameters
Name Description
meshRouteViewName 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 MeshRouteViewName

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

Operators

operator ==(MeshRouteViewName, MeshRouteViewName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MeshRouteViewName

The first resource name to compare, or null.

b MeshRouteViewName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MeshRouteViewName

The first resource name to compare, or null.

b MeshRouteViewName

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.