com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Queries

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Queries

Enclosing class:

Apigee.Organizations.Environments

public class Apigee.Organizations.Environments.Queries
extends Object

The "queries" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.Queries.Create
class	Apigee.Organizations.Environments.Queries.Get
class	Apigee.Organizations.Environments.Queries.GetResult
class	Apigee.Organizations.Environments.Queries.GetResulturl
class	Apigee.Organizations.Environments.Queries.List

Constructor Summary

Constructors

Constructor and Description
Queries()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.Queries.Create	create(String parent, GoogleCloudApigeeV1Query content) Submit a query to be processed in the background.
Apigee.Organizations.Environments.Queries.Get	get(String name) Get query status 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 "queries.get".
Apigee.Organizations.Environments.Queries.GetResult	getResult(String name) After the query is completed, use this API to retrieve the results.
Apigee.Organizations.Environments.Queries.GetResulturl	getResulturl(String name) After the query is completed, use this API to retrieve the results.
Apigee.Organizations.Environments.Queries.List	list(String parent) Return a list of Asynchronous Queries Create a request for the method "queries.list".

Methods inherited from class java.lang.Object

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

Constructor Detail

Queries

public Queries()

Method Detail

create

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

Submit a query 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 "queries.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}/environments/{env}`.

content - the GoogleCloudApigeeV1Query

Returns:

the request

Throws:

IOException

get

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

Get query status 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 "queries.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}/environments/{env}/queries/{queryId}`.

Returns:

the request

Throws:

IOException

getResult

public Apigee.Organizations.Environments.Queries.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 "queries.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}/environments/{env}/queries/{queryId}/result`.

Returns:

the request

Throws:

IOException

getResulturl

public Apigee.Organizations.Environments.Queries.GetResulturl getResulturl(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 sent to the client as a list of urls to JSON files. Create a request for the method "queries.getResulturl". 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}/environments/{env}/queries/{queryId}/resulturl`.

Returns:

the request

Throws:

IOException

list

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

Return a list of Asynchronous Queries Create a request for the method "queries.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}/environments/{env}`.

Returns:

the request

Throws:

IOException