com.google.api.services.cloudresourcemanager.v3

Class CloudResourceManager.Folders.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.cloudresourcemanager.v3.CloudResourceManagerRequest<ListFoldersResponse>

com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.Folders.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudResourceManager.Folders

public class CloudResourceManager.Folders.List
extends CloudResourceManagerRequest<ListFoldersResponse>

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 the folders that are direct descendants of supplied parent resource.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getParent() Required.
Boolean	getShowDeleted() Optional.
CloudResourceManager.Folders.List	set(String parameterName, Object value)
CloudResourceManager.Folders.List	set$Xgafv(String $Xgafv) V1 error format.
CloudResourceManager.Folders.List	setAccessToken(String accessToken) OAuth access token.
CloudResourceManager.Folders.List	setAlt(String alt) Data format for response.
CloudResourceManager.Folders.List	setCallback(String callback) JSONP
CloudResourceManager.Folders.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudResourceManager.Folders.List	setKey(String key) API key.
CloudResourceManager.Folders.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudResourceManager.Folders.List	setPageSize(Integer pageSize) Optional.
CloudResourceManager.Folders.List	setPageToken(String pageToken) Optional.
CloudResourceManager.Folders.List	setParent(String parent) Required.
CloudResourceManager.Folders.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudResourceManager.Folders.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudResourceManager.Folders.List	setShowDeleted(Boolean showDeleted) Optional.
CloudResourceManager.Folders.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudResourceManager.Folders.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudresourcemanager.v3.CloudResourceManagerRequest

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 the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. Create a request for the method "folders.list". This request holds the parameters needed by the the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CloudResourceManager.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<ListFoldersResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public CloudResourceManager.Folders.List set$Xgafv(String $Xgafv)

Description copied from class: CloudResourceManagerRequest

V1 error format.

Overrides:

set$Xgafv in class CloudResourceManagerRequest<ListFoldersResponse>

setAccessToken

public CloudResourceManager.Folders.List setAccessToken(String accessToken)

Description copied from class: CloudResourceManagerRequest

OAuth access token.

Overrides:

setAccessToken in class CloudResourceManagerRequest<ListFoldersResponse>

setAlt

public CloudResourceManager.Folders.List setAlt(String alt)

Description copied from class: CloudResourceManagerRequest

Data format for response.

Overrides:

setAlt in class CloudResourceManagerRequest<ListFoldersResponse>

setCallback

public CloudResourceManager.Folders.List setCallback(String callback)

Description copied from class: CloudResourceManagerRequest

JSONP

Overrides:

setCallback in class CloudResourceManagerRequest<ListFoldersResponse>

setFields

public CloudResourceManager.Folders.List setFields(String fields)

Description copied from class: CloudResourceManagerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudResourceManagerRequest<ListFoldersResponse>

setKey

public CloudResourceManager.Folders.List setKey(String key)

Description copied from class: CloudResourceManagerRequest

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 CloudResourceManagerRequest<ListFoldersResponse>

setOauthToken

public CloudResourceManager.Folders.List setOauthToken(String oauthToken)

Description copied from class: CloudResourceManagerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudResourceManagerRequest<ListFoldersResponse>

setPrettyPrint

public CloudResourceManager.Folders.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudResourceManagerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudResourceManagerRequest<ListFoldersResponse>

setQuotaUser

public CloudResourceManager.Folders.List setQuotaUser(String quotaUser)

Description copied from class: CloudResourceManagerRequest

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 CloudResourceManagerRequest<ListFoldersResponse>

setUploadType

public CloudResourceManager.Folders.List setUploadType(String uploadType)

Description copied from class: CloudResourceManagerRequest

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

Overrides:

setUploadType in class CloudResourceManagerRequest<ListFoldersResponse>

setUploadProtocol

public CloudResourceManager.Folders.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudResourceManagerRequest

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

Overrides:

setUploadProtocol in class CloudResourceManagerRequest<ListFoldersResponse>

getPageSize

public Integer getPageSize()

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

setPageSize

public CloudResourceManager.Folders.List setPageSize(Integer pageSize)

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

getPageToken

public String getPageToken()

Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.

setPageToken

public CloudResourceManager.Folders.List setPageToken(String pageToken)

Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.

getParent

public String getParent()

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.

setParent

public CloudResourceManager.Folders.List setParent(String parent)

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.

getShowDeleted

public Boolean getShowDeleted()

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

setShowDeleted

public CloudResourceManager.Folders.List setShowDeleted(Boolean showDeleted)

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

set

public CloudResourceManager.Folders.List set(String parameterName,
                                             Object value)

Overrides:

set in class CloudResourceManagerRequest<ListFoldersResponse>