com.vmware.esx.hcl

Interface Reports

All Superinterfaces:

ReportsTypes, Service

All Known Implementing Classes:

ReportsStub

public interface Reports
extends Service, ReportsTypes

This interface provides methods to download information generated from the hardware compatibility feature residing on the vCenter Appliance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.hcl.ReportsTypes

ReportsTypes.Location, ReportsTypes.Token

Field Summary

Fields inherited from interface com.vmware.esx.hcl.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 a compatibility report.
void	get(java.lang.String report, AsyncCallback<ReportsTypes.Location> asyncCallback) Returns the location ReportsTypes.Location information for downloading a compatibility report.
void	get(java.lang.String report, AsyncCallback<ReportsTypes.Location> asyncCallback, InvocationConfig invocationConfig) Returns the location ReportsTypes.Location information for downloading a compatibility report.
ReportsTypes.Location	get(java.lang.String report, InvocationConfig invocationConfig) Returns the location ReportsTypes.Location information for downloading a compatibility report.

Method Detail

get

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

Returns the location ReportsTypes.Location information for downloading a compatibility report.

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

Parameters:

report - identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.

Returns:

Location class which includes the URI to file, short lived token and expiry of the token in the ReportsTypes.Location object.

Throws:

NotFound - if there is no report for the given id.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

Error - If there is some unknown 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 VcIntegrity.HardwareCompatibility.Read.

get

ReportsTypes.Location get(java.lang.String report,
                          InvocationConfig invocationConfig)

Returns the location ReportsTypes.Location information for downloading a compatibility report.

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 - identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.

invocationConfig - Configuration for the method invocation.

Returns:

Location class which includes the URI to file, short lived token and expiry of the token in the ReportsTypes.Location object.

Throws:

NotFound - if there is no report for the given id.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

Error - If there is some unknown 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 VcIntegrity.HardwareCompatibility.Read.

get

void get(java.lang.String report,
         AsyncCallback<ReportsTypes.Location> asyncCallback)

Returns the location ReportsTypes.Location information for downloading a compatibility report.

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

Invocation Result:
Location class which includes the URI to file, short lived token and expiry of the token in the ReportsTypes.Location object.

Operation Errors:
NotFound - if there is no report for the given id.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown 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 VcIntegrity.HardwareCompatibility.Read.

Parameters:

report - identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.

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

get

void get(java.lang.String report,
         AsyncCallback<ReportsTypes.Location> asyncCallback,
         InvocationConfig invocationConfig)

Returns the location ReportsTypes.Location information for downloading a compatibility report.

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

Invocation Result:
Location class which includes the URI to file, short lived token and expiry of the token in the ReportsTypes.Location object.

Operation Errors:
NotFound - if there is no report for the given id.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown 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 VcIntegrity.HardwareCompatibility.Read.

Parameters:

report - identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.

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

invocationConfig - Configuration for the method invocation.