com.vmware.vcenter.lcm

Class ReportsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.lcm.ReportsStub

All Implemented Interfaces:

Service, Reports, ReportsTypes

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.vcenter.lcm.ReportsTypes

ReportsTypes.Location, ReportsTypes.Token

Field Summary

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

apiProvider, converter, ifaceId, securityContext

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

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

invokeMethod, invokeMethodAsync, 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 the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the Reports.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.

Specified by:

get in interface Reports

Parameters:

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

get

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

Description copied from interface: Reports

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 Reports.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.

Specified by:

get in interface Reports

Parameters:

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

invocationConfig - Configuration for the method invocation.

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 the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the Reports.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.

Specified by:

get in interface Reports

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

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 the report for the specified file name.

Retrieving a report involves two steps:

• Step 1: Invoke the Reports.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.

Specified by:

get in interface Reports

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.