* $apigeeService = new Google\Service\Apigee(...); * $securityReports = $apigeeService->organizations_environments_securityReports; * */ class OrganizationsEnvironmentsSecurityReports extends \Google\Service\Resource { /** * Submit a report request to be processed in the background. If the submission * succeeds, the API returns a 200 status and an ID that refer to the report * request. In addition to the HTTP status 200, the `state` of "enqueued" means * that the request succeeded. (securityReports.create) * * @param string $parent Required. The parent resource name. Must be of the form * `organizations/{org}/environments/{env}`. * @param GoogleCloudApigeeV1SecurityReportQuery $postBody * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1SecurityReport * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudApigeeV1SecurityReportQuery $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudApigeeV1SecurityReport::class); } /** * Get security report 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" (securityReports.get) * * @param string $name Required. Name of the security report to get. Must be of * the form `organizations/{org}/environments/{env}/securityReports/{reportId}`. * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1SecurityReport * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudApigeeV1SecurityReport::class); } /** * After the query is completed, use this API to retrieve the results as file. * 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` * (securityReports.getResult) * * @param string $name Required. Name of the security report result to get. Must * be of the form * `organizations/{org}/environments/{env}/securityReports/{reportId}/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 view the query result when * result size is small. (securityReports.getResultView) * * @param string $name Required. Name of the security report result view to get. * Must be of the form `organizations/{org}/environments/{env}/securityReports/{ * reportId}/resultView`. * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1SecurityReportResultView * @throws \Google\Service\Exception */ public function getResultView($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('getResultView', [$params], GoogleCloudApigeeV1SecurityReportResultView::class); } /** * Return a list of Security Reports * (securityReports.listOrganizationsEnvironmentsSecurityReports) * * @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 security reports * that created after this date time. Time must be in ISO date-time format like * '2011-12-03T10:15:30Z'. * @opt_param int pageSize The maximum number of security report to return in * the list response. * @opt_param string pageToken Token returned from the previous list response to * fetch the next page. * @opt_param string status Filter response list by security reports status. * @opt_param string submittedBy Filter response list by user who submitted * queries. * @opt_param string to Filter response list by returning security reports that * created before this date time. Time must be in ISO date-time format like * '2011-12-03T10:16:30Z'. * @return GoogleCloudApigeeV1ListSecurityReportsResponse * @throws \Google\Service\Exception */ public function listOrganizationsEnvironmentsSecurityReports($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudApigeeV1ListSecurityReportsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(OrganizationsEnvironmentsSecurityReports::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsSecurityReports');