com.google.api.services.keep.v1

Class Keep.Notes.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.keep.v1.KeepRequest<ListNotesResponse>

com.google.api.services.keep.v1.Keep.Notes.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Keep.Notes

public class Keep.Notes.List
extends KeepRequest<ListNotesResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List() Lists notes.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() Filter for list results.
Integer	getPageSize() The maximum number of results to return.
String	getPageToken() The previous page's `next_page_token` field.
Keep.Notes.List	set(String parameterName, Object value)
Keep.Notes.List	set$Xgafv(String $Xgafv) V1 error format.
Keep.Notes.List	setAccessToken(String accessToken) OAuth access token.
Keep.Notes.List	setAlt(String alt) Data format for response.
Keep.Notes.List	setCallback(String callback) JSONP
Keep.Notes.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Keep.Notes.List	setFilter(String filter) Filter for list results.
Keep.Notes.List	setKey(String key) API key.
Keep.Notes.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Keep.Notes.List	setPageSize(Integer pageSize) The maximum number of results to return.
Keep.Notes.List	setPageToken(String pageToken) The previous page's `next_page_token` field.
Keep.Notes.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Keep.Notes.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Keep.Notes.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Keep.Notes.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.keep.v1.KeepRequest

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()

Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error. Create a request for the method "notes.list". This request holds the parameters needed by the the keep server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

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<ListNotesResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Keep.Notes.List set$Xgafv(String $Xgafv)

Description copied from class: KeepRequest

V1 error format.

Overrides:

set$Xgafv in class KeepRequest<ListNotesResponse>

setAccessToken

public Keep.Notes.List setAccessToken(String accessToken)

Description copied from class: KeepRequest

OAuth access token.

Overrides:

setAccessToken in class KeepRequest<ListNotesResponse>

setAlt

public Keep.Notes.List setAlt(String alt)

Description copied from class: KeepRequest

Data format for response.

Overrides:

setAlt in class KeepRequest<ListNotesResponse>

setCallback

public Keep.Notes.List setCallback(String callback)

Description copied from class: KeepRequest

JSONP

Overrides:

setCallback in class KeepRequest<ListNotesResponse>

setFields

public Keep.Notes.List setFields(String fields)

Description copied from class: KeepRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class KeepRequest<ListNotesResponse>

setKey

public Keep.Notes.List setKey(String key)

Description copied from class: KeepRequest

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 KeepRequest<ListNotesResponse>

setOauthToken

public Keep.Notes.List setOauthToken(String oauthToken)

Description copied from class: KeepRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class KeepRequest<ListNotesResponse>

setPrettyPrint

public Keep.Notes.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: KeepRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class KeepRequest<ListNotesResponse>

setQuotaUser

public Keep.Notes.List setQuotaUser(String quotaUser)

Description copied from class: KeepRequest

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 KeepRequest<ListNotesResponse>

setUploadType

public Keep.Notes.List setUploadType(String uploadType)

Description copied from class: KeepRequest

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

Overrides:

setUploadType in class KeepRequest<ListNotesResponse>

setUploadProtocol

public Keep.Notes.List setUploadProtocol(String uploadProtocol)

Description copied from class: KeepRequest

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

Overrides:

setUploadProtocol in class KeepRequest<ListNotesResponse>

getFilter

public String getFilter()

Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160).

setFilter

public Keep.Notes.List setFilter(String filter)

Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160).

getPageSize

public Integer getPageSize()

The maximum number of results to return.

setPageSize

public Keep.Notes.List setPageSize(Integer pageSize)

The maximum number of results to return.

getPageToken

public String getPageToken()

The previous page's `next_page_token` field.

setPageToken

public Keep.Notes.List setPageToken(String pageToken)

The previous page's `next_page_token` field.

set

public Keep.Notes.List set(String parameterName,
                           Object value)

Overrides:

set in class KeepRequest<ListNotesResponse>