com.google.api.services.toolresults

Class ToolResults.Steps.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<ListStepsResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ToolResults.Steps

public class ToolResults.Steps.List
extends ToolResultsRequest<ListStepsResponse>

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) Lists Steps for a given Execution.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getExecutionId() A Execution id.
String	getHistoryId() A History id.
Integer	getPageSize() The maximum number of Steps to fetch.
String	getPageToken() A continuation token to resume the query at the next item.
String	getProjectId() A Project id.
ToolResults.Steps.List	set(String parameterName, Object value)
ToolResults.Steps.List	set$Xgafv(String $Xgafv) V1 error format.
ToolResults.Steps.List	setAccessToken(String accessToken) OAuth access token.
ToolResults.Steps.List	setAlt(String alt) Data format for response.
ToolResults.Steps.List	setCallback(String callback) JSONP
ToolResults.Steps.List	setExecutionId(String executionId) A Execution id.
ToolResults.Steps.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ToolResults.Steps.List	setHistoryId(String historyId) A History id.
ToolResults.Steps.List	setKey(String key) API key.
ToolResults.Steps.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ToolResults.Steps.List	setPageSize(Integer pageSize) The maximum number of Steps to fetch.
ToolResults.Steps.List	setPageToken(String pageToken) A continuation token to resume the query at the next item.
ToolResults.Steps.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ToolResults.Steps.List	setProjectId(String projectId) A Project id.
ToolResults.Steps.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ToolResults.Steps.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ToolResults.Steps.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)

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 Create a request for the method "steps.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 - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListStepsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListStepsResponse>

Throws:

IOException

set$Xgafv

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

Description copied from class: ToolResultsRequest

V1 error format.

Overrides:

set$Xgafv in class ToolResultsRequest<ListStepsResponse>

setAccessToken

public ToolResults.Steps.List setAccessToken(String accessToken)

Description copied from class: ToolResultsRequest

OAuth access token.

Overrides:

setAccessToken in class ToolResultsRequest<ListStepsResponse>

setAlt

public ToolResults.Steps.List setAlt(String alt)

Description copied from class: ToolResultsRequest

Data format for response.

Overrides:

setAlt in class ToolResultsRequest<ListStepsResponse>

setCallback

public ToolResults.Steps.List setCallback(String callback)

Description copied from class: ToolResultsRequest

JSONP

Overrides:

setCallback in class ToolResultsRequest<ListStepsResponse>

setFields

public ToolResults.Steps.List setFields(String fields)

Description copied from class: ToolResultsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ToolResultsRequest<ListStepsResponse>

setKey

public ToolResults.Steps.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<ListStepsResponse>

setOauthToken

public ToolResults.Steps.List setOauthToken(String oauthToken)

Description copied from class: ToolResultsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ToolResultsRequest<ListStepsResponse>

setPrettyPrint

public ToolResults.Steps.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ToolResultsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ToolResultsRequest<ListStepsResponse>

setQuotaUser

public ToolResults.Steps.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<ListStepsResponse>

setUploadType

public ToolResults.Steps.List setUploadType(String uploadType)

Description copied from class: ToolResultsRequest

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

Overrides:

setUploadType in class ToolResultsRequest<ListStepsResponse>

setUploadProtocol

public ToolResults.Steps.List setUploadProtocol(String uploadProtocol)

Description copied from class: ToolResultsRequest

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

Overrides:

setUploadProtocol in class ToolResultsRequest<ListStepsResponse>

getProjectId

public String getProjectId()

A Project id. Required.

setProjectId

public ToolResults.Steps.List setProjectId(String projectId)

A Project id. Required.

getHistoryId

public String getHistoryId()

A History id. Required.

setHistoryId

public ToolResults.Steps.List setHistoryId(String historyId)

A History id. Required.

getExecutionId

public String getExecutionId()

A Execution id. Required.

setExecutionId

public ToolResults.Steps.List setExecutionId(String executionId)

A Execution id. Required.

getPageSize

public Integer getPageSize()

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.

setPageSize

public ToolResults.Steps.List setPageSize(Integer pageSize)

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.

getPageToken

public String getPageToken()

A continuation token to resume the query at the next item. Optional.

setPageToken

public ToolResults.Steps.List setPageToken(String pageToken)

A continuation token to resume the query at the next item. Optional.

set

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

Overrides:

set in class ToolResultsRequest<ListStepsResponse>