Dialogflow v3 API - Class TestCaseResultName (2.21.0)

public sealed class TestCaseResultName : IResourceName, IEquatable<TestCaseResultName>

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

Resource name for the TestCaseResult resource.

Inheritance

object > TestCaseResultName

Implements

IResourceName, IEquatable TestCaseResultName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

TestCaseResultName(string, string, string, string, string)

public TestCaseResultName(string projectId, string locationId, string agentId, string testCaseId, string resultId)

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

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.
`agentId`	`string` The `Agent` ID. Must not be `null` or empty.
`testCaseId`	`string` The `TestCase` ID. Must not be `null` or empty.
`resultId`	`string` The `Result` 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
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

ResultId

public string ResultId { get; }

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

Property Value
Type	Description
`string`

TestCaseId

public string TestCaseId { get; }

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

Property Value
Type	Description
`string`

Type

public TestCaseResultName.ResourceNameType Type { get; }

The TestCaseResultName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TestCaseResultNameResourceNameType`

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

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

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

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.
`agentId`	`string` The `Agent` ID. Must not be `null` or empty.
`testCaseId`	`string` The `TestCase` ID. Must not be `null` or empty.
`resultId`	`string` The `Result` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TestCaseResultName with pattern `projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}`.

FormatProjectLocationAgentTestCaseResult(string, string, string, string, string)

public static string FormatProjectLocationAgentTestCaseResult(string projectId, string locationId, string agentId, string testCaseId, string resultId)

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

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.
`agentId`	`string` The `Agent` ID. Must not be `null` or empty.
`testCaseId`	`string` The `TestCase` ID. Must not be `null` or empty.
`resultId`	`string` The `Result` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TestCaseResultName with pattern `projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}`.

FromProjectLocationAgentTestCaseResult(string, string, string, string, string)

public static TestCaseResultName FromProjectLocationAgentTestCaseResult(string projectId, string locationId, string agentId, string testCaseId, string resultId)

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

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.
`agentId`	`string` The `Agent` ID. Must not be `null` or empty.
`testCaseId`	`string` The `TestCase` ID. Must not be `null` or empty.
`resultId`	`string` The `Result` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static TestCaseResultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TestCaseResultName containing an unparsed resource name.

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

Returns
Type	Description
`TestCaseResultName`	A new instance of TestCaseResultName 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 TestCaseResultName Parse(string testCaseResultName)

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

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

Returns
Type	Description
`TestCaseResultName`	The parsed TestCaseResultName 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}/results/{result}

Parse(string, bool)

public static TestCaseResultName Parse(string testCaseResultName, bool allowUnparsed)

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

Parameters
Name	Description
`testCaseResultName`	`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 ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`TestCaseResultName`	The parsed TestCaseResultName 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}/results/{result}

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

public static bool TryParse(string testCaseResultName, out TestCaseResultName result)

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

Parameters
Name	Description
`testCaseResultName`	`string` The resource name in string form. Must not be `null`.
`result`	`TestCaseResultName` When this method returns, the parsed TestCaseResultName, 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}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}

TryParse(string, bool, out TestCaseResultName)

public static bool TryParse(string testCaseResultName, bool allowUnparsed, out TestCaseResultName result)

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

Parameters
Name	Description
`testCaseResultName`	`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 ArgumentException if an unparseable resource name is specified.
`result`	`TestCaseResultName` When this method returns, the parsed TestCaseResultName, 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}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TestCaseResultName, TestCaseResultName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TestCaseResultName` The first resource name to compare, or null.
`b`	`TestCaseResultName` 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 !=(TestCaseResultName, TestCaseResultName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TestCaseResultName` The first resource name to compare, or null.
`b`	`TestCaseResultName` 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.