Package com.google.cloud.dialogflow.cx.v3beta1

Interface ListTestCaseResultsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListTestCaseResultsRequest, ListTestCaseResultsRequest.Builder
@Generated public interface ListTestCaseResultsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    The filter expression used to filter test case results.
    com.google.protobuf.ByteString
    getFilterBytes()
    The filter expression used to filter test case results.
    int
    getPageSize()
    The maximum number of items to return in a single page.
    String
    getPageToken()
    The next_page_token value returned from a previous list request.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    The next_page_token value returned from a previous list request.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The test case to list results for.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
 Specify a `-` as a wildcard for TestCase ID to
 list results across multiple test cases.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The test case to list results for.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
 Specify a `-` as a wildcard for TestCase ID to
 list results across multiple test cases.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       The maximum number of items to return in a single page. By default 100 and
 at most 1000.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       The filter expression used to filter test case results. See
 [API Filtering](https://aip.dev/160).

 The expression is case insensitive. Only 'AND' is supported for logical
 operators. The supported syntax is listed below in detail:

 <field> <operator> <value> [AND <field> <operator> <value>] ...
 [AND latest]

 The supported fields and operators are:
 field                 operator
 `environment`         `=`, `IN`  (Use value `draft` for draft environment)
 `test_time`           `>`, `<`

 `latest` only returns the latest test result in all results for each test
 case.

 Examples:
 *   "environment=draft AND latest" matches the latest test result for each
 test case in the draft environment.
 *   "environment IN (e1,e2)" matches any test case results with an
 environment resource name of either "e1" or "e2".
 *   "test_time > 1602540713" matches any test case results with test time
 later than a unix timestamp in seconds 1602540713.
      string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       The filter expression used to filter test case results. See
 [API Filtering](https://aip.dev/160).

 The expression is case insensitive. Only 'AND' is supported for logical
 operators. The supported syntax is listed below in detail:

 <field> <operator> <value> [AND <field> <operator> <value>] ...
 [AND latest]

 The supported fields and operators are:
 field                 operator
 `environment`         `=`, `IN`  (Use value `draft` for draft environment)
 `test_time`           `>`, `<`

 `latest` only returns the latest test result in all results for each test
 case.

 Examples:
 *   "environment=draft AND latest" matches the latest test result for each
 test case in the draft environment.
 *   "environment IN (e1,e2)" matches any test case results with an
 environment resource name of either "e1" or "e2".
 *   "test_time > 1602540713" matches any test case results with test time
 later than a unix timestamp in seconds 1602540713.
      string filter = 4;
      Returns:
      The bytes for filter.