com.google.api.services.sqladmin

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

com.google.api.services.sqladmin.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 in the alphabetical order of the instance name.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getFilter() An expression for filtering the results of the request, such as by name or label.
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	setAlt(String alt) Data format for the response.
SQLAdmin.Instances.List	setFields(String fields) Selector specifying which fields to include in a partial response.
SQLAdmin.Instances.List	setFilter(String filter) An expression for filtering the results of the request, such as by name or label.
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) An opaque string that represents a user for quota purposes.
SQLAdmin.Instances.List	setUserIp(String userIp) Deprecated.

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

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, 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 in the alphabetical order of the instance name. Create a request for the method "instances.list". 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:

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

setAlt

public SQLAdmin.Instances.List setAlt(String alt)

Description copied from class: SQLAdminRequest

Data format for the response.

Overrides:

setAlt 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

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

Overrides:

setQuotaUser in class SQLAdminRequest<InstancesListResponse>

setUserIp

public SQLAdmin.Instances.List setUserIp(String userIp)

Description copied from class: SQLAdminRequest

Deprecated. Please use quotaUser instead.

Overrides:

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

An expression for filtering the results of the request, such as by name or label.

setFilter

public SQLAdmin.Instances.List setFilter(String filter)

An expression for filtering the results of the request, such as by name or label.

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>