📄 Source: OrganizationsEnvironmentsQueries.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Apigee\Resource;
use Google\Service\Apigee\GoogleApiHttpBody;
use Google\Service\Apigee\GoogleCloudApigeeV1AsyncQuery;
use Google\Service\Apigee\GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse;
use Google\Service\Apigee\GoogleCloudApigeeV1ListAsyncQueriesResponse;
use Google\Service\Apigee\GoogleCloudApigeeV1Query;
/**
* The "queries" collection of methods.
* Typical usage is:
* <code>
* $apigeeService = new Google\Service\Apigee(...);
* $queries = $apigeeService->organizations_environments_queries;
* </code>
*/
class OrganizationsEnvironmentsQueries extends \Google\Service\Resource
{
/**
* 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)
*
* @param string $parent Required. The parent resource name. Must be of the form
* `organizations/{org}/environments/{env}`.
* @param GoogleCloudApigeeV1Query $postBody
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1AsyncQuery
* @throws \Google\Service\Exception
*/
public function create($parent, GoogleCloudApigeeV1Query $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], GoogleCloudApigeeV1AsyncQuery::class);
}
/**
* 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)
*
* @param string $name Required. Name of the asynchronous query to get. Must be
* of the form `organizations/{org}/environments/{env}/queries/{queryId}`.
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1AsyncQuery
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], GoogleCloudApigeeV1AsyncQuery::class);
}
/**
* 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)
*
* @param string $name Required. Name of the asynchronous query result to get.
* Must be of the form
* `organizations/{org}/environments/{env}/queries/{queryId}/result`.
* @param array $optParams Optional parameters.
* @return GoogleApiHttpBody
* @throws \Google\Service\Exception
*/
public function getResult($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getResult', [$params], GoogleApiHttpBody::class);
}
/**
* 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)
*
* @param string $name Required. Name of the asynchronous query result to get.
* Must be of the form
* `organizations/{org}/environments/{env}/queries/{queryId}/resulturl`.
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse
* @throws \Google\Service\Exception
*/
public function getResulturl($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getResulturl', [$params], GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse::class);
}
/**
* Return a list of Asynchronous Queries
* (queries.listOrganizationsEnvironmentsQueries)
*
* @param string $parent Required. The parent resource name. Must be of the form
* `organizations/{org}/environments/{env}`.
* @param array $optParams Optional parameters.
*
* @opt_param string dataset Filter response list by dataset. Example: `api`,
* `mint`
* @opt_param string from Filter response list by returning asynchronous queries
* that created after this date time. Time must be in ISO date-time format like
* '2011-12-03T10:15:30Z'.
* @opt_param string inclQueriesWithoutReport Flag to include asynchronous
* queries that don't have a report denifition.
* @opt_param string status Filter response list by asynchronous query status.
* @opt_param string submittedBy Filter response list by user who submitted
* queries.
* @opt_param string to Filter response list by returning asynchronous queries
* that created before this date time. Time must be in ISO date-time format like
* '2011-12-03T10:16:30Z'.
* @return GoogleCloudApigeeV1ListAsyncQueriesResponse
* @throws \Google\Service\Exception
*/
public function listOrganizationsEnvironmentsQueries($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], GoogleCloudApigeeV1ListAsyncQueriesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OrganizationsEnvironmentsQueries::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsQueries');
← Back