ServiceConsumerManagement.Services.Search (Service Consumer Management API v1-rev20210707-1.32.1)

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.serviceconsumermanagement.v1.ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
        
        com.google.api.services.serviceconsumermanagement.v1.ServiceConsumerManagement.Services.Search

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

Enclosing class:: ServiceConsumerManagement.Services

public class ServiceConsumerManagement.Services.Search
extends ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>

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 Search(String parent)
Search tenancy units for a managed service.

Constructors
Modifier	Constructor and Description
`protected`	`Search(String parent)` Search tenancy units for a managed service.

Method Summary

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

Methods inherited from class com.google.api.services.serviceconsumermanagement.v1.ServiceConsumerManagementRequest
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.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(String parent)
```
    Search tenancy units for a managed service. Create a request for the method "services.search". This request holds the parameters needed by the the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    ServiceConsumerManagement.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<SearchTenancyUnitsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SearchTenancyUnitsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public ServiceConsumerManagement.Services.Search set$Xgafv(String $Xgafv)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setAccessToken
```
public ServiceConsumerManagement.Services.Search setAccessToken(String accessToken)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setAlt
```
public ServiceConsumerManagement.Services.Search setAlt(String alt)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setCallback
```
public ServiceConsumerManagement.Services.Search setCallback(String callback)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setFields
```
public ServiceConsumerManagement.Services.Search setFields(String fields)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setKey
```
public ServiceConsumerManagement.Services.Search setKey(String key)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    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 ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setOauthToken
```
public ServiceConsumerManagement.Services.Search setOauthToken(String oauthToken)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setPrettyPrint
```
public ServiceConsumerManagement.Services.Search setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setQuotaUser
```
public ServiceConsumerManagement.Services.Search setQuotaUser(String quotaUser)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    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 ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setUploadType
```
public ServiceConsumerManagement.Services.Search setUploadType(String uploadType)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - setUploadProtocol
```
public ServiceConsumerManagement.Services.Search setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ServiceConsumerManagementRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>
  - getParent
```
public String getParent()
```
    Required. Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'.
  - setParent
```
public ServiceConsumerManagement.Services.Search setParent(String parent)
```
    Required. Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'.
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.
  - setPageSize
```
public ServiceConsumerManagement.Services.Search setPageSize(Integer pageSize)
```
    Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.
  - getPageToken
```
public String getPageToken()
```
    Optional. The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
  - setPageToken
```
public ServiceConsumerManagement.Services.Search setPageToken(String pageToken)
```
    Optional. The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
  - getQuery
```
public String getQuery()
```
    Optional. Set a query `{expression}` for querying tenancy units. Your `{expression}` must be in the format: `field_name=literal_string`. The `field_name` is the name of the field you want to compare. Supported fields are `tenant_resources.tag` and `tenant_resources.resource`. For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query `tenant_resources.resource=projects/123456`. Multiple expressions can be joined with `AND`s. Tenancy units must match all expressions to be included in the result set. For example, `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
  - setQuery
```
public ServiceConsumerManagement.Services.Search setQuery(String query)
```
    Optional. Set a query `{expression}` for querying tenancy units. Your `{expression}` must be in the format: `field_name=literal_string`. The `field_name` is the name of the field you want to compare. Supported fields are `tenant_resources.tag` and `tenant_resources.resource`. For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query `tenant_resources.resource=projects/123456`. Multiple expressions can be joined with `AND`s. Tenancy units must match all expressions to be included in the result set. For example, `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
  - set
```
public ServiceConsumerManagement.Services.Search set(String parameterName,
                                                     Object value)
```
    Overrides:
    
    set in class ServiceConsumerManagementRequest<SearchTenancyUnitsResponse>

Class ServiceConsumerManagement.Services.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.serviceconsumermanagement.v1.ServiceConsumerManagementRequest

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

getParent

setParent

getPageSize

setPageSize

getPageToken

setPageToken

getQuery

setQuery

set