4.10.0 (latest) 4.8.0 4.4.0 4.3.1 4.2.0 4.0.0 3.2.0

    public sealed class FolderName : IResourceName, IEquatable<FolderName>

Resource name for the 'folder' resource which is widespread across Google Cloud.
While most resource names are generated on a per-API basis, many APIs use a folder resource, and it's
useful to be able to pass values from one API to another.

## Inheritance

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

## Implements

[IResourceName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.md.txt), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt)

## Inherited Members

[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals)

## Namespace

[Google.Api.Gax.ResourceNames](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.md.txt)

## Assembly

Google.Api.Gax.dll

## Constructors

### FolderName(string)

    public FolderName(string folderId)

Constructs a new instance of a [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) class from the component parts of pattern
`folders/{folder}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `string` The `Folder` ID. Must not be `null` or empty. |

## Properties

### FolderId

    public string FolderId { get; }

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

### Type

    public FolderName.ResourceNameType Type { get; }

The [FolderName.ResourceNameType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.ResourceNameType.md.txt) of the contained resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `FolderNameResourceNameType` |   |

### UnparsedResource

    public UnparsedResourceName UnparsedResource { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `UnparsedResourceName` |   |

## Methods

### Equals(FolderName)

    public bool Equals(FolderName other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `FolderName` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### Equals(object)

    public override bool Equals(object obj)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `obj` | `object` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

**Overrides** [object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object))

### Format(string)

    public static string Format(string folderId)

Formats the IDs into the string representation of this [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) with pattern
`folders/{folder}`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `string` The `Folder` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The string representation of this [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) with pattern `folders/{folder}`. |

### FormatFolder(string)

    public static string FormatFolder(string folderId)

Formats the IDs into the string representation of this [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) with pattern
`folders/{folder}`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `string` The `Folder` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The string representation of this [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) with pattern `folders/{folder}`. |

### FromFolder(string)

    public static FolderName FromFolder(string folderId)

Creates a [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) with the pattern `folders/{folder}`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folderId` | `string` The `Folder` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `FolderName` | A new instance of [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) constructed from the provided ids. |

### FromUnparsed(UnparsedResourceName)

    public static FolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) containing an unparsed resource name.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `FolderName` | A new instance of [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) containing the provided `unparsedResourceName`. |

### GetHashCode()

    public override int GetHashCode()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

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

### Parse(string)

    public static FolderName Parse(string folderName)

Parses the given resource name string into a new [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) instance.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `folderName` | `string` The resource name in string form. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `FolderName` | The parsed [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) if successful. |

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

- `folders/{folder}`

<br />

### Parse(string, bool)

    public static FolderName Parse(string folderName, bool allowUnparsed)

Parses the given resource name string into a new [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) instance; optionally allowing an
unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folderName` | `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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt#Google_Api_Gax_ResourceNames_FolderName_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** |
| `FolderName` | The parsed [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) if successful. |

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

- `folders/{folder}`

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

<br />

### ToString()

    public override string ToString()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

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

### TryParse(string, out FolderName)

    public static bool TryParse(string folderName, out FolderName result)

Tries to parse the given resource name string into a new [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) instance.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folderName` | `string` The resource name in string form. Must not be `null`. |
| `result` | `FolderName` When this method returns, the parsed [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt), 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:

- `folders/{folder}`

<br />

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

    public static bool TryParse(string folderName, bool allowUnparsed, out FolderName result)

Tries to parse the given resource name string into a new [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt) instance; optionally
allowing an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `folderName` | `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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt#Google_Api_Gax_ResourceNames_FolderName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| `result` | `FolderName` When this method returns, the parsed [FolderName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.FolderName.md.txt), 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:

- `folders/{folder}`

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

<br />

## Operators

### operator ==(FolderName, FolderName)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `FolderName` |
| `b` | `FolderName` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### operator !=(FolderName, FolderName)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `FolderName` |
| `b` | `FolderName` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |