Google Cloud Memorystore for Redis (cluster management) v1 API - Class ForwardingRuleName (1.4.0) 

public sealed class ForwardingRuleName : IResourceName, IEquatable<ForwardingRuleName>

Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class ForwardingRuleName.

Resource name for the ForwardingRule resource.

Inheritance

object > ForwardingRuleName

Namespace

Google.Cloud.Redis.Cluster.V1

Assembly

Google.Cloud.Redis.Cluster.V1.dll

Constructors

ForwardingRuleName(string, string, string)

public ForwardingRuleName(string projectId, string regionId, string forwardingRuleId)

Constructs a new instance of a ForwardingRuleName class from the component parts of pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
forwardingRuleId string

The ForwardingRule ID. Must not be null or empty.

Properties

ForwardingRuleId

public string ForwardingRuleId { get; }

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

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

RegionId

public string RegionId { get; }

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

Property Value
Type Description
string

Type

public ForwardingRuleName.ResourceNameType Type { get; }

The ForwardingRuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
ForwardingRuleNameResourceNameType

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 regionId, string forwardingRuleId)

Formats the IDs into the string representation of this ForwardingRuleName with pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
forwardingRuleId string

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

The string representation of this ForwardingRuleName with pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}.

FormatProjectRegionForwardingRule(string, string, string)

public static string FormatProjectRegionForwardingRule(string projectId, string regionId, string forwardingRuleId)

Formats the IDs into the string representation of this ForwardingRuleName with pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
forwardingRuleId string

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

The string representation of this ForwardingRuleName with pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}.

FromProjectRegionForwardingRule(string, string, string)

public static ForwardingRuleName FromProjectRegionForwardingRule(string projectId, string regionId, string forwardingRuleId)

Creates a ForwardingRuleName with the pattern projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
forwardingRuleId string

The ForwardingRule ID. Must not be null or empty.
Returns
Type Description
ForwardingRuleName

A new instance of ForwardingRuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ForwardingRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ForwardingRuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
forwardingRuleName string

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

The parsed ForwardingRuleName if successful.
Remarks

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

  • projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}

Parse(string, bool)

public static ForwardingRuleName Parse(string forwardingRuleName, bool allowUnparsed)

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

Parameters
Name Description
forwardingRuleName 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
ForwardingRuleName

The parsed ForwardingRuleName if successful.
Remarks

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

  • projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
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 ForwardingRuleName)

public static bool TryParse(string forwardingRuleName, out ForwardingRuleName result)

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

Parameters
Name Description
forwardingRuleName string

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

When this method returns, the parsed ForwardingRuleName, 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}/regions/{region}/forwardingRules/{forwarding_rule}

TryParse(string, bool, out ForwardingRuleName)

public static bool TryParse(string forwardingRuleName, bool allowUnparsed, out ForwardingRuleName result)

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

Parameters
Name Description
forwardingRuleName 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 ForwardingRuleName

When this method returns, the parsed ForwardingRuleName, 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}/regions/{region}/forwardingRules/{forwarding_rule}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ForwardingRuleName, ForwardingRuleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ForwardingRuleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ForwardingRuleName

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

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.