Class: Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb

Overview

The request message for TestCases.ListTestCases.

Defined Under Namespace

Modules: TestCaseView

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.

Returns:

  • (::Integer) —

    The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 408

class ListTestCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how much test case information to include in the response.
  module TestCaseView
    # The default / unset value.
    # The API will default to the BASIC view.
    TEST_CASE_VIEW_UNSPECIFIED = 0

    # Include basic metadata about the test case, but not the conversation
    # turns. This is the default value.
    BASIC = 1

    # Include everything.
    FULL = 2
  end
end

#page_token ⇒ ::String

Returns The next_page_token value returned from a previous list request.

Returns:

  • (::String) —

    The next_page_token value returned from a previous list request.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 408

class ListTestCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how much test case information to include in the response.
  module TestCaseView
    # The default / unset value.
    # The API will default to the BASIC view.
    TEST_CASE_VIEW_UNSPECIFIED = 0

    # Include basic metadata about the test case, but not the conversation
    # turns. This is the default value.
    BASIC = 1

    # Include everything.
    FULL = 2
  end
end

#parent ⇒ ::String

Returns Required. The agent to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Returns:

  • (::String) —

    Required. The agent to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 408

class ListTestCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how much test case information to include in the response.
  module TestCaseView
    # The default / unset value.
    # The API will default to the BASIC view.
    TEST_CASE_VIEW_UNSPECIFIED = 0

    # Include basic metadata about the test case, but not the conversation
    # turns. This is the default value.
    BASIC = 1

    # Include everything.
    FULL = 2
  end
end

#view ⇒ ::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest::TestCaseView

Returns Specifies whether response should include all fields or just the metadata.

Returns:



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 408

class ListTestCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how much test case information to include in the response.
  module TestCaseView
    # The default / unset value.
    # The API will default to the BASIC view.
    TEST_CASE_VIEW_UNSPECIFIED = 0

    # Include basic metadata about the test case, but not the conversation
    # turns. This is the default value.
    BASIC = 1

    # Include everything.
    FULL = 2
  end
end