Package com.vmware.nsx_policy.infra.capacity.dashboard

Class UsageStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.infra.capacity.dashboard.UsageStub

All Implemented Interfaces:

Usage, UsageTypes, com.vmware.vapi.bindings.Service

public class UsageStub
extends com.vmware.vapi.internal.bindings.Stub
implements Usage

Remote stub implementation of the Usage API service.

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

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx_policy.infra.capacity.dashboard.UsageTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CapacityUsageResponse	get(java.lang.String category, java.lang.String cursor, java.lang.Boolean force, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Returns capacity usage data for NSX objects
void	get(java.lang.String category, java.lang.String cursor, java.lang.Boolean force, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<CapacityUsageResponse> asyncCallback)	Returns capacity usage data for NSX objects
void	get(java.lang.String category, java.lang.String cursor, java.lang.Boolean force, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<CapacityUsageResponse> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns capacity usage data for NSX objects
CapacityUsageResponse	get(java.lang.String category, java.lang.String cursor, java.lang.Boolean force, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns capacity usage data for NSX objects

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

UsageStub

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

UsageStub

public UsageStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public CapacityUsageResponse get(java.lang.String category,
                                 java.lang.String cursor,
                                 java.lang.Boolean force,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy)

Description copied from interface: Usage

Returns capacity usage data for NSX objects

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

Specified by:

get in interface Usage

Parameters:

category - (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

force - (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.CapacityUsageResponse

get

public CapacityUsageResponse get(java.lang.String category,
                                 java.lang.String cursor,
                                 java.lang.Boolean force,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Usage

Returns capacity usage data for NSX objects

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 Usage

Parameters:

category - (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

force - (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.CapacityUsageResponse

get

public void get(java.lang.String category,
                java.lang.String cursor,
                java.lang.Boolean force,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                com.vmware.vapi.bindings.client.AsyncCallback<CapacityUsageResponse> asyncCallback)

Description copied from interface: Usage

Returns capacity usage data for NSX objects

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

Invocation Result:
com.vmware.nsx_policy.model.CapacityUsageResponse

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Usage

Parameters:

category - (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

force - (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

get

public void get(java.lang.String category,
                java.lang.String cursor,
                java.lang.Boolean force,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                com.vmware.vapi.bindings.client.AsyncCallback<CapacityUsageResponse> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Usage

Returns capacity usage data for NSX objects

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:
com.vmware.nsx_policy.model.CapacityUsageResponse

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Usage

Parameters:

category - (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

force - (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.