com.google.api.services.storagetransfer.v1

Class Storagetransfer.Projects.AgentPools.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.storagetransfer.v1.StoragetransferRequest<ListAgentPoolsResponse>

com.google.api.services.storagetransfer.v1.Storagetransfer.Projects.AgentPools.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storagetransfer.Projects.AgentPools

public class Storagetransfer.Projects.AgentPools.List
extends StoragetransferRequest<ListAgentPoolsResponse>

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(String projectId) Lists agent pools.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values, its values must be specified with array notation.
Integer	getPageSize() The list page size.
String	getPageToken() The list page token.
String	getProjectId() Required.
Storagetransfer.Projects.AgentPools.List	set(String parameterName, Object value)
Storagetransfer.Projects.AgentPools.List	set$Xgafv(String $Xgafv) V1 error format.
Storagetransfer.Projects.AgentPools.List	setAccessToken(String accessToken) OAuth access token.
Storagetransfer.Projects.AgentPools.List	setAlt(String alt) Data format for response.
Storagetransfer.Projects.AgentPools.List	setCallback(String callback) JSONP
Storagetransfer.Projects.AgentPools.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Storagetransfer.Projects.AgentPools.List	setFilter(String filter) An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values, its values must be specified with array notation.
Storagetransfer.Projects.AgentPools.List	setKey(String key) API key.
Storagetransfer.Projects.AgentPools.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storagetransfer.Projects.AgentPools.List	setPageSize(Integer pageSize) The list page size.
Storagetransfer.Projects.AgentPools.List	setPageToken(String pageToken) The list page token.
Storagetransfer.Projects.AgentPools.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storagetransfer.Projects.AgentPools.List	setProjectId(String projectId) Required.
Storagetransfer.Projects.AgentPools.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Storagetransfer.Projects.AgentPools.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Storagetransfer.Projects.AgentPools.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.storagetransfer.v1.StoragetransferRequest

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

Lists agent pools. Create a request for the method "agentPools.list". This request holds the parameters needed by the the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

projectId - Required. The ID of the Google Cloud project that owns the job.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Storagetransfer.Projects.AgentPools.List set$Xgafv(String $Xgafv)

Description copied from class: StoragetransferRequest

V1 error format.

Overrides:

set$Xgafv in class StoragetransferRequest<ListAgentPoolsResponse>

setAccessToken

public Storagetransfer.Projects.AgentPools.List setAccessToken(String accessToken)

Description copied from class: StoragetransferRequest

OAuth access token.

Overrides:

setAccessToken in class StoragetransferRequest<ListAgentPoolsResponse>

setAlt

public Storagetransfer.Projects.AgentPools.List setAlt(String alt)

Description copied from class: StoragetransferRequest

Data format for response.

Overrides:

setAlt in class StoragetransferRequest<ListAgentPoolsResponse>

setCallback

public Storagetransfer.Projects.AgentPools.List setCallback(String callback)

Description copied from class: StoragetransferRequest

JSONP

Overrides:

setCallback in class StoragetransferRequest<ListAgentPoolsResponse>

setFields

public Storagetransfer.Projects.AgentPools.List setFields(String fields)

Description copied from class: StoragetransferRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StoragetransferRequest<ListAgentPoolsResponse>

setKey

public Storagetransfer.Projects.AgentPools.List setKey(String key)

Description copied from class: StoragetransferRequest

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 StoragetransferRequest<ListAgentPoolsResponse>

setOauthToken

public Storagetransfer.Projects.AgentPools.List setOauthToken(String oauthToken)

Description copied from class: StoragetransferRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StoragetransferRequest<ListAgentPoolsResponse>

setPrettyPrint

public Storagetransfer.Projects.AgentPools.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: StoragetransferRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StoragetransferRequest<ListAgentPoolsResponse>

setQuotaUser

public Storagetransfer.Projects.AgentPools.List setQuotaUser(String quotaUser)

Description copied from class: StoragetransferRequest

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 StoragetransferRequest<ListAgentPoolsResponse>

setUploadType

public Storagetransfer.Projects.AgentPools.List setUploadType(String uploadType)

Description copied from class: StoragetransferRequest

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

Overrides:

setUploadType in class StoragetransferRequest<ListAgentPoolsResponse>

setUploadProtocol

public Storagetransfer.Projects.AgentPools.List setUploadProtocol(String uploadProtocol)

Description copied from class: StoragetransferRequest

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

Overrides:

setUploadProtocol in class StoragetransferRequest<ListAgentPoolsResponse>

getProjectId

public String getProjectId()

Required. The ID of the Google Cloud project that owns the job.

setProjectId

public Storagetransfer.Projects.AgentPools.List setProjectId(String projectId)

Required. The ID of the Google Cloud project that owns the job.

getFilter

public String getFilter()

An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

setFilter

public Storagetransfer.Projects.AgentPools.List setFilter(String filter)

An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

getPageSize

public Integer getPageSize()

The list page size. The max allowed value is `256`.

setPageSize

public Storagetransfer.Projects.AgentPools.List setPageSize(Integer pageSize)

The list page size. The max allowed value is `256`.

getPageToken

public String getPageToken()

The list page token.

setPageToken

public Storagetransfer.Projects.AgentPools.List setPageToken(String pageToken)

The list page token.

set

public Storagetransfer.Projects.AgentPools.List set(String parameterName,
                                                    Object value)

Overrides:

set in class StoragetransferRequest<ListAgentPoolsResponse>