[![](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/logo.svg)](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/index.html)
- 
[Show / Hide Table of Contents](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName#sidetoggle) Resource name for the `Document` resource.

##### Inheritance

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

##### 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)\<[DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName)\>

##### Inherited Members

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

###### **Namespace** : [Google](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google).[Developers](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers).[DeveloperKnowledge](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge).[V1](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1)

###### **Assembly**: Google.Developers.DeveloperKnowledge.V1.dll

##### Syntax

    public sealed class DocumentName : IResourceName, IEquatable<DocumentName>

### Constructors

#### DocumentName(string)

Constructs a new instance of a [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) class from the component parts of pattern
`documents/{document}`

##### Declaration

    public DocumentName(string documentId)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentId | The `Document` ID. Must not be `null` or empty. |

### Properties

#### DocumentId

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

##### Declaration

    public string DocumentId { get; }

##### Property Value

| Type | Description |
|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) |   |

#### IsKnownPattern

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

##### Declaration

    public bool IsKnownPattern { get; }

##### Property Value

| Type | Description |
|---|---|
| [bool](https://learn.microsoft.com/dotnet/api/system.boolean) |   |

##### Implements

[IResourceName.IsKnownPattern](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html#Google_Api_Gax_IResourceName_IsKnownPattern)

#### Type

The [DocumentName.ResourceNameType](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName.ResourceNameType) of the contained resource name.

##### Declaration

    public DocumentName.ResourceNameType Type { get; }

##### Property Value

| Type | Description |
|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName).[ResourceNameType](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName.ResourceNameType) |   |

#### UnparsedResource

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.

##### Declaration

    public UnparsedResourceName UnparsedResource { get; }

##### Property Value

| Type | Description |
|---|---|
| [UnparsedResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html) |   |

### Methods

#### Format(string)

Formats the IDs into the string representation of this [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) with pattern
`documents/{document}`.

##### Declaration

    public static string Format(string documentId)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentId | The `Document` ID. Must not be `null` or empty. |

##### Returns

| Type | Description |
|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | The string representation of this [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) with pattern `documents/{document}`. |

#### FormatDocument(string)

Formats the IDs into the string representation of this [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) with pattern
`documents/{document}`.

##### Declaration

    public static string FormatDocument(string documentId)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentId | The `Document` ID. Must not be `null` or empty. |

##### Returns

| Type | Description |
|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | The string representation of this [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) with pattern `documents/{document}`. |

#### FromDocument(string)

Creates a [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) with the pattern `documents/{document}`.

##### Declaration

    public static DocumentName FromDocument(string documentId)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentId | The `Document` ID. Must not be `null` or empty. |

##### Returns

| Type | Description |
|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | A new instance of [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) constructed from the provided ids. |

#### FromUnparsed(UnparsedResourceName)

Creates a [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) containing an unparsed resource name.

##### Declaration

    public static DocumentName FromUnparsed(UnparsedResourceName unparsedResourceName)

##### Parameters

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

##### Returns

| Type | Description |
|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | A new instance of [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) containing the provided `unparsedResourceName` . |

#### GetHashCode()

Returns a hash code for this resource name.

##### Declaration

    public override int GetHashCode()

##### Returns

| Type | Description |
|---|---|
| [int](https://learn.microsoft.com/dotnet/api/system.int32) |   |

##### Overrides

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

#### Parse(string)

Parses the given resource name string into a new [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) instance.

##### Declaration

    public static DocumentName Parse(string documentName)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentName | The resource name in string form. Must not be `null`. |

##### Returns

| Type | Description |
|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | The parsed [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) if successful. |

##### Remarks

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

- `documents/{document}`

#### Parse(string, bool)

Parses the given resource name string into a new [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) instance; optionally allowing an
unparseable resource name.

##### Declaration

    public static DocumentName Parse(string documentName, bool allowUnparsed)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentName | The resource name in string form. Must not be `null`. |
| [bool](https://learn.microsoft.com/dotnet/api/system.boolean) | allowUnparsed | If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName#Google_Developers_DeveloperKnowledge_V1_DocumentName_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 |
|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | The parsed [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) if successful. |

##### Remarks

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

- `documents/{document}`

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

#### ToString()

The string representation of the resource name.

##### Declaration

    public override string ToString()

##### Returns

| Type | Description |
|---|---|
| [string](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)

##### Implements

[IResourceName.ToString()](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html#Google_Api_Gax_IResourceName_ToString)

#### TryParse(string, out DocumentName)

Tries to parse the given resource name string into a new [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) instance.

##### Declaration

    public static bool TryParse(string documentName, out DocumentName result)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentName | The resource name in string form. Must not be `null`. |
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | result | When this method returns, the parsed [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName), or `null` if parsing failed. |

##### Returns

| Type | Description |
|---|---|
| [bool](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:

- `documents/{document}`

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

Tries to parse the given resource name string into a new [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) instance; optionally
allowing an unparseable resource name.

##### Declaration

    public static bool TryParse(string documentName, bool allowUnparsed, out DocumentName result)

##### Parameters

| Type | Name | Description |
|---|---|---|
| [string](https://learn.microsoft.com/dotnet/api/system.string) | documentName | The resource name in string form. Must not be `null`. |
| [bool](https://learn.microsoft.com/dotnet/api/system.boolean) | allowUnparsed | If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName#Google_Developers_DeveloperKnowledge_V1_DocumentName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | result | When this method returns, the parsed [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName), or `null` if parsing failed. |

##### Returns

| Type | Description |
|---|---|
| [bool](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:

- `documents/{document}`

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

### Operators

#### operator ==(DocumentName, DocumentName)

Determines whether two specified resource names have the same value.

##### Declaration

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

##### Parameters

| Type | Name | Description |
|---|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | a | The first resource name to compare, or null. |
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | b | The second resource name to compare, or null. |

##### Returns

| Type | Description |
|---|---|
| [bool](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 !=(DocumentName, DocumentName)

Determines whether two specified resource names have different values.

##### Declaration

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

##### Parameters

| Type | Name | Description |
|---|---|---|
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | a | The first resource name to compare, or null. |
| [DocumentName](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName) | b | The second resource name to compare, or null. |

##### Returns

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

##### In this article

[Back to top](https://developers.google.com/dotnet/docs/reference/Google.Developers.DeveloperKnowledge.V1/latest/api/Google.Developers.DeveloperKnowledge.V1.DocumentName#top) Generated by **DocFX**