# Cloud Tool Results firstparty API . projects . histories . executions . steps . perfSampleSeries

## Instance Methods

Returns the samples Resource.

Creates a PerfSampleSeries.

Gets a PerfSampleSeries.

Lists PerfSampleSeries for a given Step.

### Method Details

`create(projectId, historyId, executionId, stepId, body)`

    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

    Args:
      projectId: string, The cloud project (required)
      historyId: string, A tool results history ID. (required)
      executionId: string, A tool results execution ID. (required)
      stepId: string, A tool results step ID. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Resource representing a collection of performance samples (or data points)
        "stepId": "A String", # A tool results step ID.
        "projectId": "A String", # The cloud project
        "sampleSeriesId": "A String", # A sample series id
        "historyId": "A String", # A tool results history ID.
        "executionId": "A String", # A tool results execution ID.
        "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
          "sampleSeriesLabel": "A String",
          "perfUnit": "A String",
          "perfMetricType": "A String",
        },
      }

    Returns:
      An object of the form:

        { # Resource representing a collection of performance samples (or data points)
          "stepId": "A String", # A tool results step ID.
          "projectId": "A String", # The cloud project
          "sampleSeriesId": "A String", # A sample series id
          "historyId": "A String", # A tool results history ID.
          "executionId": "A String", # A tool results execution ID.
          "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
            "sampleSeriesLabel": "A String",
            "perfUnit": "A String",
            "perfMetricType": "A String",
          },
        }

`get(projectId, historyId, executionId, stepId, sampleSeriesId)`

    Gets a PerfSampleSeries.

    May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist

    Args:
      projectId: string, The cloud project (required)
      historyId: string, A tool results history ID. (required)
      executionId: string, A tool results execution ID. (required)
      stepId: string, A tool results step ID. (required)
      sampleSeriesId: string, A sample series id (required)

    Returns:
      An object of the form:

        { # Resource representing a collection of performance samples (or data points)
          "stepId": "A String", # A tool results step ID.
          "projectId": "A String", # The cloud project
          "sampleSeriesId": "A String", # A sample series id
          "historyId": "A String", # A tool results history ID.
          "executionId": "A String", # A tool results execution ID.
          "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
            "sampleSeriesLabel": "A String",
            "perfUnit": "A String",
            "perfMetricType": "A String",
          },
        }

`list(projectId, historyId, executionId, stepId, filter=None)`

    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

    Args:
      projectId: string, The cloud project (required)
      historyId: string, A tool results history ID. (required)
      executionId: string, A tool results execution ID. (required)
      stepId: string, A tool results step ID. (required)
      filter: string, Specify one or more PerfMetricType values such as CPU to filter the result (repeated)
        Allowed values
          cpu -
          graphics -
          memory -
          network -
          perfMetricTypeUnspecified -

    Returns:
      An object of the form:

        {
        "perfSampleSeries": [ # The resulting PerfSampleSeries sorted by id
          { # Resource representing a collection of performance samples (or data points)
              "stepId": "A String", # A tool results step ID.
              "projectId": "A String", # The cloud project
              "sampleSeriesId": "A String", # A sample series id
              "historyId": "A String", # A tool results history ID.
              "executionId": "A String", # A tool results execution ID.
              "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
                "sampleSeriesLabel": "A String",
                "perfUnit": "A String",
                "perfMetricType": "A String",
              },
            },
        ],
      }