google_api_tool_results v0.23.3 GoogleApi.ToolResults.V1beta3.Api.PerfSampleSeries View Source

API calls for all endpoints tagged PerfSampleSeries.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

toolresults_perf_sample_series_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ToolResults.V1beta3.Model.PerfSampleSeries.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a PerfSampleSeries.

May return any of the following error code(s):

  • ALREADY_EXISTS - PerfMetricSummary already exists for the given Step
  • NOT_FOUND - The containing Step does not exist

Parameters

  • connection (type: GoogleApi.ToolResults.V1beta3.Connection.t) - Connection to server
  • project_id (type: String.t) - The cloud project
  • history_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").
    • :body (type: GoogleApi.ToolResults.V1beta3.Model.PerfSampleSeries.t) -
  • opts (type: keyword()) - Call options

Returns

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

toolresults_perf_sample_series_get(connection, project_id, history_id, execution_id, step_id, sample_series_id, optional_params \\ [], opts \\ [])

View Source

Specs

toolresults_perf_sample_series_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ToolResults.V1beta3.Model.PerfSampleSeries.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a PerfSampleSeries.

May return any of the following error code(s):

  • NOT_FOUND - The specified PerfSampleSeries does not exist

Parameters

  • connection (type: GoogleApi.ToolResults.V1beta3.Connection.t) - Connection to server
  • project_id (type: String.t) - The cloud project
  • history_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.
  • sample_series_id (type: String.t) - A sample series 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.PerfSampleSeries{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

toolresults_perf_sample_series_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ToolResults.V1beta3.Model.ListPerfSampleSeriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists PerfSampleSeries for a given Step.

The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids.

May return any of the following canonical error codes:

  • NOT_FOUND - The containing Step does not exist

Parameters

  • connection (type: GoogleApi.ToolResults.V1beta3.Connection.t) - Connection to server
  • project_id (type: String.t) - The cloud project
  • history_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").
    • :filter (type: list(String.t)) - Specify one or more PerfMetricType values such as CPU to filter the result
  • opts (type: keyword()) - Call options

Returns

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