com.google.api.services.cloudresourcemanager.v3

Class CloudResourceManager.Organizations.Search

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

com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.Organizations.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudResourceManager.Organizations

public class CloudResourceManager.Organizations.Search
extends CloudResourceManagerRequest<SearchOrganizationsResponse>

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	Search() Searches organization resources that are visible to the user and satisfy the specified filter.

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	getQuery() Optional.
CloudResourceManager.Organizations.Search	set(String parameterName, Object value)
CloudResourceManager.Organizations.Search	set$Xgafv(String $Xgafv) V1 error format.
CloudResourceManager.Organizations.Search	setAccessToken(String accessToken) OAuth access token.
CloudResourceManager.Organizations.Search	setAlt(String alt) Data format for response.
CloudResourceManager.Organizations.Search	setCallback(String callback) JSONP
CloudResourceManager.Organizations.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudResourceManager.Organizations.Search	setKey(String key) API key.
CloudResourceManager.Organizations.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudResourceManager.Organizations.Search	setPageSize(Integer pageSize) Optional.
CloudResourceManager.Organizations.Search	setPageToken(String pageToken) Optional.
CloudResourceManager.Organizations.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudResourceManager.Organizations.Search	setQuery(String query) Optional.
CloudResourceManager.Organizations.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudResourceManager.Organizations.Search	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudResourceManager.Organizations.Search	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

Search

protected Search()

Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges. Create a request for the method "organizations.search". 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<SearchOrganizationsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public CloudResourceManager.Organizations.Search set$Xgafv(String $Xgafv)

Description copied from class: CloudResourceManagerRequest

V1 error format.

Overrides:

set$Xgafv in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setAccessToken

public CloudResourceManager.Organizations.Search setAccessToken(String accessToken)

Description copied from class: CloudResourceManagerRequest

OAuth access token.

Overrides:

setAccessToken in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setAlt

public CloudResourceManager.Organizations.Search setAlt(String alt)

Description copied from class: CloudResourceManagerRequest

Data format for response.

Overrides:

setAlt in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setCallback

public CloudResourceManager.Organizations.Search setCallback(String callback)

Description copied from class: CloudResourceManagerRequest

JSONP

Overrides:

setCallback in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setFields

public CloudResourceManager.Organizations.Search setFields(String fields)

Description copied from class: CloudResourceManagerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setKey

public CloudResourceManager.Organizations.Search 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<SearchOrganizationsResponse>

setOauthToken

public CloudResourceManager.Organizations.Search setOauthToken(String oauthToken)

Description copied from class: CloudResourceManagerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setPrettyPrint

public CloudResourceManager.Organizations.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudResourceManagerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setQuotaUser

public CloudResourceManager.Organizations.Search 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<SearchOrganizationsResponse>

setUploadType

public CloudResourceManager.Organizations.Search setUploadType(String uploadType)

Description copied from class: CloudResourceManagerRequest

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

Overrides:

setUploadType in class CloudResourceManagerRequest<SearchOrganizationsResponse>

setUploadProtocol

public CloudResourceManager.Organizations.Search setUploadProtocol(String uploadProtocol)

Description copied from class: CloudResourceManagerRequest

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

Overrides:

setUploadProtocol in class CloudResourceManagerRequest<SearchOrganizationsResponse>

getPageSize

public Integer getPageSize()

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

setPageSize

public CloudResourceManager.Organizations.Search setPageSize(Integer pageSize)

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

getPageToken

public String getPageToken()

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

setPageToken

public CloudResourceManager.Organizations.Search setPageToken(String pageToken)

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

getQuery

public String getQuery()

Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.

setQuery

public CloudResourceManager.Organizations.Search setQuery(String query)

Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.

set

public CloudResourceManager.Organizations.Search set(String parameterName,
                                                     Object value)

Overrides:

set in class CloudResourceManagerRequest<SearchOrganizationsResponse>