Package com.vmware.nsx_policy.infra.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_policy.infra.capacity.UsageTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
PolicyCapacityUsageResponse	get(java.lang.String category, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Deprecated.
void	get(java.lang.String category, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyCapacityUsageResponse> asyncCallback)	Deprecated.
void	get(java.lang.String category, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyCapacityUsageResponse> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Deprecated.
PolicyCapacityUsageResponse	get(java.lang.String category, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Deprecated.

Method Detail

get

@Deprecated
PolicyCapacityUsageResponse get(java.lang.String category,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)

Deprecated.

Returns capacity usage data for NSX objects

This API is no longer been used by UI, please use below policy api instead.
GET https:///policy/api/v1/infra/capacity/dashboard/usage

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)

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

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

@Deprecated
PolicyCapacityUsageResponse get(java.lang.String category,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns capacity usage data for NSX objects

This API is no longer been used by UI, please use below policy api instead.
GET https:///policy/api/v1/infra/capacity/dashboard/usage

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)

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

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

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

Deprecated.

Returns capacity usage data for NSX objects

This API is no longer been used by UI, please use below policy api instead.
GET https:///policy/api/v1/infra/capacity/dashboard/usage

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

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

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)

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

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

Deprecated.

Returns capacity usage data for NSX objects

This API is no longer been used by UI, please use below policy api instead.
GET https:///policy/api/v1/infra/capacity/dashboard/usage

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

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)

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.