OrganizationsEnvironmentsQueries
class OrganizationsEnvironmentsQueries extends Resource (View source)
The "queries" collection of methods.
Typical usage is:
$apigeeService = new Google\Service\Apigee(...);
$queries = $apigeeService->organizations_environments_queries;Methods
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. (queries.create)
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" (queries.get)
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
(queries.getResult)
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. (queries.getResulturl)
Return a list of Asynchronous Queries (queries.listOrganizationsEnvironmentsQueries)
Details
GoogleCloudApigeeV1AsyncQuery
create(string $parent, GoogleCloudApigeeV1Query $postBody, array $optParams = [])
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. (queries.create)
GoogleCloudApigeeV1AsyncQuery
get(string $name, array $optParams = [])
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" (queries.get)
GoogleApiHttpBody
getResult(string $name, array $optParams = [])
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
(queries.getResult)
GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse
getResulturl(string $name, array $optParams = [])
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. (queries.getResulturl)
GoogleCloudApigeeV1ListAsyncQueriesResponse
listOrganizationsEnvironmentsQueries(string $parent, array $optParams = [])
Return a list of Asynchronous Queries (queries.listOrganizationsEnvironmentsQueries)