com.google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/test_case.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface ListTestCaseResultsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.ListTestCaseResultsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.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) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

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

  /**
   *
   *
   *    * The next_page_token value returned from a previous list request.
   * 
   *
   * string page_token = 3;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * The next_page_token value returned from a previous list request.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * 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;
   *
   * @return The filter.
   */
  java.lang.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;
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();
}