com.google.api.services.apigee.v1

Class Apigee.Organizations.HostQueries

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.HostQueries

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.HostQueries
extends Object

The "hostQueries" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.HostQueries.Create
class	Apigee.Organizations.HostQueries.Get
class	Apigee.Organizations.HostQueries.GetResult
class	Apigee.Organizations.HostQueries.GetResultView
class	Apigee.Organizations.HostQueries.List

Constructor Summary

Constructors

Constructor and Description
HostQueries()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.HostQueries.Create	create(String parent, GoogleCloudApigeeV1Query content) Submit a query at host level to be processed in the background.
Apigee.Organizations.HostQueries.Get	get(String name) Get status of a query submitted at host level.
Apigee.Organizations.HostQueries.GetResult	getResult(String name) After the query is completed, use this API to retrieve the results.
Apigee.Organizations.HostQueries.GetResultView	getResultView(String name) Create a request for the method "hostQueries.getResultView".
Apigee.Organizations.HostQueries.List	list(String parent) Return a list of Asynchronous Queries at host level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HostQueries

public HostQueries()

Method Detail

create

public Apigee.Organizations.HostQueries.Create create(String parent,
                                                      GoogleCloudApigeeV1Query content)
                                               throws IOException

Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of "enqueued" means that the request succeeded. Create a request for the method "hostQueries.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name. Must be of the form `organizations/{org}`.

content - the GoogleCloudApigeeV1Query

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.HostQueries.Get get(String name)
                                         throws IOException

Get status of a query submitted at host level. If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed" Create a request for the method "hostQueries.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the asynchronous query to get. Must be of the form `organizations/{org}/queries/{queryId}`.

Returns:

the request

Throws:

IOException

getResult

public Apigee.Organizations.HostQueries.GetResult getResult(String name)
                                                     throws IOException

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 "hostQueries.getResult". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/queries/{queryId}/result`.

Returns:

the request

Throws:

IOException

getResultView

public Apigee.Organizations.HostQueries.GetResultView getResultView(String name)
                                                             throws IOException

Create a request for the method "hostQueries.getResultView". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the asynchronous query result view to get. Must be of the form `organizations/{org}/queries/{queryId}/resultView`.

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.HostQueries.List list(String parent)
                                           throws IOException

Return a list of Asynchronous Queries at host level. Create a request for the method "hostQueries.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name. Must be of the form `organizations/{org}`.

Returns:

the request

Throws:

IOException