com.google.api.services.sql

Class SQLAdmin.Instances.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.sql.SQLAdminRequest<InstancesListResponse>

com.google.api.services.sql.SQLAdmin.Instances.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

SQLAdmin.Instances

public class SQLAdmin.Instances.List
extends SQLAdminRequest<InstancesListResponse>

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 project) Lists instances under a given project.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getFilter() A filter expression that filters resources listed in the response.
Long	getMaxResults() The maximum number of results to return per response.
String	getPageToken() A previously-returned page token representing part of the larger set of results to view.
String	getProject() Project ID of the project for which to list Cloud SQL instances.
SQLAdmin.Instances.List	set(String parameterName, Object value)
SQLAdmin.Instances.List	set$Xgafv(String $Xgafv) V1 error format.
SQLAdmin.Instances.List	setAccessToken(String accessToken) OAuth access token.
SQLAdmin.Instances.List	setAlt(String alt) Data format for response.
SQLAdmin.Instances.List	setCallback(String callback) JSONP
SQLAdmin.Instances.List	setFields(String fields) Selector specifying which fields to include in a partial response.
SQLAdmin.Instances.List	setFilter(String filter) A filter expression that filters resources listed in the response.
SQLAdmin.Instances.List	setKey(String key) API key.
SQLAdmin.Instances.List	setMaxResults(Long maxResults) The maximum number of results to return per response.
SQLAdmin.Instances.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
SQLAdmin.Instances.List	setPageToken(String pageToken) A previously-returned page token representing part of the larger set of results to view.
SQLAdmin.Instances.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
SQLAdmin.Instances.List	setProject(String project) Project ID of the project for which to list Cloud SQL instances.
SQLAdmin.Instances.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
SQLAdmin.Instances.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
SQLAdmin.Instances.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.sql.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

List

protected List(String project)

Lists instances under a given project. Create a request for the method "instances.list". This request holds the parameters needed by the the sql 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:

project - Project ID of the project for which to list Cloud SQL instances.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<InstancesListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<InstancesListResponse>

Throws:

IOException

set$Xgafv

public SQLAdmin.Instances.List set$Xgafv(String $Xgafv)

Description copied from class: SQLAdminRequest

V1 error format.

Overrides:

set$Xgafv in class SQLAdminRequest<InstancesListResponse>

setAccessToken

public SQLAdmin.Instances.List setAccessToken(String accessToken)

Description copied from class: SQLAdminRequest

OAuth access token.

Overrides:

setAccessToken in class SQLAdminRequest<InstancesListResponse>

setAlt

public SQLAdmin.Instances.List setAlt(String alt)

Description copied from class: SQLAdminRequest

Data format for response.

Overrides:

setAlt in class SQLAdminRequest<InstancesListResponse>

setCallback

public SQLAdmin.Instances.List setCallback(String callback)

Description copied from class: SQLAdminRequest

JSONP

Overrides:

setCallback in class SQLAdminRequest<InstancesListResponse>

setFields

public SQLAdmin.Instances.List setFields(String fields)

Description copied from class: SQLAdminRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SQLAdminRequest<InstancesListResponse>

setKey

public SQLAdmin.Instances.List 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<InstancesListResponse>

setOauthToken

public SQLAdmin.Instances.List setOauthToken(String oauthToken)

Description copied from class: SQLAdminRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SQLAdminRequest<InstancesListResponse>

setPrettyPrint

public SQLAdmin.Instances.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: SQLAdminRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SQLAdminRequest<InstancesListResponse>

setQuotaUser

public SQLAdmin.Instances.List 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<InstancesListResponse>

setUploadType

public SQLAdmin.Instances.List setUploadType(String uploadType)

Description copied from class: SQLAdminRequest

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

Overrides:

setUploadType in class SQLAdminRequest<InstancesListResponse>

setUploadProtocol

public SQLAdmin.Instances.List setUploadProtocol(String uploadProtocol)

Description copied from class: SQLAdminRequest

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

Overrides:

setUploadProtocol in class SQLAdminRequest<InstancesListResponse>

getProject

public String getProject()

Project ID of the project for which to list Cloud SQL instances.

setProject

public SQLAdmin.Instances.List setProject(String project)

Project ID of the project for which to list Cloud SQL instances.

getFilter

public String getFilter()

A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

setFilter

public SQLAdmin.Instances.List setFilter(String filter)

A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

getMaxResults

public Long getMaxResults()

The maximum number of results to return per response.

setMaxResults

public SQLAdmin.Instances.List setMaxResults(Long maxResults)

The maximum number of results to return per response.

getPageToken

public String getPageToken()

A previously-returned page token representing part of the larger set of results to view.

setPageToken

public SQLAdmin.Instances.List setPageToken(String pageToken)

A previously-returned page token representing part of the larger set of results to view.

set

public SQLAdmin.Instances.List set(String parameterName,
                                   Object value)

Overrides:

set in class SQLAdminRequest<InstancesListResponse>