CloudResourceManager.Projects.Search (Cloud Resource Manager API v3-rev20240310-2.0.0)

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<SearchProjectsResponse>
        
        com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.Projects.Search

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: CloudResourceManager.Projects

public class CloudResourceManager.Projects.Search
extends CloudResourceManagerRequest<SearchProjectsResponse>

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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Search()` Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query.

Method Summary

All Methods Instance Methods Concrete Methods
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.Projects.Search`	`set(String parameterName, Object value)`
`CloudResourceManager.Projects.Search`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudResourceManager.Projects.Search`	`setAccessToken(String accessToken)` OAuth access token.
`CloudResourceManager.Projects.Search`	`setAlt(String alt)` Data format for response.
`CloudResourceManager.Projects.Search`	`setCallback(String callback)` JSONP
`CloudResourceManager.Projects.Search`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudResourceManager.Projects.Search`	`setKey(String key)` API key.
`CloudResourceManager.Projects.Search`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudResourceManager.Projects.Search`	`setPageSize(Integer pageSize)` Optional.
`CloudResourceManager.Projects.Search`	`setPageToken(String pageToken)` Optional.
`CloudResourceManager.Projects.Search`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudResourceManager.Projects.Search`	`setQuery(String query)` Optional.
`CloudResourceManager.Projects.Search`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudResourceManager.Projects.Search`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudResourceManager.Projects.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()
```
    Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. Create a request for the method "projects.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<SearchProjectsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchProjectsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudResourceManager.Projects.Search set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudResourceManagerRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setAccessToken
```
public CloudResourceManager.Projects.Search setAccessToken(String accessToken)
```
    Description copied from class: CloudResourceManagerRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setAlt
```
public CloudResourceManager.Projects.Search setAlt(String alt)
```
    Description copied from class: CloudResourceManagerRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setCallback
```
public CloudResourceManager.Projects.Search setCallback(String callback)
```
    Description copied from class: CloudResourceManagerRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setFields
```
public CloudResourceManager.Projects.Search setFields(String fields)
```
    Description copied from class: CloudResourceManagerRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setKey
```
public CloudResourceManager.Projects.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<SearchProjectsResponse>
  - setOauthToken
```
public CloudResourceManager.Projects.Search setOauthToken(String oauthToken)
```
    Description copied from class: CloudResourceManagerRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setPrettyPrint
```
public CloudResourceManager.Projects.Search setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudResourceManagerRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setQuotaUser
```
public CloudResourceManager.Projects.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<SearchProjectsResponse>
  - setUploadType
```
public CloudResourceManager.Projects.Search setUploadType(String uploadType)
```
    Description copied from class: CloudResourceManagerRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudResourceManagerRequest<SearchProjectsResponse>
  - setUploadProtocol
```
public CloudResourceManager.Projects.Search setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudResourceManagerRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudResourceManagerRequest<SearchProjectsResponse>
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.
  - setPageSize
```
public CloudResourceManager.Projects.Search setPageSize(Integer pageSize)
```
    Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.
  - getPageToken
```
public String getPageToken()
```
    Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.
  - setPageToken
```
public CloudResourceManager.Projects.Search setPageToken(String pageToken)
```
    Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.
  - getQuery
```
public String getQuery()
```
    Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.
  - setQuery
```
public CloudResourceManager.Projects.Search setQuery(String query)
```
    Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.
  - set
```
public CloudResourceManager.Projects.Search set(String parameterName,
                                                Object value)
```
    Overrides:
    
    set in class CloudResourceManagerRequest<SearchProjectsResponse>

Class CloudResourceManager.Projects.Search

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Search

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPageSize

setPageSize

getPageToken

setPageToken

getQuery

setQuery

set