create(parent, body=None, testCaseId=None, x__xgafv=None)

Create a new test case.

Args:
  parent: string, Required. The parent resource where this test case will be created. Format: `projects/{project_number}/apps/{app_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AI test cases
  "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
    "appDescription": "A String", # Optional. Describes the app to give the AI some context
    "steps": [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        "assertion": "A String", # An assertion to be checked by the AI
        "goal": "A String", # A goal to be accomplished by the AI
        "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
        "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
      },
    ],
  },
  "displayName": "A String", # Optional. Display name of the test case.
  "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
}

  testCaseId: string, Optional. The ID to use for the test case, which will become the final component of the test case's resource name. This value should be 4-63 characters, and valid characters are /a-z-/.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
    "appDescription": "A String", # Optional. Describes the app to give the AI some context
    "steps": [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        "assertion": "A String", # An assertion to be checked by the AI
        "goal": "A String", # A goal to be accomplished by the AI
        "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
        "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
      },
    ],
  },
  "displayName": "A String", # Optional. Display name of the test case.
  "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
}

delete(name, x__xgafv=None)

Delete a test case.

Args:
  name: string, Required. The name of the test case resource to delete. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Get a test case.

Args:
  name: string, Required. The name of the test case resource to retrieve. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
    "appDescription": "A String", # Optional. Describes the app to give the AI some context
    "steps": [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        "assertion": "A String", # An assertion to be checked by the AI
        "goal": "A String", # A goal to be accomplished by the AI
        "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
        "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
      },
    ],
  },
  "displayName": "A String", # Optional. Display name of the test case.
  "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List test cases.

Args:
  parent: string, Required. The parent resource from which to list test cases. Format: `projects/{project_number}/apps/{app_id}` (required)
  pageSize: integer, Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 50 test cases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `ListTestCases`.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "testCases": [ # The test cases from the specified app.
    { # AI test cases
      "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
        "appDescription": "A String", # Optional. Describes the app to give the AI some context
        "steps": [ # Required. Steps to be accomplished by the AI
          { # A step to be accomplished by the AI
            "assertion": "A String", # An assertion to be checked by the AI
            "goal": "A String", # A goal to be accomplished by the AI
            "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
            "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
          },
        ],
      },
      "displayName": "A String", # Optional. Display name of the test case.
      "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, x__xgafv=None)

Update a test case.

Args:
  name: string, Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AI test cases
  "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
    "appDescription": "A String", # Optional. Describes the app to give the AI some context
    "steps": [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        "assertion": "A String", # An assertion to be checked by the AI
        "goal": "A String", # A goal to be accomplished by the AI
        "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
        "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
      },
    ],
  },
  "displayName": "A String", # Optional. Display name of the test case.
  "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AI test cases
  "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test.
    "appDescription": "A String", # Optional. Describes the app to give the AI some context
    "steps": [ # Required. Steps to be accomplished by the AI
      { # A step to be accomplished by the AI
        "assertion": "A String", # An assertion to be checked by the AI
        "goal": "A String", # A goal to be accomplished by the AI
        "hint": "A String", # Optional. Hint text containing suggestions to help the agent accomplish the goal
        "successCriteria": "A String", # Optional. A description of criteria the agent should use to determine if the goal has been successfully completed
      },
    ],
  },
  "displayName": "A String", # Optional. Display name of the test case.
  "name": "A String", # Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`
}

Firebase App Distribution API . projects . apps . testCases

Instance Methods

Method Details