Google Cloud Dialogflow v2 API - Class KnowledgeBaseName (4.9.0)

Version 4.9.0

• 4.22.0 (latest)
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

public sealed class KnowledgeBaseName : IResourceName, IEquatable<KnowledgeBaseName>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class KnowledgeBaseName.

Resource name for the KnowledgeBase resource.

Inheritance

object > KnowledgeBaseName

Implements

IResourceName, IEquatableKnowledgeBaseName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DialogflowV2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

KnowledgeBaseName(string, string)

public KnowledgeBaseName(string projectId, string knowledgeBaseId)

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

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.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
bool

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 KnowledgeBaseName.ResourceNameType Type { get; }

The KnowledgeBaseName.ResourceNameType of the contained resource name.

Property Value
Type	Description
KnowledgeBaseNameResourceNameType

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)

public static string Format(string projectId, string knowledgeBaseId)

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

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.

Returns
Type	Description
string	The string representation of this KnowledgeBaseName with pattern projects/{project}/knowledgeBases/{knowledge_base}.

FormatProjectKnowledgeBase(string, string)

public static string FormatProjectKnowledgeBase(string projectId, string knowledgeBaseId)

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

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.

Returns
Type	Description
string	The string representation of this KnowledgeBaseName with pattern projects/{project}/knowledgeBases/{knowledge_base}.

FormatProjectLocationKnowledgeBase(string, string, string)

public static string FormatProjectLocationKnowledgeBase(string projectId, string locationId, string knowledgeBaseId)

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

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.

Returns
Type	Description
string	The string representation of this KnowledgeBaseName with pattern projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}.

FromProjectKnowledgeBase(string, string)

public static KnowledgeBaseName FromProjectKnowledgeBase(string projectId, string knowledgeBaseId)

Creates a KnowledgeBaseName with the pattern projects/{project}/knowledgeBases/{knowledge_base}.

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.

Returns
Type	Description
KnowledgeBaseName	A new instance of KnowledgeBaseName constructed from the provided ids.

FromProjectLocationKnowledgeBase(string, string, string)

public static KnowledgeBaseName FromProjectLocationKnowledgeBase(string projectId, string locationId, string knowledgeBaseId)

Creates a KnowledgeBaseName with the pattern projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}.

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.

Returns
Type	Description
KnowledgeBaseName	A new instance of KnowledgeBaseName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static KnowledgeBaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a KnowledgeBaseName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
KnowledgeBaseName	A new instance of KnowledgeBaseName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

Object.GetHashCode()

Parse(string)

public static KnowledgeBaseName Parse(string knowledgeBaseName)

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

Parameter
Name	Description
knowledgeBaseName	string The resource name in string form. Must not be null.

Returns
Type	Description
KnowledgeBaseName	The parsed KnowledgeBaseName if successful.

Remarks

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

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

Parse(string, bool)

public static KnowledgeBaseName Parse(string knowledgeBaseName, bool allowUnparsed)

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

Parameters
Name	Description
knowledgeBaseName	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 property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
KnowledgeBaseName	The parsed KnowledgeBaseName if successful.

Remarks

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

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

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

Object.ToString()

TryParse(string, out KnowledgeBaseName)

public static bool TryParse(string knowledgeBaseName, out KnowledgeBaseName result)

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

Parameters
Name	Description
knowledgeBaseName	string The resource name in string form. Must not be null.
result	KnowledgeBaseName When this method returns, the parsed KnowledgeBaseName, 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:

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

TryParse(string, bool, out KnowledgeBaseName)

public static bool TryParse(string knowledgeBaseName, bool allowUnparsed, out KnowledgeBaseName result)

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

Parameters
Name	Description
knowledgeBaseName	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 property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
result	KnowledgeBaseName When this method returns, the parsed KnowledgeBaseName, 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:

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(KnowledgeBaseName, KnowledgeBaseName)

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

Parameters
Name	Description
a	KnowledgeBaseName
b	KnowledgeBaseName

Returns
Type	Description
bool

operator !=(KnowledgeBaseName, KnowledgeBaseName)

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

Parameters
Name	Description
a	KnowledgeBaseName
b	KnowledgeBaseName

Returns
Type	Description
bool