com.google.api.services.toolresults

Class ToolResults.Samples.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.toolresults.ToolResultsRequest<ListPerfSamplesResponse>

com.google.api.services.toolresults.ToolResults.Samples.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ToolResults.Samples

public class ToolResults.Samples.List
extends ToolResultsRequest<ListPerfSamplesResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

List(String projectId, String historyId, String executionId, String stepId, String sampleSeriesId) Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist Create a request for the method "samples.list".

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getExecutionId() A tool results execution ID.
String	getHistoryId() A tool results history ID.
Integer	getPageSize() The default page size is 500 samples, and the maximum size is 5000.
String	getPageToken() Optional, the next_page_token returned in the previous response
String	getProjectId() The cloud project
String	getSampleSeriesId() A sample series id
String	getStepId() A tool results step ID.
ToolResults.Samples.List	set(String parameterName, Object value)
ToolResults.Samples.List	set$Xgafv(String $Xgafv) V1 error format.
ToolResults.Samples.List	setAccessToken(String accessToken) OAuth access token.
ToolResults.Samples.List	setAlt(String alt) Data format for response.
ToolResults.Samples.List	setCallback(String callback) JSONP
ToolResults.Samples.List	setExecutionId(String executionId) A tool results execution ID.
ToolResults.Samples.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ToolResults.Samples.List	setHistoryId(String historyId) A tool results history ID.
ToolResults.Samples.List	setKey(String key) API key.
ToolResults.Samples.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ToolResults.Samples.List	setPageSize(Integer pageSize) The default page size is 500 samples, and the maximum size is 5000.
ToolResults.Samples.List	setPageToken(String pageToken) Optional, the next_page_token returned in the previous response
ToolResults.Samples.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ToolResults.Samples.List	setProjectId(String projectId) The cloud project
ToolResults.Samples.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ToolResults.Samples.List	setSampleSeriesId(String sampleSeriesId) A sample series id
ToolResults.Samples.List	setStepId(String stepId) A tool results step ID.
ToolResults.Samples.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ToolResults.Samples.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.toolresults.ToolResultsRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String projectId,
               String historyId,
               String executionId,
               String stepId,
               String sampleSeriesId)

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist Create a request for the method "samples.list". This request holds the parameters needed by the the toolresults server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ToolResults.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

projectId - The cloud project

historyId - A tool results history ID.

executionId - A tool results execution ID.

stepId - A tool results step ID.

sampleSeriesId - A sample series id

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListPerfSamplesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListPerfSamplesResponse>

Throws:

IOException

set$Xgafv

public ToolResults.Samples.List set$Xgafv(String $Xgafv)

Description copied from class: ToolResultsRequest

V1 error format.

Overrides:

set$Xgafv in class ToolResultsRequest<ListPerfSamplesResponse>

setAccessToken

public ToolResults.Samples.List setAccessToken(String accessToken)

Description copied from class: ToolResultsRequest

OAuth access token.

Overrides:

setAccessToken in class ToolResultsRequest<ListPerfSamplesResponse>

setAlt

public ToolResults.Samples.List setAlt(String alt)

Description copied from class: ToolResultsRequest

Data format for response.

Overrides:

setAlt in class ToolResultsRequest<ListPerfSamplesResponse>

setCallback

public ToolResults.Samples.List setCallback(String callback)

Description copied from class: ToolResultsRequest

JSONP

Overrides:

setCallback in class ToolResultsRequest<ListPerfSamplesResponse>

setFields

public ToolResults.Samples.List setFields(String fields)

Description copied from class: ToolResultsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ToolResultsRequest<ListPerfSamplesResponse>

setKey

public ToolResults.Samples.List setKey(String key)

Description copied from class: ToolResultsRequest

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.

Overrides:

setKey in class ToolResultsRequest<ListPerfSamplesResponse>

setOauthToken

public ToolResults.Samples.List setOauthToken(String oauthToken)

Description copied from class: ToolResultsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ToolResultsRequest<ListPerfSamplesResponse>

setPrettyPrint

public ToolResults.Samples.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ToolResultsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ToolResultsRequest<ListPerfSamplesResponse>

setQuotaUser

public ToolResults.Samples.List setQuotaUser(String quotaUser)

Description copied from class: ToolResultsRequest

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.

Overrides:

setQuotaUser in class ToolResultsRequest<ListPerfSamplesResponse>

setUploadType

public ToolResults.Samples.List setUploadType(String uploadType)

Description copied from class: ToolResultsRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ToolResultsRequest<ListPerfSamplesResponse>

setUploadProtocol

public ToolResults.Samples.List setUploadProtocol(String uploadProtocol)

Description copied from class: ToolResultsRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ToolResultsRequest<ListPerfSamplesResponse>

getProjectId

public String getProjectId()

The cloud project

setProjectId

public ToolResults.Samples.List setProjectId(String projectId)

The cloud project

getHistoryId

public String getHistoryId()

A tool results history ID.

setHistoryId

public ToolResults.Samples.List setHistoryId(String historyId)

A tool results history ID.

getExecutionId

public String getExecutionId()

A tool results execution ID.

setExecutionId

public ToolResults.Samples.List setExecutionId(String executionId)

A tool results execution ID.

getStepId

public String getStepId()

A tool results step ID.

setStepId

public ToolResults.Samples.List setStepId(String stepId)

A tool results step ID.

getSampleSeriesId

public String getSampleSeriesId()

A sample series id

setSampleSeriesId

public ToolResults.Samples.List setSampleSeriesId(String sampleSeriesId)

A sample series id

getPageSize

public Integer getPageSize()

The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

setPageSize

public ToolResults.Samples.List setPageSize(Integer pageSize)

The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

getPageToken

public String getPageToken()

Optional, the next_page_token returned in the previous response

setPageToken

public ToolResults.Samples.List setPageToken(String pageToken)

Optional, the next_page_token returned in the previous response

set

public ToolResults.Samples.List set(String parameterName,
                                    Object value)

Overrides:

set in class ToolResultsRequest<ListPerfSamplesResponse>