Network Connectivity v1 API - Class PolicyBasedRouteName (2.11.0) 

public sealed class PolicyBasedRouteName : IResourceName, IEquatable<PolicyBasedRouteName>

Reference documentation and code samples for the Network Connectivity v1 API class PolicyBasedRouteName.

Resource name for the PolicyBasedRoute resource.

Inheritance

object > PolicyBasedRouteName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

PolicyBasedRouteName(string, string)

public PolicyBasedRouteName(string projectId, string policyBasedRouteId)

Constructs a new instance of a PolicyBasedRouteName class from the component parts of pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}

Parameters
Name Description
projectId string

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

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

PolicyBasedRouteId

public string PolicyBasedRouteId { get; }

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

The PolicyBasedRouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
PolicyBasedRouteNameResourceNameType

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)

public static string Format(string projectId, string policyBasedRouteId)

Formats the IDs into the string representation of this PolicyBasedRouteName with pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

Parameters
Name Description
projectId string

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

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

The string representation of this PolicyBasedRouteName with pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

FormatProjectPolicyBasedRoute(string, string)

public static string FormatProjectPolicyBasedRoute(string projectId, string policyBasedRouteId)

Formats the IDs into the string representation of this PolicyBasedRouteName with pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

Parameters
Name Description
projectId string

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

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

The string representation of this PolicyBasedRouteName with pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

FromProjectPolicyBasedRoute(string, string)

public static PolicyBasedRouteName FromProjectPolicyBasedRoute(string projectId, string policyBasedRouteId)

Creates a PolicyBasedRouteName with the pattern projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

Parameters
Name Description
projectId string

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

The PolicyBasedRoute ID. Must not be null or empty.
Returns
Type Description
PolicyBasedRouteName

A new instance of PolicyBasedRouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PolicyBasedRouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PolicyBasedRouteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
policyBasedRouteName string

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

The parsed PolicyBasedRouteName if successful.
Remarks

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

  • projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}

Parse(string, bool)

public static PolicyBasedRouteName Parse(string policyBasedRouteName, bool allowUnparsed)

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

Parameters
Name Description
policyBasedRouteName 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
PolicyBasedRouteName

The parsed PolicyBasedRouteName if successful.
Remarks

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

  • projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_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 PolicyBasedRouteName)

public static bool TryParse(string policyBasedRouteName, out PolicyBasedRouteName result)

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

Parameters
Name Description
policyBasedRouteName string

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

When this method returns, the parsed PolicyBasedRouteName, 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/global/PolicyBasedRoutes/{policy_based_route}

TryParse(string, bool, out PolicyBasedRouteName)

public static bool TryParse(string policyBasedRouteName, bool allowUnparsed, out PolicyBasedRouteName result)

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

Parameters
Name Description
policyBasedRouteName 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 PolicyBasedRouteName

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

Operators

operator ==(PolicyBasedRouteName, PolicyBasedRouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PolicyBasedRouteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PolicyBasedRouteName

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

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.