com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.SecurityReports

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.SecurityReports

Enclosing class:

Apigee.Organizations.Environments

public class Apigee.Organizations.Environments.SecurityReports
extends Object

The "securityReports" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.SecurityReports.Create
class	Apigee.Organizations.Environments.SecurityReports.Get
class	Apigee.Organizations.Environments.SecurityReports.GetResult
class	Apigee.Organizations.Environments.SecurityReports.GetResultView
class	Apigee.Organizations.Environments.SecurityReports.List

Constructor Summary

Constructors

Constructor and Description
SecurityReports()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.SecurityReports.Create	create(String parent, GoogleCloudApigeeV1SecurityReportQuery content) Submit a report request to be processed in the background.
Apigee.Organizations.Environments.SecurityReports.Get	get(String name) 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" Create a request for the method "securityReports.get".
Apigee.Organizations.Environments.SecurityReports.GetResult	getResult(String name) After the query is completed, use this API to retrieve the results as file.
Apigee.Organizations.Environments.SecurityReports.GetResultView	getResultView(String name) After the query is completed, use this API to view the query result when result size is small.
Apigee.Organizations.Environments.SecurityReports.List	list(String parent) Return a list of Security Reports Create a request for the method "securityReports.list".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityReports

public SecurityReports()

Method Detail

create

public Apigee.Organizations.Environments.SecurityReports.Create create(String parent,
                                                                       GoogleCloudApigeeV1SecurityReportQuery content)
                                                                throws IOException

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. Create a request for the method "securityReports.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1SecurityReportQuery

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.Environments.SecurityReports.Get get(String name)
                                                          throws IOException

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" Create a request for the method "securityReports.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

getResult

public Apigee.Organizations.Environments.SecurityReports.GetResult getResult(String name)
                                                                      throws IOException

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` Create a request for the method "securityReports.getResult". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

getResultView

public Apigee.Organizations.Environments.SecurityReports.GetResultView getResultView(String name)
                                                                              throws IOException

After the query is completed, use this API to view the query result when result size is small. Create a request for the method "securityReports.getResultView". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.Environments.SecurityReports.List list(String parent)
                                                            throws IOException

Return a list of Security Reports Create a request for the method "securityReports.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException