Package com.vmware.nsx_policy.global_infra

Interface QosProfiles

All Superinterfaces:

QosProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

QosProfilesStub

public interface QosProfiles
extends com.vmware.vapi.bindings.Service, QosProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.QosProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String qosProfileId, java.lang.Boolean override)	API will delete QoS profile.
void	delete(java.lang.String qosProfileId, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	API will delete QoS profile.
void	delete(java.lang.String qosProfileId, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will delete QoS profile.
void	delete(java.lang.String qosProfileId, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will delete QoS profile.
QosProfile	get(java.lang.String qosProfileId)	API will return details of QoS profile.
void	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback)	API will return details of QoS profile.
void	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will return details of QoS profile.
QosProfile	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will return details of QoS profile.
QosProfileListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	API will list all QoS profiles.
void	list(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<QosProfileListResult> asyncCallback)	API will list all QoS profiles.
void	list(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<QosProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will list all QoS profiles.
QosProfileListResult	list(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)	API will list all QoS profiles.
void	patch(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override)	Create a new QoS profile if the QoS profile with given id does not already exist.
void	patch(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Create a new QoS profile if the QoS profile with given id does not already exist.
void	patch(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create a new QoS profile if the QoS profile with given id does not already exist.
void	patch(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create a new QoS profile if the QoS profile with given id does not already exist.
QosProfile	update(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override)	Create or Replace QoS profile.
void	update(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback)	Create or Replace QoS profile.
void	update(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or Replace QoS profile.
QosProfile	update(java.lang.String qosProfileId, QosProfile qosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or Replace QoS profile.

Method Detail

delete

void delete(java.lang.String qosProfileId,
            java.lang.Boolean override)

API will delete QoS profile.

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

Parameters:

qosProfileId - QoS profile Id (required)

override - Locally override the global object (optional, default to false)

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

delete

void delete(java.lang.String qosProfileId,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

API will delete QoS profile.

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:

qosProfileId - QoS profile Id (required)

override - Locally override the global object (optional, default to false)

invocationConfig - Configuration for the method invocation.

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

delete

void delete(java.lang.String qosProfileId,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

API will delete QoS profile.

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

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

Parameters:

qosProfileId - QoS profile Id (required)

override - Locally override the global object (optional, default to false)

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

delete

void delete(java.lang.String qosProfileId,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

API will delete QoS profile.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

qosProfileId - QoS profile Id (required)

override - Locally override the global object (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

QosProfile get(java.lang.String qosProfileId)

API will return details of QoS profile.

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

Parameters:

qosProfileId - QoS profile Id (required)

Returns:

com.vmware.nsx_policy.model.QoSProfile

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

QosProfile get(java.lang.String qosProfileId,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

API will return details of QoS profile.

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:

qosProfileId - QoS profile Id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.QoSProfile

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 qosProfileId,
         com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback)

API will return details of QoS profile.

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

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

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

Parameters:

qosProfileId - QoS profile Id (required)

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

get

void get(java.lang.String qosProfileId,
         com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

API will return details of QoS profile.

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

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

Parameters:

qosProfileId - QoS profile Id (required)

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

invocationConfig - Configuration for the method invocation.

list

QosProfileListResult list(java.lang.String cursor,
                          java.lang.String includedFields,
                          java.lang.Long pageSize,
                          java.lang.Boolean sortAscending,
                          java.lang.String sortBy)

API will list all QoS profiles.

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

Parameters:

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

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

list

QosProfileListResult list(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)

API will list all QoS profiles.

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:

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

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

list

void list(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<QosProfileListResult> asyncCallback)

API will list all QoS profiles.

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

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

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

Parameters:

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.

list

void list(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<QosProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

API will list all QoS profiles.

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

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

Parameters:

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.

patch

void patch(java.lang.String qosProfileId,
           QosProfile qosProfile,
           java.lang.Boolean override)

Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile.

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

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

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

patch

void patch(java.lang.String qosProfileId,
           QosProfile qosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile.

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:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

invocationConfig - Configuration for the method invocation.

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

patch

void patch(java.lang.String qosProfileId,
           QosProfile qosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile.

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

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

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

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

patch

void patch(java.lang.String qosProfileId,
           QosProfile qosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

update

QosProfile update(java.lang.String qosProfileId,
                  QosProfile qosProfile,
                  java.lang.Boolean override)

Create or Replace QoS profile.

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

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

Returns:

com.vmware.nsx_policy.model.QoSProfile

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

update

QosProfile update(java.lang.String qosProfileId,
                  QosProfile qosProfile,
                  java.lang.Boolean override,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or Replace QoS profile.

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:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.QoSProfile

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

update

void update(java.lang.String qosProfileId,
            QosProfile qosProfile,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback)

Create or Replace QoS profile.

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

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

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

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

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

update

void update(java.lang.String qosProfileId,
            QosProfile qosProfile,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<QosProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or Replace QoS profile.

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

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

Parameters:

qosProfileId - QoS profile Id (required)

qosProfile - (required)

override - Locally override the global object (optional, default to false)

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

invocationConfig - Configuration for the method invocation.