com.vmware.vcenter.lcm

Interface Reports

All Superinterfaces:

ReportsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ReportsStub

public interface Reports
extends com.vmware.vapi.bindings.Service, ReportsTypes

The Report interface provides an method to download the report generated by the interop and precheck operations. To download a report, you must use the get() method. A Report.Location class represents the location of the file which has Report.Token class which represents the token ID (@name String) and the expiration time of the token Report.Token.expiry DateTime. Report.Location class also has the URI for the file which needs to be downloaded.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.lcm.ReportsTypes

ReportsTypes.Location, ReportsTypes.Token

Field Summary

Fields inherited from interface com.vmware.vcenter.lcm.ReportsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ReportsTypes.Location	get(java.lang.String report) Returns the location ReportsTypes.Location information for downloading the report for the specified file name.
void	get(java.lang.String report, com.vmware.vapi.bindings.client.AsyncCallback<ReportsTypes.Location> asyncCallback) Returns the location ReportsTypes.Location information for downloading the report for the specified file name.
void	get(java.lang.String report, com.vmware.vapi.bindings.client.AsyncCallback<ReportsTypes.Location> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the location ReportsTypes.Location information for downloading the report for the specified file name.
ReportsTypes.Location	get(java.lang.String report, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the location ReportsTypes.Location information for downloading the report for the specified file name.

Method Detail

get

ReportsTypes.Location get(java.lang.String report)

Returns the location ReportsTypes.Location information for downloading the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the get(java.lang.String) method to provision a token and a URI.
• Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.

The HTTP GET request will:

• Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
• Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

report - The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no file associated with report in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

get

ReportsTypes.Location get(java.lang.String report,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the location ReportsTypes.Location information for downloading the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the get(java.lang.String) method to provision a token and a URI.
• Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.

The HTTP GET request will:

• Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
• Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

report - The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no file associated with report in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

get

void get(java.lang.String report,
         com.vmware.vapi.bindings.client.AsyncCallback<ReportsTypes.Location> asyncCallback)

Returns the location ReportsTypes.Location information for downloading the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the get(java.lang.String) method to provision a token and a URI.
• Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.

The HTTP GET request will:

• Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
• Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no file associated with report in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

report - The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String report,
         com.vmware.vapi.bindings.client.AsyncCallback<ReportsTypes.Location> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the location ReportsTypes.Location information for downloading the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the get(java.lang.String) method to provision a token and a URI.
• Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.

The HTTP GET request will:

• Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
• Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no file associated with report in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

report - The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.