com.vmware.esx.hcl

Class ReportsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.hcl.ReportsStub

All Implemented Interfaces:

Reports, ReportsTypes, Service

public class ReportsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Reports

Remote stub implementation of the Reports API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

ReportsTypes.Location, ReportsTypes.Token

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.hcl.ReportsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ReportsStub(ApiProvider apiProvider, StubConfigurationBase config)
ReportsStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportsStub

public ReportsStub(ApiProvider apiProvider,
                   com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                   StubConfigurationBase config)

ReportsStub

public ReportsStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

get

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

Description copied from interface: Reports

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.

Specified by:

get in interface Reports

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.

get

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

Description copied from interface: Reports

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.

Specified by:

get in interface Reports

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.

get

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

Description copied from interface: Reports

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.

Specified by:

get in interface Reports

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

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

Description copied from interface: Reports

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.

Specified by:

get in interface Reports

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.