Apigee.Organizations.Environments.Queries.GetResult (Apigee API v1-rev20251125-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.apigee.v1.ApigeeRequest<GoogleApiHttpBody>
        
        com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Queries.GetResult

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Environments.Queries
```
public class Apigee.Organizations.Environments.Queries.GetResult
extends ApigeeRequest<GoogleApiHttpBody>
```

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 GetResult(String name)
After the query is completed, use this API to retrieve the results.

Constructors
Modifier	Constructor and Description
`protected`	`GetResult(String name)` After the query is completed, use this API to retrieve the results.

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()`
`String`	`getName()` Required.
`Apigee.Organizations.Environments.Queries.GetResult`	`set(String parameterName, Object value)`
`Apigee.Organizations.Environments.Queries.GetResult`	`set$Xgafv(String $Xgafv)` V1 error format.
`Apigee.Organizations.Environments.Queries.GetResult`	`setAccessToken(String accessToken)` OAuth access token.
`Apigee.Organizations.Environments.Queries.GetResult`	`setAlt(String alt)` Data format for response.
`Apigee.Organizations.Environments.Queries.GetResult`	`setCallback(String callback)` JSONP
`Apigee.Organizations.Environments.Queries.GetResult`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Apigee.Organizations.Environments.Queries.GetResult`	`setKey(String key)` API key.
`Apigee.Organizations.Environments.Queries.GetResult`	`setName(String name)` Required.
`Apigee.Organizations.Environments.Queries.GetResult`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Apigee.Organizations.Environments.Queries.GetResult`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Apigee.Organizations.Environments.Queries.GetResult`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Apigee.Organizations.Environments.Queries.GetResult`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Apigee.Organizations.Environments.Queries.GetResult`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest
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
  - GetResult
```
protected GetResult(String name)
```
    After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` Create a request for the method "queries.getResult". This request holds the parameters needed by the the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Apigee.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}/result`.
    
    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<GoogleApiHttpBody>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleApiHttpBody>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Apigee.Organizations.Environments.Queries.GetResult set$Xgafv(String $Xgafv)
```
    Description copied from class: ApigeeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ApigeeRequest<GoogleApiHttpBody>
  - setAccessToken
```
public Apigee.Organizations.Environments.Queries.GetResult setAccessToken(String accessToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ApigeeRequest<GoogleApiHttpBody>
  - setAlt
```
public Apigee.Organizations.Environments.Queries.GetResult setAlt(String alt)
```
    Description copied from class: ApigeeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ApigeeRequest<GoogleApiHttpBody>
  - setCallback
```
public Apigee.Organizations.Environments.Queries.GetResult setCallback(String callback)
```
    Description copied from class: ApigeeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ApigeeRequest<GoogleApiHttpBody>
  - setFields
```
public Apigee.Organizations.Environments.Queries.GetResult setFields(String fields)
```
    Description copied from class: ApigeeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ApigeeRequest<GoogleApiHttpBody>
  - setKey
```
public Apigee.Organizations.Environments.Queries.GetResult setKey(String key)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleApiHttpBody>
  - setOauthToken
```
public Apigee.Organizations.Environments.Queries.GetResult setOauthToken(String oauthToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ApigeeRequest<GoogleApiHttpBody>
  - setPrettyPrint
```
public Apigee.Organizations.Environments.Queries.GetResult setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ApigeeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ApigeeRequest<GoogleApiHttpBody>
  - setQuotaUser
```
public Apigee.Organizations.Environments.Queries.GetResult setQuotaUser(String quotaUser)
```
    Description copied from class: ApigeeRequest
    
    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 ApigeeRequest<GoogleApiHttpBody>
  - setUploadType
```
public Apigee.Organizations.Environments.Queries.GetResult setUploadType(String uploadType)
```
    Description copied from class: ApigeeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ApigeeRequest<GoogleApiHttpBody>
  - setUploadProtocol
```
public Apigee.Organizations.Environments.Queries.GetResult setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ApigeeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ApigeeRequest<GoogleApiHttpBody>
  - getName
```
public String getName()
```
    Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}/result`.
  - setName
```
public Apigee.Organizations.Environments.Queries.GetResult setName(String name)
```
    Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}/result`.
  - set
```
public Apigee.Organizations.Environments.Queries.GetResult set(String parameterName,
                                                               Object value)
```
    Overrides:
    
    set in class ApigeeRequest<GoogleApiHttpBody>

Class Apigee.Organizations.Environments.Queries.GetResult

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.apigee.v1.ApigeeRequest

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

GetResult

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set