Google_Service_Apigee_Resource_OrganizationsEnvironmentsQueries
extends Google_Service_Resource
in package
The "queries" collection of methods.
Typical usage is:
$apigeeService = new Google_Service_Apigee(...);
$queries = $apigeeService->queries;
Table of Contents
- $client : Google_Client
- $methods : array<string|int, mixed>
- $resourceName : string
- $rootUrl : string
- $serviceName : string
- $servicePath : string
- $stackParameters : mixed
- __construct() : mixed
- call() : Google_Http_Request|expectedClass
- TODO: This function needs simplifying.
- create() : Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery
- 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)
- createRequestUri() : string
- Parse/expand request parameters and create a fully qualified request uri.
- get() : Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery
- 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)
- getResult() : Google_Service_Apigee_GoogleApiHttpBody
- 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)
- listOrganizationsEnvironmentsQueries() : Google_Service_Apigee_GoogleCloudApigeeV1ListAsyncQueriesResponse
- Return a list of Asynchronous Queries (queries.listOrganizationsEnvironmentsQueries)
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$serviceName
private
string
$serviceName
$servicePath
private
string
$servicePath
$stackParameters
private
mixed
$stackParameters
= array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))
Methods
__construct()
public
__construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
- $service : mixed
- $serviceName : mixed
- $resourceName : mixed
- $resource : mixed
Return values
mixed —call()
TODO: This function needs simplifying.
public
call( $name, $arguments[, $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
Tags
Return values
Google_Http_Request|expectedClass —create()
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)
public
create(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1Query $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery
Parameters
- $parent : string
-
Required. The parent resource name. Must be of the form
organizations/{org}/environments/{env}. - $postBody : Google_Service_Apigee_GoogleCloudApigeeV1Query
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery —createRequestUri()
Parse/expand request parameters and create a fully qualified request uri.
public
createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
- $restPath : string
- $params : array<string|int, mixed>
Tags
Return values
string —$requestUrl
get()
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)
public
get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery
Parameters
- $name : string
-
Required. Name of the asynchronous query to get. Must be of the form
organizations/{org}/environments/{env}/queries/{queryId}. - $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Apigee_GoogleCloudApigeeV1AsyncQuery —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 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)
public
getResult(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleApiHttpBody
Parameters
- $name : string
-
Required. Name of the asynchronous query result to get. Must be of the form
organizations/{org}/environments/{env}/queries/{queryId}/result. - $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Apigee_GoogleApiHttpBody —listOrganizationsEnvironmentsQueries()
Return a list of Asynchronous Queries (queries.listOrganizationsEnvironmentsQueries)
public
listOrganizationsEnvironmentsQueries(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListAsyncQueriesResponse
Parameters
- $parent : string
-
Required. The parent resource name. Must be of the form
organizations/{org}/environments/{env}. - $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListAsyncQueriesResponse —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed