Class DocumentName

Resource name for the Document resource.

Inheritance
object
DocumentName
Implements
Inherited Members
Namespace: 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 class from the component parts of pattern documents/{document}

Declaration
public DocumentName(string documentId)
Parameters
Type Name Description
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

IsKnownPattern

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

Declaration
public bool IsKnownPattern { get; }
Property Value
Type Description
bool
Implements

Type

The DocumentName.ResourceNameType of the contained resource name.

Declaration
public DocumentName.ResourceNameType Type { get; }
Property Value
Type Description
DocumentName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration
public UnparsedResourceName UnparsedResource { get; }
Property Value
Type Description
UnparsedResourceName

Methods

Format(string)

Formats the IDs into the string representation of this DocumentName with pattern documents/{document}.

Declaration
public static string Format(string documentId)
Parameters
Type Name Description
string documentId

The Document ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DocumentName with pattern documents/{document}.

FormatDocument(string)

Formats the IDs into the string representation of this DocumentName with pattern documents/{document}.

Declaration
public static string FormatDocument(string documentId)
Parameters
Type Name Description
string documentId

The Document ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DocumentName with pattern documents/{document}.

FromDocument(string)

Creates a DocumentName with the pattern documents/{document}.

Declaration
public static DocumentName FromDocument(string documentId)
Parameters
Type Name Description
string documentId

The Document ID. Must not be null or empty.
Returns
Type Description
DocumentName

A new instance of DocumentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a DocumentName containing an unparsed resource name.

Declaration
public static DocumentName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DocumentName

A new instance of DocumentName containing the provided unparsedResourceName .

GetHashCode()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Parse(string)

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

Declaration
public static DocumentName Parse(string documentName)
Parameters
Type Name Description
string documentName

The resource name in string form. Must not be null.
Returns
Type Description
DocumentName

The parsed 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 instance; optionally allowing an unparseable resource name.

Declaration
public static DocumentName Parse(string documentName, bool allowUnparsed)
Parameters
Type Name Description
string documentName

The resource name in string form. Must not be null.
bool allowUnparsed

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
DocumentName

The parsed 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

The string representation of the resource name.
Overrides
Implements

TryParse(string, out DocumentName)

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

Declaration
public static bool TryParse(string documentName, out DocumentName result)
Parameters
Type Name Description
string documentName

The resource name in string form. Must not be null.
DocumentName result

When this method returns, the parsed DocumentName, 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:

  • documents/{document}

TryParse(string, bool, out DocumentName)

Tries to parse the given resource name string into a new 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 documentName

The resource name in string form. Must not be null.
bool allowUnparsed

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.
DocumentName result

When this method returns, the parsed DocumentName, 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:

  • 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 a

The first resource name to compare, or null.
DocumentName b

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 !=(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 a

The first resource name to compare, or null.
DocumentName b

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.