class OrganizationsEnvironmentsSecurityReports extends Resource (View source)

The "securityReports" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $securityReports = $apigeeService->organizations_environments_securityReports;

Methods

create(string $parent, GoogleCloudApigeeV1SecurityReportQuery $postBody, array $optParams = [])

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)

get(string $name, array $optParams = [])

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)

getResult(string $name, array $optParams = [])

After the query is completed, use this API to retrieve the results as file.

getResultView(string $name, array $optParams = [])

After the query is completed, use this API to view the query result when result size is small. (securityReports.getResultView)

listOrganizationsEnvironmentsSecurityReports(string $parent, array $optParams = [])

Return a list of Security Reports (securityReports.listOrganizationsEnvironmentsSecurityReports)

Details

GoogleCloudApigeeV1SecurityReport create(string $parent, GoogleCloudApigeeV1SecurityReportQuery $postBody, array $optParams = [])

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)

Parameters

string $parent

Required. The parent resource name. Must be of the form organizations/{org}/environments/{env}.

GoogleCloudApigeeV1SecurityReportQuery $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityReport

Exceptions

Exception

GoogleCloudApigeeV1SecurityReport get(string $name, array $optParams = [])

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)

Parameters

string $name

Required. Name of the security report to get. Must be of the form organizations/{org}/environments/{env}/securityReports/{reportId}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityReport

Exceptions

Exception

GoogleApiHttpBody getResult(string $name, array $optParams = [])

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)

Parameters

string $name

Required. Name of the security report result to get. Must be of the form organizations/{org}/environments/{env}/securityReports/{reportId}/result.

array $optParams

Optional parameters.

Return Value

GoogleApiHttpBody

Exceptions

Exception

GoogleCloudApigeeV1SecurityReportResultView getResultView(string $name, array $optParams = [])

After the query is completed, use this API to view the query result when result size is small. (securityReports.getResultView)

Parameters

string $name

Required. Name of the security report result view to get. Must be of the form organizations/{org}/environments/{env}/securityReports/{ reportId}/resultView.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityReportResultView

Exceptions

Exception

GoogleCloudApigeeV1ListSecurityReportsResponse listOrganizationsEnvironmentsSecurityReports(string $parent, array $optParams = [])

Return a list of Security Reports (securityReports.listOrganizationsEnvironmentsSecurityReports)

Parameters

string $parent

Required. The parent resource name. Must be of the form organizations/{org}/environments/{env}.

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListSecurityReportsResponse

Exceptions

Exception