com.google.api.services.toolresults

Class ToolResults.Projects.Histories.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<ListHistoriesResponse>

com.google.api.services.toolresults.ToolResults.Projects.Histories.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ToolResults.Projects.Histories

public class ToolResults.Projects.Histories.List
extends ToolResultsRequest<ListHistoriesResponse>

Nested Class Summary

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

com.google.api.client.util.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) Lists Histories for a given Project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilterByName() If set, only return histories with the given name.
Integer	getPageSize() The maximum number of Histories to fetch.
String	getPageToken() A continuation token to resume the query at the next item.
String	getProjectId() A Project id.
ToolResults.Projects.Histories.List	set(String parameterName, Object value)
ToolResults.Projects.Histories.List	setAlt(String alt) Data format for the response.
ToolResults.Projects.Histories.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ToolResults.Projects.Histories.List	setFilterByName(String filterByName) If set, only return histories with the given name.
ToolResults.Projects.Histories.List	setKey(String key) API key.
ToolResults.Projects.Histories.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ToolResults.Projects.Histories.List	setPageSize(Integer pageSize) The maximum number of Histories to fetch.
ToolResults.Projects.Histories.List	setPageToken(String pageToken) A continuation token to resume the query at the next item.
ToolResults.Projects.Histories.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ToolResults.Projects.Histories.List	setProjectId(String projectId) A Project id.
ToolResults.Projects.Histories.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
ToolResults.Projects.Histories.List	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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)

Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification 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 - NOT_FOUND - if the History does not exist Create a request for the method "histories.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.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHistoriesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHistoriesResponse>

Throws:

IOException

setAlt

public ToolResults.Projects.Histories.List setAlt(String alt)

Description copied from class: ToolResultsRequest

Data format for the response.

Overrides:

setAlt in class ToolResultsRequest<ListHistoriesResponse>

setFields

public ToolResults.Projects.Histories.List setFields(String fields)

Description copied from class: ToolResultsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ToolResultsRequest<ListHistoriesResponse>

setKey

public ToolResults.Projects.Histories.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<ListHistoriesResponse>

setOauthToken

public ToolResults.Projects.Histories.List setOauthToken(String oauthToken)

Description copied from class: ToolResultsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ToolResultsRequest<ListHistoriesResponse>

setPrettyPrint

public ToolResults.Projects.Histories.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ToolResultsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ToolResultsRequest<ListHistoriesResponse>

setQuotaUser

public ToolResults.Projects.Histories.List setQuotaUser(String quotaUser)

Description copied from class: ToolResultsRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ToolResultsRequest<ListHistoriesResponse>

setUserIp

public ToolResults.Projects.Histories.List setUserIp(String userIp)

Description copied from class: ToolResultsRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ToolResultsRequest<ListHistoriesResponse>

getProjectId

public String getProjectId()

A Project id. Required.

setProjectId

public ToolResults.Projects.Histories.List setProjectId(String projectId)

A Project id. Required.

getFilterByName

public String getFilterByName()

If set, only return histories with the given name. Optional.

setFilterByName

public ToolResults.Projects.Histories.List setFilterByName(String filterByName)

If set, only return histories with the given name. Optional.

getPageSize

public Integer getPageSize()

The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional.

setPageSize

public ToolResults.Projects.Histories.List setPageSize(Integer pageSize)

The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional.

getPageToken

public String getPageToken()

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

setPageToken

public ToolResults.Projects.Histories.List setPageToken(String pageToken)

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

set

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

Overrides:

set in class ToolResultsRequest<ListHistoriesResponse>