Class KnowledgeBaseName (3.9.0) 

public sealed class KnowledgeBaseName : IResourceName, IEquatable<KnowledgeBaseName>

Resource name for the KnowledgeBase resource.

Inheritance

Object > KnowledgeBaseName

Namespace

Google.Cloud.Dialogflow.V2

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

The KnowledgeBaseName.ResourceNameType of the contained resource name.

Property Value
Type Description
KnowledgeBaseName.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)

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
Int32
Overrides

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

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

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

TryParse(String, Boolean, 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 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 KnowledgeBaseName

When this method returns, the parsed KnowledgeBaseName, 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}
  • projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
Or may be in any format if allowUnparsed is true.

Operators

Equality(KnowledgeBaseName, KnowledgeBaseName)

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

Inequality(KnowledgeBaseName, KnowledgeBaseName)

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