google_api_tool_results v0.22.0 GoogleApi.ToolResults.V1beta3.Api.Clusters View Source

API calls for all endpoints tagged Clusters.

Link to this section Summary

Link to this section Functions

Link to this function

toolresults_clusters_get(connection, project_id, history_id, execution_id, cluster_id, optional_params \\ [], opts \\ [])

View Source
toolresults_clusters_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ToolResults.V1beta3.Model.ScreenshotCluster.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves a single screenshot cluster by its ID

Parameters

  • connection (type: GoogleApi.ToolResults.V1beta3.Connection.t) - Connection to server

  • project_id (type: String.t) - A Project id.

    Required.

  • history_id (type: String.t) - A History id.

    Required.

  • execution_id (type: String.t) - An Execution id.

    Required.

  • cluster_id (type: String.t) - A Cluster id

    Required.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ToolResults.V1beta3.Model.ScreenshotCluster{}} on success
  • {:error, info} on failure
Link to this function

toolresults_clusters_list(connection, project_id, history_id, execution_id, optional_params \\ [], opts \\ [])

View Source

Lists Screenshot Clusters

Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.

Parameters

  • connection (type: GoogleApi.ToolResults.V1beta3.Connection.t) - Connection to server

  • project_id (type: String.t) - A Project id.

    Required.

  • history_id (type: String.t) - A History id.

    Required.

  • execution_id (type: String.t) - An Execution id.

    Required.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ToolResults.V1beta3.Model.ListScreenshotClustersResponse{}} on success
  • {:error, info} on failure