com.google.api.services.sqladmin

Class SQLAdmin.Backups.ListBackups

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.sqladmin.SQLAdminRequest<ListBackupsResponse>

com.google.api.services.sqladmin.SQLAdmin.Backups.ListBackups

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

SQLAdmin.Backups

public class SQLAdmin.Backups.ListBackups
extends SQLAdminRequest<ListBackupsResponse>

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	ListBackups(String parent) Lists all backups associated with the project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() Multiple filter queries are separated by spaces.
Integer	getPageSize() The maximum number of backups to return per response.
String	getPageToken() A page token, received from a previous `ListBackups` call.
String	getParent() Required.
SQLAdmin.Backups.ListBackups	set(String parameterName, Object value)
SQLAdmin.Backups.ListBackups	set$Xgafv(String $Xgafv) V1 error format.
SQLAdmin.Backups.ListBackups	setAccessToken(String accessToken) OAuth access token.
SQLAdmin.Backups.ListBackups	setAlt(String alt) Data format for response.
SQLAdmin.Backups.ListBackups	setCallback(String callback) JSONP
SQLAdmin.Backups.ListBackups	setFields(String fields) Selector specifying which fields to include in a partial response.
SQLAdmin.Backups.ListBackups	setFilter(String filter) Multiple filter queries are separated by spaces.
SQLAdmin.Backups.ListBackups	setKey(String key) API key.
SQLAdmin.Backups.ListBackups	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
SQLAdmin.Backups.ListBackups	setPageSize(Integer pageSize) The maximum number of backups to return per response.
SQLAdmin.Backups.ListBackups	setPageToken(String pageToken) A page token, received from a previous `ListBackups` call.
SQLAdmin.Backups.ListBackups	setParent(String parent) Required.
SQLAdmin.Backups.ListBackups	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
SQLAdmin.Backups.ListBackups	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
SQLAdmin.Backups.ListBackups	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
SQLAdmin.Backups.ListBackups	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.sqladmin.SQLAdminRequest

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

ListBackups

protected ListBackups(String parent)

Lists all backups associated with the project. Create a request for the method "backups.listBackups". This request holds the parameters needed by the the sqladmin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

parent - Required. The parent that owns this collection of backups. Format: projects/{project}

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public SQLAdmin.Backups.ListBackups set$Xgafv(String $Xgafv)

Description copied from class: SQLAdminRequest

V1 error format.

Overrides:

set$Xgafv in class SQLAdminRequest<ListBackupsResponse>

setAccessToken

public SQLAdmin.Backups.ListBackups setAccessToken(String accessToken)

Description copied from class: SQLAdminRequest

OAuth access token.

Overrides:

setAccessToken in class SQLAdminRequest<ListBackupsResponse>

setAlt

public SQLAdmin.Backups.ListBackups setAlt(String alt)

Description copied from class: SQLAdminRequest

Data format for response.

Overrides:

setAlt in class SQLAdminRequest<ListBackupsResponse>

setCallback

public SQLAdmin.Backups.ListBackups setCallback(String callback)

Description copied from class: SQLAdminRequest

JSONP

Overrides:

setCallback in class SQLAdminRequest<ListBackupsResponse>

setFields

public SQLAdmin.Backups.ListBackups setFields(String fields)

Description copied from class: SQLAdminRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SQLAdminRequest<ListBackupsResponse>

setKey

public SQLAdmin.Backups.ListBackups setKey(String key)

Description copied from class: SQLAdminRequest

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 SQLAdminRequest<ListBackupsResponse>

setOauthToken

public SQLAdmin.Backups.ListBackups setOauthToken(String oauthToken)

Description copied from class: SQLAdminRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SQLAdminRequest<ListBackupsResponse>

setPrettyPrint

public SQLAdmin.Backups.ListBackups setPrettyPrint(Boolean prettyPrint)

Description copied from class: SQLAdminRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SQLAdminRequest<ListBackupsResponse>

setQuotaUser

public SQLAdmin.Backups.ListBackups setQuotaUser(String quotaUser)

Description copied from class: SQLAdminRequest

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 SQLAdminRequest<ListBackupsResponse>

setUploadType

public SQLAdmin.Backups.ListBackups setUploadType(String uploadType)

Description copied from class: SQLAdminRequest

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

Overrides:

setUploadType in class SQLAdminRequest<ListBackupsResponse>

setUploadProtocol

public SQLAdmin.Backups.ListBackups setUploadProtocol(String uploadProtocol)

Description copied from class: SQLAdminRequest

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

Overrides:

setUploadProtocol in class SQLAdminRequest<ListBackupsResponse>

getParent

public String getParent()

Required. The parent that owns this collection of backups. Format: projects/{project}

setParent

public SQLAdmin.Backups.ListBackups setParent(String parent)

Required. The parent that owns this collection of backups. Format: projects/{project}

getFilter

public String getFilter()

Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.

setFilter

public SQLAdmin.Backups.ListBackups setFilter(String filter)

Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.

getPageSize

public Integer getPageSize()

The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.

setPageSize

public SQLAdmin.Backups.ListBackups setPageSize(Integer pageSize)

The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.

getPageToken

public String getPageToken()

A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.

setPageToken

public SQLAdmin.Backups.ListBackups setPageToken(String pageToken)

A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.

set

public SQLAdmin.Backups.ListBackups set(String parameterName,
                                        Object value)

Overrides:

set in class SQLAdminRequest<ListBackupsResponse>