vmware::vcenter::lcm::ReportsStub Class Reference

Remote stub implementation of the Reports API service. More...

Inherits vmware::vcenter::lcm::Reports.

List of all members.

Public Member Functions
	ReportsStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	ReportsStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.lcm.ReportsTypes.Location	Get (string report)
	Returns the location Reports.Location information for downloading the report for the specified file name.
vmware.vcenter.lcm.ReportsTypes.Location	Get (string report, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the location Reports.Location information for downloading the report for the specified file name.
global::System.Threading.Tasks.Task < vmware.vcenter.lcm.ReportsTypes.Location >	GetAsync (string report)
	Returns the location Reports.Location information for downloading the report for the specified file name.
global::System.Threading.Tasks.Task < vmware.vcenter.lcm.ReportsTypes.Location >	GetAsync (string report, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the location Reports.Location information for downloading the report for the specified file name.

---

Detailed Description

Remote stub implementation of the Reports API service.

---

Constructor & Destructor Documentation

vmware::vcenter::lcm::ReportsStub::ReportsStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::vcenter::lcm::ReportsStub::ReportsStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.vcenter.lcm.ReportsTypes.Location vmware::vcenter::lcm::ReportsStub::Get

(

string

report

)

[inline]

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

Retrieving a report involves two steps:

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

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.NotFound	If there is no file associated with report in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

report

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

Returns:

Implements vmware::vcenter::lcm::Reports.

vmware.vcenter.lcm.ReportsTypes.Location vmware::vcenter::lcm::ReportsStub::Get	(	string	report,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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

Retrieving a report involves two steps:

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

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.NotFound	If there is no file associated with report in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

report	The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Implements vmware::vcenter::lcm::Reports.

global::System.Threading.Tasks.Task<vmware.vcenter.lcm.ReportsTypes.Location> vmware::vcenter::lcm::ReportsStub::GetAsync

(

string

report

)

[inline]

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

Retrieving a report involves two steps:

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

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.NotFound	If there is no file associated with report in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

report

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

Returns:

Implements vmware::vcenter::lcm::Reports.

global::System.Threading.Tasks.Task<vmware.vcenter.lcm.ReportsTypes.Location> vmware::vcenter::lcm::ReportsStub::GetAsync	(	string	report,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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

Retrieving a report involves two steps:

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

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.NotFound	If there is no file associated with report in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

report	The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Implements vmware::vcenter::lcm::Reports.

---

The documentation for this class was generated from the following file:

• vcenter/lcm/ReportsStub.cs