google_api_tool_results v0.22.0 GoogleApi.ToolResults.V1beta3.Api.Steps View Source
API calls for all endpoints tagged Steps
.
Link to this section Summary
Functions
Lists accessibility clusters for a given Step
Creates a Step.
Gets a Step.
Retrieves a PerfMetricsSummary.
Lists Steps for a given Execution.
Updates an existing Step with the supplied partial entity.
Publish xml files to an existing Step.
Link to this section Functions
toolresults_steps_accessibility_clusters(connection, name, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_accessibility_clusters( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.ListStepAccessibilityClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists accessibility clusters for a given Step
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to read project
- INVALID_ARGUMENT - if the request is malformed
FAILED_PRECONDITION - if an argument in the request happens to be
invalid; e.g. if the locale format is incorrect
- NOT_FOUND - if the containing Step does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to servername
(type:String.t
) - A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdefRequired.
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").:locale
(type:String.t
) - The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details.Required.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.ToolResults.V1beta3.Model.ListStepAccessibilityClustersResponse{}}
on success{:error, info}
on failure
toolresults_steps_create(connection, project_id, history_id, execution_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.Step.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a Step.
The returned Step will have the id set.
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to write to project
- INVALID_ARGUMENT - if the request is malformed
- FAILED_PRECONDITION - if the step is too large (more than 10Mib)
- NOT_FOUND - if the containing Execution does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - Required. A Project id.history_id
(type:String.t
) - Required. A History id.execution_id
(type:String.t
) - Required. An Execution id.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").:requestId
(type:String.t
) - A unique request ID for server to detect duplicated requests. For example, a UUID.Optional, but strongly recommended.
:body
(type:GoogleApi.ToolResults.V1beta3.Model.Step.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.ToolResults.V1beta3.Model.Step{}}
on success{:error, info}
on failure
toolresults_steps_get(connection, project_id, history_id, execution_id, step_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.Step.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a Step.
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to read project
- INVALID_ARGUMENT - if the request is malformed
- NOT_FOUND - if the Step does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - A Project id.Required.
history_id
(type:String.t
) - A History id.Required.
execution_id
(type:String.t
) - A Execution id.Required.
step_id
(type:String.t
) - A Step 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.Step{}}
on success{:error, info}
on failure
toolresults_steps_get_perf_metrics_summary(connection, project_id, history_id, execution_id, step_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_get_perf_metrics_summary( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.PerfMetricsSummary.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a PerfMetricsSummary.
May return any of the following error code(s):
- NOT_FOUND - The specified PerfMetricsSummary does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The cloud projecthistory_id
(type:String.t
) - A tool results history ID.execution_id
(type:String.t
) - A tool results execution ID.step_id
(type:String.t
) - A tool results step ID.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.PerfMetricsSummary{}}
on success{:error, info}
on failure
toolresults_steps_list(connection, project_id, history_id, execution_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.ListStepsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists Steps for a given Execution.
The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time.
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to read project
- INVALID_ARGUMENT - if the request is malformed
FAILED_PRECONDITION - if an argument in the request happens to be
invalid; e.g. if an attempt is made to list the children of a nonexistent Step
- NOT_FOUND - if the containing Execution does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - A Project id.Required.
history_id
(type:String.t
) - A History id.Required.
execution_id
(type:String.t
) - A 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").:pageSize
(type:integer()
) - The maximum number of Steps to fetch.Default value: 25. The server will use this default if the field is not set or has a value of 0.
Optional.
:pageToken
(type:String.t
) - A continuation token to resume the query at the next item.Optional.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.ToolResults.V1beta3.Model.ListStepsResponse{}}
on success{:error, info}
on failure
toolresults_steps_patch(connection, project_id, history_id, execution_id, step_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.Step.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an existing Step with the supplied partial entity.
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to write project
- INVALID_ARGUMENT - if the request is malformed
FAILED_PRECONDITION - if the requested state transition is illegal
(e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib)
- NOT_FOUND - if the containing Execution does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - A Project id.Required.
history_id
(type:String.t
) - A History id.Required.
execution_id
(type:String.t
) - A Execution id.Required.
step_id
(type:String.t
) - A Step 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").:requestId
(type:String.t
) - A unique request ID for server to detect duplicated requests. For example, a UUID.Optional, but strongly recommended.
:body
(type:GoogleApi.ToolResults.V1beta3.Model.Step.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.ToolResults.V1beta3.Model.Step{}}
on success{:error, info}
on failure
toolresults_steps_publish_xunit_xml_files(connection, project_id, history_id, execution_id, step_id, optional_params \\ [], opts \\ [])
View Sourcetoolresults_steps_publish_xunit_xml_files( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.ToolResults.V1beta3.Model.Step.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Publish xml files to an existing Step.
May return any of the following canonical error codes:
- PERMISSION_DENIED - if the user is not authorized to write project
- INVALID_ARGUMENT - if the request is malformed
- FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large.
- NOT_FOUND - if the containing Execution does not exist
Parameters
connection
(type:GoogleApi.ToolResults.V1beta3.Connection.t
) - Connection to serverproject_id
(type:String.t
) - A Project id.Required.
history_id
(type:String.t
) - A History id.Required.
execution_id
(type:String.t
) - A Execution id.Required.
step_id
(type:String.t
) - A Step id. Note: This step must include a TestExecutionStep.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").:body
(type:GoogleApi.ToolResults.V1beta3.Model.PublishXunitXmlFilesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.ToolResults.V1beta3.Model.Step{}}
on success{:error, info}
on failure