com.vmware.nsx_policy.infra

Interface GatewayQosProfiles

All Superinterfaces:

GatewayQosProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

GatewayQosProfilesStub

public interface GatewayQosProfiles
extends com.vmware.vapi.bindings.Service, GatewayQosProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.GatewayQosProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String qosProfileId, java.lang.Boolean override) Delete QoS profile
void	delete(java.lang.String qosProfileId, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) 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) Delete QoS profile
void	delete(java.lang.String qosProfileId, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete QoS profile
GatewayQosProfile	get(java.lang.String qosProfileId) Read gateway QoS profile
void	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback) Read gateway QoS profile
void	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read gateway QoS profile
GatewayQosProfile	get(java.lang.String qosProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read gateway QoS profile
GatewayQosProfileListResult	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Paginated list of all gateway QoS profle instances
void	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfileListResult> asyncCallback) Paginated list of all gateway QoS profle instances
void	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Paginated list of all gateway QoS profle instances
GatewayQosProfileListResult	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Paginated list of all gateway QoS profle instances
void	patch(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
void	patch(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
void	patch(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
void	patch(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
GatewayQosProfile	update(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
void	update(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
void	update(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.
GatewayQosProfile	update(java.lang.String qosProfileId, GatewayQosProfile gatewayQosProfile, java.lang.Boolean override, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance.

Method Detail

delete

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

Delete QoS profile

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

Parameters:

qosProfileId - (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)

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

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

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 - (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

GatewayQosProfile get(java.lang.String qosProfileId)

Read gateway QoS profile

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

Parameters:

qosProfileId - (required)

Returns:

com.vmware.nsx_policy.model.GatewayQosProfile

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

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

Read gateway 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 - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.GatewayQosProfile

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<GatewayQosProfile> asyncCallback)

Read gateway QoS profile

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

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

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

Parameters:

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

Read gateway 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.GatewayQosProfile

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

Parameters:

qosProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Paginated list of all gateway QoS profle instances

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (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.GatewayQosProfileListResult

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

GatewayQosProfileListResult list(java.lang.String cursor,
                                 java.lang.Boolean includeMarkForDeleteObjects,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Paginated list of all gateway QoS profle instances

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (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.GatewayQosProfileListResult

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.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfileListResult> asyncCallback)

Paginated list of all gateway QoS profle instances

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

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

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (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.

list

void list(java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Paginated list of all gateway QoS profle instances

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

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (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.

patch

void patch(java.lang.String qosProfileId,
           GatewayQosProfile gatewayQosProfile,
           java.lang.Boolean override)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, update the gateway QoS profile instance with specified attributes.

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

Parameters:

qosProfileId - (required)

gatewayQosProfile - (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,
           GatewayQosProfile gatewayQosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, update the gateway QoS profile instance with specified attributes.

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 - (required)

gatewayQosProfile - (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,
           GatewayQosProfile gatewayQosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, update the gateway QoS profile instance with specified attributes.

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 - (required)

gatewayQosProfile - (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,
           GatewayQosProfile gatewayQosProfile,
           java.lang.Boolean override,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, update the gateway QoS profile instance with specified attributes.

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 - (required)

gatewayQosProfile - (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

GatewayQosProfile update(java.lang.String qosProfileId,
                         GatewayQosProfile gatewayQosProfile,
                         java.lang.Boolean override)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, replace the gateway QoS profile instance with this object.

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

Parameters:

qosProfileId - (required)

gatewayQosProfile - (required)

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

Returns:

com.vmware.nsx_policy.model.GatewayQosProfile

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

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

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, replace the gateway QoS profile instance with this object.

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 - (required)

gatewayQosProfile - (required)

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

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.GatewayQosProfile

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,
            GatewayQosProfile gatewayQosProfile,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, replace the gateway QoS profile instance with this object.

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

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

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

Parameters:

qosProfileId - (required)

gatewayQosProfile - (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,
            GatewayQosProfile gatewayQosProfile,
            java.lang.Boolean override,
            com.vmware.vapi.bindings.client.AsyncCallback<GatewayQosProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, replace the gateway QoS profile instance with this object.

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

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

Parameters:

qosProfileId - (required)

gatewayQosProfile - (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.