Google Cloud reCAPTCHA Enterprise v1 API - Class FirewallPolicyName (2.16.0)

public sealed class FirewallPolicyName : IResourceName, IEquatable<FirewallPolicyName>

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

Resource name for the FirewallPolicy resource.

Inheritance

object > FirewallPolicyName

Implements

IResourceName, IEquatable FirewallPolicyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

FirewallPolicyName(string, string)

public FirewallPolicyName(string projectId, string firewallpolicyId)

Constructs a new instance of a FirewallPolicyName class from the component parts of pattern projects/{project}/firewallpolicies/{firewallpolicy}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`firewallpolicyId`	`string` The `Firewallpolicy` ID. Must not be `null` or empty.

Properties

FirewallpolicyId

public string FirewallpolicyId { get; }

The Firewallpolicy 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`

Type

public FirewallPolicyName.ResourceNameType Type { get; }

The FirewallPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FirewallPolicyNameResourceNameType`

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

Formats the IDs into the string representation of this FirewallPolicyName with pattern projects/{project}/firewallpolicies/{firewallpolicy}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`firewallpolicyId`	`string` The `Firewallpolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FirewallPolicyName with pattern `projects/{project}/firewallpolicies/{firewallpolicy}`.

FormatProjectFirewallpolicy(string, string)

public static string FormatProjectFirewallpolicy(string projectId, string firewallpolicyId)

Formats the IDs into the string representation of this FirewallPolicyName with pattern projects/{project}/firewallpolicies/{firewallpolicy}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`firewallpolicyId`	`string` The `Firewallpolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FirewallPolicyName with pattern `projects/{project}/firewallpolicies/{firewallpolicy}`.

FromProjectFirewallpolicy(string, string)

public static FirewallPolicyName FromProjectFirewallpolicy(string projectId, string firewallpolicyId)

Creates a FirewallPolicyName with the pattern projects/{project}/firewallpolicies/{firewallpolicy}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`firewallpolicyId`	`string` The `Firewallpolicy` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FirewallPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FirewallPolicyName containing an unparsed resource name.

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

Returns
Type	Description
`FirewallPolicyName`	A new instance of FirewallPolicyName 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 FirewallPolicyName Parse(string firewallPolicyName)

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

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

Returns
Type	Description
`FirewallPolicyName`	The parsed FirewallPolicyName if successful.

Remarks

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

projects/{project}/firewallpolicies/{firewallpolicy}

Parse(string, bool)

public static FirewallPolicyName Parse(string firewallPolicyName, bool allowUnparsed)

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

Parameters
Name	Description
`firewallPolicyName`	`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
`FirewallPolicyName`	The parsed FirewallPolicyName if successful.

Remarks

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

projects/{project}/firewallpolicies/{firewallpolicy}

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

public static bool TryParse(string firewallPolicyName, out FirewallPolicyName result)

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

Parameters
Name	Description
`firewallPolicyName`	`string` The resource name in string form. Must not be `null`.
`result`	`FirewallPolicyName` When this method returns, the parsed FirewallPolicyName, 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}/firewallpolicies/{firewallpolicy}

TryParse(string, bool, out FirewallPolicyName)

public static bool TryParse(string firewallPolicyName, bool allowUnparsed, out FirewallPolicyName result)

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

Parameters
Name	Description
`firewallPolicyName`	`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`	`FirewallPolicyName` When this method returns, the parsed FirewallPolicyName, 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}/firewallpolicies/{firewallpolicy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FirewallPolicyName, FirewallPolicyName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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