Class TestCase (0.52.0)

public final class TestCase extends GeneratedMessageV3 implements TestCaseOrBuilder

Represents a test case.

Protobuf type google.cloud.dialogflow.cx.v3.TestCase

Implements

TestCaseOrBuilder

Static Fields

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LAST_TEST_RESULT_FIELD_NUMBER

public static final int LAST_TEST_RESULT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTES_FIELD_NUMBER

public static final int NOTES_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

TEST_CASE_CONVERSATION_TURNS_FIELD_NUMBER

public static final int TEST_CASE_CONVERSATION_TURNS_FIELD_NUMBER
Field Value
Type Description
int

TEST_CONFIG_FIELD_NUMBER

public static final int TEST_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TestCase getDefaultInstance()
Returns
Type Description
TestCase

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TestCase.Builder newBuilder()
Returns
Type Description
TestCase.Builder

newBuilder(TestCase prototype)

public static TestCase.Builder newBuilder(TestCase prototype)
Parameter
Name Description
prototype TestCase
Returns
Type Description
TestCase.Builder

parseDelimitedFrom(InputStream input)

public static TestCase parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TestCase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TestCase parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TestCase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TestCase parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TestCase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TestCase parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TestCase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TestCase parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TestCase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TestCase parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TestCase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TestCase
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TestCase> parser()
Returns
Type Description
Parser<TestCase>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreationTime()

public Timestamp getCreationTime()

Output only. When the test was created.

.google.protobuf.Timestamp creation_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The creationTime.

getCreationTimeOrBuilder()

public TimestampOrBuilder getCreationTimeOrBuilder()

Output only. When the test was created.

.google.protobuf.Timestamp creation_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TestCase getDefaultInstanceForType()
Returns
Type Description
TestCase

getDisplayName()

public String getDisplayName()

Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getLastTestResult()

public TestCaseResult getLastTestResult()

The latest test result.

.google.cloud.dialogflow.cx.v3.TestCaseResult last_test_result = 12;

Returns
Type Description
TestCaseResult

The lastTestResult.

getLastTestResultOrBuilder()

public TestCaseResultOrBuilder getLastTestResultOrBuilder()

The latest test result.

.google.cloud.dialogflow.cx.v3.TestCaseResult last_test_result = 12;

Returns
Type Description
TestCaseResultOrBuilder

getName()

public String getName()

The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: projects/<Project ID>/locations/<LocationID>/agents/ <AgentID>/testCases/<TestCase ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: projects/<Project ID>/locations/<LocationID>/agents/ <AgentID>/testCases/<TestCase ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public String getNotes()

Additional freeform notes about the test case. Limit of 400 characters.

string notes = 4;

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

Additional freeform notes about the test case. Limit of 400 characters.

string notes = 4;

Returns
Type Description
ByteString

The bytes for notes.

getParserForType()

public Parser<TestCase> getParserForType()
Returns
Type Description
Parser<TestCase>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTags(int index)

public String getTags(int index)

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.

repeated string tags = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.

repeated string tags = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.

repeated string tags = 2;

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.

repeated string tags = 2;

Returns
Type Description
ProtocolStringList

A list containing the tags.

getTestCaseConversationTurns(int index)

public ConversationTurn getTestCaseConversationTurns(int index)

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

repeated .google.cloud.dialogflow.cx.v3.ConversationTurn test_case_conversation_turns = 5;

Parameter
Name Description
index int
Returns
Type Description
ConversationTurn

getTestCaseConversationTurnsCount()

public int getTestCaseConversationTurnsCount()

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

repeated .google.cloud.dialogflow.cx.v3.ConversationTurn test_case_conversation_turns = 5;

Returns
Type Description
int

getTestCaseConversationTurnsList()

public List<ConversationTurn> getTestCaseConversationTurnsList()

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

repeated .google.cloud.dialogflow.cx.v3.ConversationTurn test_case_conversation_turns = 5;

Returns
Type Description
List<ConversationTurn>

getTestCaseConversationTurnsOrBuilder(int index)

public ConversationTurnOrBuilder getTestCaseConversationTurnsOrBuilder(int index)

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

repeated .google.cloud.dialogflow.cx.v3.ConversationTurn test_case_conversation_turns = 5;

Parameter
Name Description
index int
Returns
Type Description
ConversationTurnOrBuilder

getTestCaseConversationTurnsOrBuilderList()

public List<? extends ConversationTurnOrBuilder> getTestCaseConversationTurnsOrBuilderList()

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

repeated .google.cloud.dialogflow.cx.v3.ConversationTurn test_case_conversation_turns = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.ConversationTurnOrBuilder>

getTestConfig()

public TestConfig getTestConfig()

Config for the test case.

.google.cloud.dialogflow.cx.v3.TestConfig test_config = 13;

Returns
Type Description
TestConfig

The testConfig.

getTestConfigOrBuilder()

public TestConfigOrBuilder getTestConfigOrBuilder()

Config for the test case.

.google.cloud.dialogflow.cx.v3.TestConfig test_config = 13;

Returns
Type Description
TestConfigOrBuilder

hasCreationTime()

public boolean hasCreationTime()

Output only. When the test was created.

.google.protobuf.Timestamp creation_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the creationTime field is set.

hasLastTestResult()

public boolean hasLastTestResult()

The latest test result.

.google.cloud.dialogflow.cx.v3.TestCaseResult last_test_result = 12;

Returns
Type Description
boolean

Whether the lastTestResult field is set.

hasTestConfig()

public boolean hasTestConfig()

Config for the test case.

.google.cloud.dialogflow.cx.v3.TestConfig test_config = 13;

Returns
Type Description
boolean

Whether the testConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TestCase.Builder newBuilderForType()
Returns
Type Description
TestCase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TestCase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TestCase.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TestCase.Builder toBuilder()
Returns
Type Description
TestCase.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException