Network Services v1 API - Class GrpcRouteName (1.5.0) 

public sealed class GrpcRouteName : IResourceName, IEquatable<GrpcRouteName>

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

Resource name for the GrpcRoute resource.

Inheritance

object > GrpcRouteName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

GrpcRouteName(string, string, string)

public GrpcRouteName(string projectId, string locationId, string grpcRouteId)

Constructs a new instance of a GrpcRouteName class from the component parts of pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_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.
grpcRouteId string

The GrpcRoute ID. Must not be null or empty.

Properties

GrpcRouteId

public string GrpcRouteId { get; }

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

Type

public GrpcRouteName.ResourceNameType Type { get; }

The GrpcRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
GrpcRouteNameResourceNameType

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)

public static string Format(string projectId, string locationId, string grpcRouteId)

Formats the IDs into the string representation of this GrpcRouteName with pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_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.
grpcRouteId string

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

The string representation of this GrpcRouteName with pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_route}.

FormatProjectLocationGrpcRoute(string, string, string)

public static string FormatProjectLocationGrpcRoute(string projectId, string locationId, string grpcRouteId)

Formats the IDs into the string representation of this GrpcRouteName with pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_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.
grpcRouteId string

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

The string representation of this GrpcRouteName with pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_route}.

FromProjectLocationGrpcRoute(string, string, string)

public static GrpcRouteName FromProjectLocationGrpcRoute(string projectId, string locationId, string grpcRouteId)

Creates a GrpcRouteName with the pattern projects/{project}/locations/{location}/grpcRoutes/{grpc_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.
grpcRouteId string

The GrpcRoute ID. Must not be null or empty.
Returns
Type Description
GrpcRouteName

A new instance of GrpcRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GrpcRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GrpcRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
grpcRouteName string

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

The parsed GrpcRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/grpcRoutes/{grpc_route}

Parse(string, bool)

public static GrpcRouteName Parse(string grpcRouteName, bool allowUnparsed)

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

Parameters
Name Description
grpcRouteName 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
GrpcRouteName

The parsed GrpcRouteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/grpcRoutes/{grpc_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 GrpcRouteName)

public static bool TryParse(string grpcRouteName, out GrpcRouteName result)

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

Parameters
Name Description
grpcRouteName string

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

When this method returns, the parsed GrpcRouteName, 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}/grpcRoutes/{grpc_route}

TryParse(string, bool, out GrpcRouteName)

public static bool TryParse(string grpcRouteName, bool allowUnparsed, out GrpcRouteName result)

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

Parameters
Name Description
grpcRouteName 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 GrpcRouteName

When this method returns, the parsed GrpcRouteName, 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}/grpcRoutes/{grpc_route}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GrpcRouteName, GrpcRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GrpcRouteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GrpcRouteName

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

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.