1.0.0-beta03 (latest) 1.0.0-beta02

    public sealed class AccessPolicyName : IResourceName, IEquatable<AccessPolicyName>

Reference documentation and code samples for the Identity and Access Management (IAM) v3 API class AccessPolicyName.

Resource name for the `AccessPolicy` resource.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> AccessPolicyName

## Implements

[IResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName)

## Inherited Members

[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)

## Namespace

[Google.Cloud.Iam.V3](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3)

## Assembly

Google.Cloud.Iam.V3.dll

## Constructors

### AccessPolicyName(string, string, string)

    public AccessPolicyName(string organizationId, string locationId, string accessPolicyId)

Constructs a new instance of a [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) class from the component parts of pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

## Properties

### AccessPolicyId

    public string AccessPolicyId { get; }

The `AccessPolicy` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### FolderId

    public string FolderId { get; }

The `Folder` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### IsKnownPattern

    public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### LocationId

    public string LocationId { get; }

The `Location` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OrganizationId

    public string OrganizationId { get; }

The `Organization` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ProjectId

    public string ProjectId { get; }

The `Project` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Type

    public AccessPolicyName.ResourceNameType Type { get; }

The [AccessPolicyName.ResourceNameType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName.ResourceNameType) of the contained resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyNamehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName.ResourceNameType` |   |

### UnparsedResource

    public UnparsedResourceName UnparsedResource { get; }

The contained [UnparsedResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html). Only non-`null` if this instance contains an unparsed resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` |   |

## Methods

### Format(string, string, string)

    public static string Format(string organizationId, string locationId, string accessPolicyId)

Formats the IDs into the string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`. |

### FormatFolderLocationAccessPolicy(string, string, string)

    public static string FormatFolderLocationAccessPolicy(string folderId, string locationId, string accessPolicyId)

Formats the IDs into the string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Folder` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`. |

### FormatOrganizationLocationAccessPolicy(string, string, string)

    public static string FormatOrganizationLocationAccessPolicy(string organizationId, string locationId, string accessPolicyId)

Formats the IDs into the string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`. |

### FormatProjectLocationAccessPolicy(string, string, string)

    public static string FormatProjectLocationAccessPolicy(string projectId, string locationId, string accessPolicyId)

Formats the IDs into the string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `projects/{project}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with pattern `projects/{project}/locations/{location}/accessPolicies/{access_policy}`. |

### FromFolderLocationAccessPolicy(string, string, string)

    public static AccessPolicyName FromFolderLocationAccessPolicy(string folderId, string locationId, string accessPolicyId)

Creates a [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with the pattern `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Folder` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | A new instance of [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) constructed from the provided ids. |

### FromOrganizationLocationAccessPolicy(string, string, string)

    public static AccessPolicyName FromOrganizationLocationAccessPolicy(string organizationId, string locationId, string accessPolicyId)

Creates a [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with the pattern `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | A new instance of [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) constructed from the provided ids. |

### FromProjectLocationAccessPolicy(string, string, string)

    public static AccessPolicyName FromProjectLocationAccessPolicy(string projectId, string locationId, string accessPolicyId)

Creates a [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) with the pattern `projects/{project}/locations/{location}/accessPolicies/{access_policy}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `accessPolicyId` | `https://learn.microsoft.com/dotnet/api/system.string` The `AccessPolicy` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | A new instance of [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) constructed from the provided ids. |

### FromUnparsed(UnparsedResourceName)

    public static AccessPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) containing an unparsed resource name.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `unparsedResourceName` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` The unparsed resource name. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | A new instance of [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) containing the provided `unparsedResourceName`. |

### GetHashCode()

    public override int GetHashCode()

Returns a hash code for this resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

**Overrides** [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

### Parse(string)

    public static AccessPolicyName Parse(string accessPolicyName)

Parses the given resource name string into a new [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) instance.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `accessPolicyName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | The parsed [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) if successful. |

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

- `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`
- `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`
- `projects/{project}/locations/{location}/accessPolicies/{access_policy}`

### Parse(string, bool)

    public static AccessPolicyName Parse(string accessPolicyName, bool allowUnparsed)

Parses the given resource name string into a new [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) instance; optionally allowing an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `accessPolicyName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName#Google_Cloud_Iam_V3_AccessPolicyName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` | The parsed [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) if successful. |

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

- `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`
- `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`
- `projects/{project}/locations/{location}/accessPolicies/{access_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** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of the resource name. |

**Overrides** [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

### TryParse(string, out AccessPolicyName)

    public static bool TryParse(string accessPolicyName, out AccessPolicyName result)

Tries to parse the given resource name string into a new [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) instance.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `accessPolicyName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` When this method returns, the parsed [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `true` if the name was parsed successfully; `false` otherwise. |

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

- `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`
- `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`
- `projects/{project}/locations/{location}/accessPolicies/{access_policy}`

### TryParse(string, bool, out AccessPolicyName)

    public static bool TryParse(string accessPolicyName, bool allowUnparsed, out AccessPolicyName result)

Tries to parse the given resource name string into a new [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName) instance; optionally allowing an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `accessPolicyName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName#Google_Cloud_Iam_V3_AccessPolicyName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` When this method returns, the parsed [AccessPolicyName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `true` if the name was parsed successfully; `false` otherwise. |

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

- `organizations/{organization}/locations/{location}/accessPolicies/{access_policy}`
- `folders/{folder}/locations/{location}/accessPolicies/{access_policy}`
- `projects/{project}/locations/{location}/accessPolicies/{access_policy}`

Or may be in any format if `allowUnparsed` is `true`.

## Operators

### operator ==(AccessPolicyName, AccessPolicyName)

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

Determines whether two specified resource names have the same value.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is the same as the value of `b`; otherwise, false. |

### operator !=(AccessPolicyName, AccessPolicyName)

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

Determines whether two specified resource names have different values.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Iam.V3/latest/Google.Cloud.Iam.V3.AccessPolicyName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is different from the value of `b`; otherwise, false. |