Package com.vmware.nsx_policy.infra.sha

Interface PreDefinedPlugins

All Superinterfaces:

PreDefinedPluginsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PreDefinedPluginsStub

public interface PreDefinedPlugins
extends com.vmware.vapi.bindings.Service, PreDefinedPluginsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.sha.PreDefinedPluginsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
ShaPredefinedPlugin	get(java.lang.String pluginId)	Read SHA pre-defined plugin.
void	get(java.lang.String pluginId, com.vmware.vapi.bindings.client.AsyncCallback<ShaPredefinedPlugin> asyncCallback)	Read SHA pre-defined plugin.
void	get(java.lang.String pluginId, com.vmware.vapi.bindings.client.AsyncCallback<ShaPredefinedPlugin> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read SHA pre-defined plugin.
ShaPredefinedPlugin	get(java.lang.String pluginId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read SHA pre-defined plugin.
ShaPreDefinedPluginListResult	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)	API will provide list of Sha pre-defined plugins.
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<ShaPreDefinedPluginListResult> asyncCallback)	API will provide list of Sha pre-defined plugins.
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<ShaPreDefinedPluginListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	API will provide list of Sha pre-defined plugins.
ShaPreDefinedPluginListResult	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)	API will provide list of Sha pre-defined plugins.

Method Detail

get

ShaPredefinedPlugin get(java.lang.String pluginId)

Read SHA pre-defined plugin.

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

Parameters:

pluginId - Sha pre-defined plugin (required)

Returns:

com.vmware.nsx_policy.model.ShaPredefinedPlugin

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

ShaPredefinedPlugin get(java.lang.String pluginId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read SHA pre-defined plugin.

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:

pluginId - Sha pre-defined plugin (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ShaPredefinedPlugin

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

Read SHA pre-defined plugin.

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

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

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

Parameters:

pluginId - Sha pre-defined plugin (required)

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

get

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

Read SHA pre-defined plugin.

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

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

Parameters:

pluginId - Sha pre-defined plugin (required)

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

invocationConfig - Configuration for the method invocation.

list

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

API will provide list of Sha pre-defined plugins.

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

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

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

API will provide list of Sha pre-defined plugins.

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

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

API will provide list of Sha pre-defined plugins.

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

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

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

API will provide list of Sha pre-defined plugins.

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

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.