public class AnalyticsQueryService extends Object
| Constructor and Description |
|---|
AnalyticsQueryService(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
void |
cancelExecution(Long id)
Cancel Execution
Cancels the specified query execution.
|
void |
cancelExecution(Long id,
Map<String,Object> params)
Cancel Execution
Cancels the specified query execution.
|
com.google.api.client.http.HttpResponse |
cancelExecutionForHttpResponse(Long id) |
com.google.api.client.http.HttpResponse |
cancelExecutionForHttpResponse(Long id,
Map<String,Object> params) |
AnalyticsQueryResultBatch |
fetchResult(Long id,
Integer timeout,
Integer maxRows,
String nextToken)
Fetch Result
Fetches one batch of the result of a query execution.
|
AnalyticsQueryResultBatch |
fetchResult(Long id,
Map<String,Object> params)
Fetch Result
Fetches one batch of the result of a query execution.
|
com.google.api.client.http.HttpResponse |
fetchResultForHttpResponse(Long id,
Integer timeout,
Integer maxRows,
String nextToken) |
com.google.api.client.http.HttpResponse |
fetchResultForHttpResponse(Long id,
Map<String,Object> params) |
String |
generateDownloadUrl(Long id,
Integer timeout)
Generate Download URL
Generate a URL from which the results of a query execution can be downloaded in CSV format.
|
String |
generateDownloadUrl(Long id,
Map<String,Object> params)
Generate Download URL
Generate a URL from which the results of a query execution can be downloaded in CSV format.
|
com.google.api.client.http.HttpResponse |
generateDownloadUrlForHttpResponse(Long id,
Integer timeout) |
com.google.api.client.http.HttpResponse |
generateDownloadUrlForHttpResponse(Long id,
Map<String,Object> params) |
ApiClient |
getApiClient() |
List<AnalyticsSchemaTable> |
schema()
Get Schemas
Get the schemas describing the available tables and their columns.
|
List<AnalyticsSchemaTable> |
schema(Map<String,Object> params)
Get Schemas
Get the schemas describing the available tables and their columns.
|
com.google.api.client.http.HttpResponse |
schemaForHttpResponse() |
com.google.api.client.http.HttpResponse |
schemaForHttpResponse(Map<String,Object> params) |
void |
setApiClient(ApiClient apiClient) |
AnalyticsQueryExecution |
status(Long id)
Execution Status
Returns the current status of a query execution.
|
AnalyticsQueryExecution |
status(Long id,
Map<String,Object> params)
Execution Status
Returns the current status of a query execution.
|
com.google.api.client.http.HttpResponse |
statusForHttpResponse(Long id) |
com.google.api.client.http.HttpResponse |
statusForHttpResponse(Long id,
Map<String,Object> params) |
AnalyticsQueryExecution |
submitQuery(AnalyticsQuery query)
Submit Query
Submits a query for execution.
|
AnalyticsQueryExecution |
submitQuery(AnalyticsQuery query,
Map<String,Object> params)
Submit Query
Submits a query for execution.
|
com.google.api.client.http.HttpResponse |
submitQueryForHttpResponse(AnalyticsQuery query) |
com.google.api.client.http.HttpResponse |
submitQueryForHttpResponse(AnalyticsQuery query,
Map<String,Object> params) |
com.google.api.client.http.HttpResponse |
submitQueryForHttpResponse(InputStream query,
String mediaType) |
public AnalyticsQueryService(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public void cancelExecution(Long id) throws IOException
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution to cancel.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public void cancelExecution(Long id, Map<String,Object> params) throws IOException
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution to cancel.params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse cancelExecutionForHttpResponse(Long id) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse cancelExecutionForHttpResponse(Long id, Map<String,Object> params) throws IOException
IOExceptionpublic AnalyticsQueryResultBatch fetchResult(Long id, Integer timeout, Integer maxRows, String nextToken) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to fetch the result.timeout - The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.maxRows - The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)nextToken - The next-token of the preceding batch to get the next result batch or null to get the first result batch.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public AnalyticsQueryResultBatch fetchResult(Long id, Map<String,Object> params) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to fetch the result.params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse fetchResultForHttpResponse(Long id, Integer timeout, Integer maxRows, String nextToken) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse fetchResultForHttpResponse(Long id, Map<String,Object> params) throws IOException
IOExceptionpublic String generateDownloadUrl(Long id, Integer timeout) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to generate the download URL.timeout - The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public String generateDownloadUrl(Long id, Map<String,Object> params) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to generate the download URL.params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse generateDownloadUrlForHttpResponse(Long id, Integer timeout) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse generateDownloadUrlForHttpResponse(Long id, Map<String,Object> params) throws IOException
IOExceptionpublic List<AnalyticsSchemaTable> schema() throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public List<AnalyticsSchemaTable> schema(Map<String,Object> params) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse schemaForHttpResponse()
throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse schemaForHttpResponse(Map<String,Object> params) throws IOException
IOExceptionpublic AnalyticsQueryExecution status(Long id) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to get the status.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public AnalyticsQueryExecution status(Long id, Map<String,Object> params) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
id - The ID of the query execution for which to get the status.params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse statusForHttpResponse(Long id) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse statusForHttpResponse(Long id, Map<String,Object> params) throws IOException
IOExceptionpublic AnalyticsQueryExecution submitQuery(AnalyticsQuery query) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
query - The query to submit.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public AnalyticsQueryExecution submitQuery(AnalyticsQuery query, Map<String,Object> params) throws IOException
200 - This status code indicates that a client request was successfully received, understood, and accepted.
442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.
query - The query to submit.params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.IOException - if an error occurs while attempting to invoke the API
For more information visit this link.public com.google.api.client.http.HttpResponse submitQueryForHttpResponse(AnalyticsQuery query) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse submitQueryForHttpResponse(InputStream query, String mediaType) throws IOException
IOExceptionpublic com.google.api.client.http.HttpResponse submitQueryForHttpResponse(AnalyticsQuery query, Map<String,Object> params) throws IOException
IOExceptionCopyright © 2022. All rights reserved.