Google Cloud reCAPTCHA Enterprise v1 API - Class PolicyName (2.21.0)

2.21.0 (latest) 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0

public sealed class PolicyName : IResourceName, IEquatable<PolicyName>

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class PolicyName.

Resource name for the Policy resource.

Inheritance

object > PolicyName

Implements

IResourceName, IEquatablePolicyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

PolicyName(string, string)

public PolicyName(string projectId, string keyId)

Constructs a new instance of a PolicyName class from the component parts of pattern projects/{project}/keys/{key}/policy

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
keyId	string The Key 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

KeyId

public string KeyId { get; }

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

The PolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
PolicyNameResourceNameType

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 keyId)

Formats the IDs into the string representation of this PolicyName with pattern projects/{project}/keys/{key}/policy.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
keyId	string The Key ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PolicyName with pattern projects/{project}/keys/{key}/policy.

FormatProjectKey(string, string)

public static string FormatProjectKey(string projectId, string keyId)

Formats the IDs into the string representation of this PolicyName with pattern projects/{project}/keys/{key}/policy.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
keyId	string The Key ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PolicyName with pattern projects/{project}/keys/{key}/policy.

FromProjectKey(string, string)

public static PolicyName FromProjectKey(string projectId, string keyId)

Creates a PolicyName with the pattern projects/{project}/keys/{key}/policy.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
keyId	string The Key ID. Must not be null or empty.

Returns
Type	Description
PolicyName	A new instance of PolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PolicyName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
PolicyName	A new instance of PolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static PolicyName Parse(string policyName)

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

Parameter
Name	Description
policyName	string The resource name in string form. Must not be null.

Returns
Type	Description
PolicyName	The parsed PolicyName if successful.

Remarks

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

• projects/{project}/keys/{key}/policy

Parse(string, bool)

public static PolicyName Parse(string policyName, bool allowUnparsed)

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

Parameters
Name	Description
policyName	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
PolicyName	The parsed PolicyName if successful.

Remarks

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

• projects/{project}/keys/{key}/policy

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

object.ToString()

TryParse(string, out PolicyName)

public static bool TryParse(string policyName, out PolicyName result)

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

Parameters
Name	Description
policyName	string The resource name in string form. Must not be null.
result	PolicyName When this method returns, the parsed PolicyName, 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}/keys/{key}/policy

TryParse(string, bool, out PolicyName)

public static bool TryParse(string policyName, bool allowUnparsed, out PolicyName result)

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

Parameters
Name	Description
policyName	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	PolicyName When this method returns, the parsed PolicyName, 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}/keys/{key}/policy

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PolicyName, PolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	PolicyName The first resource name to compare, or null.
b	PolicyName 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 !=(PolicyName, PolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	PolicyName The first resource name to compare, or null.
b	PolicyName 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.