Class DocumentName (4.0.0) 

public sealed class DocumentName : IResourceName, IEquatable<DocumentName>

Resource name for the Document resource.

Inheritance

System.Object > DocumentName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

DocumentName(String, String, String)

public DocumentName(string projectId, string knowledgeBaseId, string documentId)

Constructs a new instance of a DocumentName class from the component parts of pattern projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

The Document ID. Must not be null or empty.

Properties

DocumentId

public string DocumentId { get; }

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

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
Boolean

KnowledgeBaseId

public string KnowledgeBaseId { get; }

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

Property Value
Type Description
String

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
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
String

Type

public DocumentName.ResourceNameType Type { get; }

The DocumentName.ResourceNameType of the contained resource name.

Property Value
Type Description
DocumentName.ResourceNameType

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, String)

public static string Format(string projectId, string knowledgeBaseId, string documentId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

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

The string representation of this DocumentName with pattern projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

FormatProjectKnowledgeBaseDocument(String, String, String)

public static string FormatProjectKnowledgeBaseDocument(string projectId, string knowledgeBaseId, string documentId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

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

The string representation of this DocumentName with pattern projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

FormatProjectLocationKnowledgeBaseDocument(String, String, String, String)

public static string FormatProjectLocationKnowledgeBaseDocument(string projectId, string locationId, string knowledgeBaseId, string documentId)

Formats the IDs into the string representation of this DocumentName with pattern projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

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

The string representation of this DocumentName with pattern projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}.

FromProjectKnowledgeBaseDocument(String, String, String)

public static DocumentName FromProjectKnowledgeBaseDocument(string projectId, string knowledgeBaseId, string documentId)

Creates a DocumentName with the pattern projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

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

A new instance of DocumentName constructed from the provided ids.

FromProjectLocationKnowledgeBaseDocument(String, String, String, String)

public static DocumentName FromProjectLocationKnowledgeBaseDocument(string projectId, string locationId, string knowledgeBaseId, string documentId)

Creates a DocumentName with the pattern projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}.

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
locationId String

The Location ID. Must not be null or empty.
knowledgeBaseId String

The KnowledgeBase ID. Must not be null or empty.
documentId String

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)

public static DocumentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DocumentName containing an unparsed resource name.

Parameter
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()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static DocumentName Parse(string documentName)

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

Parameter
Name Description
documentName String

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:

  • projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}

Parse(String, Boolean)

public static DocumentName Parse(string documentName, bool allowUnparsed)

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

Parameters
Name Description
documentName String

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

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:

  • projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}
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

TryParse(String, out DocumentName)

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

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

Parameters
Name Description
documentName String

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

When this method returns, the parsed DocumentName, or null if parsing failed.
Returns
Type Description
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:

  • projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}

TryParse(String, Boolean, out DocumentName)

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

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

Parameters
Name Description
documentName String

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

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 DocumentName

When this method returns, the parsed DocumentName, or null if parsing failed.
Returns
Type Description
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:

  • projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}
Or may be in any format if allowUnparsed is true.

Operators

Equality(DocumentName, DocumentName)

public static bool operator ==(DocumentName a, DocumentName b)
Parameters
Name Description
a DocumentName
b DocumentName
Returns
Type Description
Boolean

Inequality(DocumentName, DocumentName)

public static bool operator !=(DocumentName a, DocumentName b)
Parameters
Name Description
a DocumentName
b DocumentName
Returns
Type Description
Boolean