com.vmware.nsx

Interface UiViews

All Superinterfaces:

com.vmware.vapi.bindings.Service, UiViewsTypes

All Known Implementing Classes:

UiViewsStub

public interface UiViews
extends com.vmware.vapi.bindings.Service, UiViewsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.UiViewsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
View	create(View view) Creates a new View.
void	create(View view, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback) Creates a new View.
void	create(View view, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new View.
View	create(View view, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new View.
void	delete(java.lang.String viewId) Delete View
void	delete(java.lang.String viewId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete View
void	delete(java.lang.String viewId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete View
void	delete(java.lang.String viewId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete View
ViewList	get(java.lang.String tag, java.lang.String viewIds, java.lang.String widgetId) If no query params are specified then all the views entitled for the user are returned.
void	get(java.lang.String tag, java.lang.String viewIds, java.lang.String widgetId, com.vmware.vapi.bindings.client.AsyncCallback<ViewList> asyncCallback) If no query params are specified then all the views entitled for the user are returned.
void	get(java.lang.String tag, java.lang.String viewIds, java.lang.String widgetId, com.vmware.vapi.bindings.client.AsyncCallback<ViewList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If no query params are specified then all the views entitled for the user are returned.
ViewList	get(java.lang.String tag, java.lang.String viewIds, java.lang.String widgetId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If no query params are specified then all the views entitled for the user are returned.
View	get0(java.lang.String viewId) Returns Information about a specific View.
void	get0(java.lang.String viewId, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback) Returns Information about a specific View.
void	get0(java.lang.String viewId, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns Information about a specific View.
View	get0(java.lang.String viewId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns Information about a specific View.
View	update(java.lang.String viewId, View view) Update View
void	update(java.lang.String viewId, View view, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback) Update View
void	update(java.lang.String viewId, View view, com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update View
View	update(java.lang.String viewId, View view, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update View

Method Detail

create

View create(View view)

Creates a new View.

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

Parameters:

view - (required)

Returns:

com.vmware.nsx.model.View

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

create

View create(View view,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new View.

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:

view - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.View

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

create

void create(View view,
            com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback)

Creates a new View.

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

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

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

Parameters:

view - (required)

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

create

void create(View view,
            com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new View.

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

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

Parameters:

view - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String viewId)

Delete View

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

Parameters:

viewId - (required)

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 viewId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete View

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:

viewId - (required)

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 viewId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete View

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:

viewId - (required)

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

delete

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

Delete View

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:

viewId - (required)

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

invocationConfig - Configuration for the method invocation.

get

ViewList get(java.lang.String tag,
             java.lang.String viewIds,
             java.lang.String widgetId)

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

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

Parameters:

tag - The tag for which associated views to be queried. (optional)

viewIds - Ids of the Views (optional)

widgetId - Id of widget configuration (optional)

Returns:

com.vmware.nsx.model.ViewList

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

ViewList get(java.lang.String tag,
             java.lang.String viewIds,
             java.lang.String widgetId,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

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:

tag - The tag for which associated views to be queried. (optional)

viewIds - Ids of the Views (optional)

widgetId - Id of widget configuration (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ViewList

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 tag,
         java.lang.String viewIds,
         java.lang.String widgetId,
         com.vmware.vapi.bindings.client.AsyncCallback<ViewList> asyncCallback)

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

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

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

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

Parameters:

tag - The tag for which associated views to be queried. (optional)

viewIds - Ids of the Views (optional)

widgetId - Id of widget configuration (optional)

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

get

void get(java.lang.String tag,
         java.lang.String viewIds,
         java.lang.String widgetId,
         com.vmware.vapi.bindings.client.AsyncCallback<ViewList> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

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

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

Parameters:

tag - The tag for which associated views to be queried. (optional)

viewIds - Ids of the Views (optional)

widgetId - Id of widget configuration (optional)

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

invocationConfig - Configuration for the method invocation.

get0

View get0(java.lang.String viewId)

Returns Information about a specific View.

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

Parameters:

viewId - (required)

Returns:

com.vmware.nsx.model.View

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

get0

View get0(java.lang.String viewId,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns Information about a specific View.

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:

viewId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.View

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

get0

void get0(java.lang.String viewId,
          com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback)

Returns Information about a specific View.

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

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

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

Parameters:

viewId - (required)

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

get0

void get0(java.lang.String viewId,
          com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns Information about a specific View.

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

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

Parameters:

viewId - (required)

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

invocationConfig - Configuration for the method invocation.

update

View update(java.lang.String viewId,
            View view)

Update View

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

Parameters:

viewId - (required)

view - (required)

Returns:

com.vmware.nsx.model.View

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

View update(java.lang.String viewId,
            View view,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update View

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:

viewId - (required)

view - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.View

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 viewId,
            View view,
            com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback)

Update View

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

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

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

Parameters:

viewId - (required)

view - (required)

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

update

void update(java.lang.String viewId,
            View view,
            com.vmware.vapi.bindings.client.AsyncCallback<View> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update View

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

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

Parameters:

viewId - (required)

view - (required)

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

invocationConfig - Configuration for the method invocation.