com.vmware.nsx.capacity

Interface Usage

All Superinterfaces:

com.vmware.vapi.bindings.Service, UsageTypes

All Known Implementing Classes:

UsageStub

public interface Usage
extends com.vmware.vapi.bindings.Service, UsageTypes

Field Summary

Fields inherited from interface com.vmware.nsx.capacity.UsageTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and 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

Method Detail

get

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

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

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.model.CapacityUsageResponse

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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:

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.model.CapacityUsageResponse

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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

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

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

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

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

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.model.CapacityUsageResponse

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

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.