OrganizationsHostQueries
class OrganizationsHostQueries extends Resource (View source)
The "hostQueries" collection of methods.
Typical usage is:
$apigeeService = new Google\Service\Apigee(...);
$hostQueries = $apigeeService->organizations_hostQueries;Methods
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. (hostQueries.create)
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" (hostQueries.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
(hostQueries.getResult)
(hostQueries.getResultView)
Return a list of Asynchronous Queries at host level.
Details
GoogleCloudApigeeV1AsyncQuery
create(string $parent, GoogleCloudApigeeV1Query $postBody, array $optParams = [])
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. (hostQueries.create)
GoogleCloudApigeeV1AsyncQuery
get(string $name, array $optParams = [])
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" (hostQueries.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
(hostQueries.getResult)
GoogleCloudApigeeV1AsyncQueryResultView
getResultView(string $name, array $optParams = [])
(hostQueries.getResultView)
GoogleCloudApigeeV1ListAsyncQueriesResponse
listOrganizationsHostQueries(string $parent, array $optParams = [])
Return a list of Asynchronous Queries at host level.
(hostQueries.listOrganizationsHostQueries)