Dialogflow v3 API - Class TestCaseName (2.16.0)

public sealed class TestCaseName : IResourceName, IEquatable<TestCaseName>

Reference documentation and code samples for the Dialogflow v3 API class TestCaseName.

Resource name for the TestCase resource.

Inheritance

object > TestCaseName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

TestCaseName(string, string, string, string)

public TestCaseName(string projectId, string locationId, string agentId, string testCaseId)

Constructs a new instance of a TestCaseName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

agentIdstring

The Agent ID. Must not be null or empty.

testCaseIdstring

The TestCase ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

TestCaseId

public string TestCaseId { get; }

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

Property Value
TypeDescription
string

Type

public TestCaseName.ResourceNameType Type { get; }

The TestCaseName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TestCaseNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string agentId, string testCaseId)

Formats the IDs into the string representation of this TestCaseName with pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

agentIdstring

The Agent ID. Must not be null or empty.

testCaseIdstring

The TestCase ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TestCaseName with pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

FormatProjectLocationAgentTestCase(string, string, string, string)

public static string FormatProjectLocationAgentTestCase(string projectId, string locationId, string agentId, string testCaseId)

Formats the IDs into the string representation of this TestCaseName with pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

agentIdstring

The Agent ID. Must not be null or empty.

testCaseIdstring

The TestCase ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TestCaseName with pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

FromProjectLocationAgentTestCase(string, string, string, string)

public static TestCaseName FromProjectLocationAgentTestCase(string projectId, string locationId, string agentId, string testCaseId)

Creates a TestCaseName with the pattern projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

agentIdstring

The Agent ID. Must not be null or empty.

testCaseIdstring

The TestCase ID. Must not be null or empty.

Returns
TypeDescription
TestCaseName

A new instance of TestCaseName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TestCaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TestCaseName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TestCaseName

A new instance of TestCaseName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TestCaseName Parse(string testCaseName)

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

Parameter
NameDescription
testCaseNamestring

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

Returns
TypeDescription
TestCaseName

The parsed TestCaseName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}

Parse(string, bool)

public static TestCaseName Parse(string testCaseName, bool allowUnparsed)

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

Parameters
NameDescription
testCaseNamestring

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

allowUnparsedbool

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

The parsed TestCaseName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out TestCaseName)

public static bool TryParse(string testCaseName, out TestCaseName result)

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

Parameters
NameDescription
testCaseNamestring

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

resultTestCaseName

When this method returns, the parsed TestCaseName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/agents/{agent}/testCases/{test_case}

TryParse(string, bool, out TestCaseName)

public static bool TryParse(string testCaseName, bool allowUnparsed, out TestCaseName result)

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

Parameters
NameDescription
testCaseNamestring

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

allowUnparsedbool

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.

resultTestCaseName

When this method returns, the parsed TestCaseName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/agents/{agent}/testCases/{test_case}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TestCaseName, TestCaseName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aTestCaseName

The first resource name to compare, or null.

bTestCaseName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TestCaseName, TestCaseName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aTestCaseName

The first resource name to compare, or null.

bTestCaseName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.