com.vmware.nsx.firewall

Interface Excludelist

All Superinterfaces:

ExcludelistTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ExcludelistStub

public interface Excludelist
extends com.vmware.vapi.bindings.Service, ExcludelistTypes

Field Summary

Fields inherited from interface com.vmware.nsx.firewall.ExcludelistTypes

_VAPI_SERVICE_ID, CHECKIFEXISTS_OBJECT_TYPE_LOGICALPORT, CHECKIFEXISTS_OBJECT_TYPE_LOGICALSWITCH, CHECKIFEXISTS_OBJECT_TYPE_NSGROUP, REMOVEMEMBER_OBJECT_TYPE_LOGICALPORT, REMOVEMEMBER_OBJECT_TYPE_LOGICALSWITCH, REMOVEMEMBER_OBJECT_TYPE_NSGROUP

Method Summary

Modifier and Type	Method and Description
ResourceReference	addmember(ResourceReference resourceReference) Deprecated.
void	addmember(ResourceReference resourceReference, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback) Deprecated.
void	addmember(ResourceReference resourceReference, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ResourceReference	addmember(ResourceReference resourceReference, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ResourceReference	checkifexists(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType) Check if the object a member of the exclude list
void	checkifexists(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback) Check if the object a member of the exclude list
void	checkifexists(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Check if the object a member of the exclude list
ResourceReference	checkifexists(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Check if the object a member of the exclude list
ExcludeList	get() Deprecated.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback) Deprecated.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ExcludeList	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ResourceReference	removemember(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType) Deprecated.
void	removemember(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback) Deprecated.
void	removemember(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ResourceReference	removemember(java.lang.String objectId, java.lang.Boolean deepCheck, java.lang.String objectType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ExcludeList	update(ExcludeList excludeList) Deprecated.
void	update(ExcludeList excludeList, com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback) Deprecated.
void	update(ExcludeList excludeList, com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ExcludeList	update(ExcludeList excludeList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

addmember

@Deprecated
ResourceReference addmember(ResourceReference resourceReference)

Deprecated.

Add a new object in the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

Parameters:

resourceReference - (required)

Returns:

com.vmware.nsx.model.ResourceReference

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

addmember

@Deprecated
ResourceReference addmember(ResourceReference resourceReference,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a new object in the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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:

resourceReference - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ResourceReference

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

addmember

@Deprecated
void addmember(ResourceReference resourceReference,
                           com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback)

Deprecated.

Add a new object in the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

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

Parameters:

resourceReference - (required)

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

addmember

@Deprecated
void addmember(ResourceReference resourceReference,
                           com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a new object in the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

Parameters:

resourceReference - (required)

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

invocationConfig - Configuration for the method invocation.

checkifexists

ResourceReference checkifexists(java.lang.String objectId,
                                java.lang.Boolean deepCheck,
                                java.lang.String objectType)

Check if the object a member of the exclude list

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

Returns:

com.vmware.nsx.model.ResourceReference

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

checkifexists

ResourceReference checkifexists(java.lang.String objectId,
                                java.lang.Boolean deepCheck,
                                java.lang.String objectType,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Check if the object a member of the exclude list

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:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ResourceReference

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

checkifexists

void checkifexists(java.lang.String objectId,
                   java.lang.Boolean deepCheck,
                   java.lang.String objectType,
                   com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback)

Check if the object a member of the exclude list

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

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

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

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

checkifexists

void checkifexists(java.lang.String objectId,
                   java.lang.Boolean deepCheck,
                   java.lang.String objectType,
                   com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Check if the object a member of the exclude list

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

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
ExcludeList get()

Deprecated.

Get list of entities in exclude list.

Use the following Policy API -
GET /policy/api/v1/infra/settings/firewall/security/exclude-list

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

Returns:

com.vmware.nsx.model.ExcludeList

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
ExcludeList get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get list of entities in exclude list.

Use the following Policy API -
GET /policy/api/v1/infra/settings/firewall/security/exclude-list

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:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ExcludeList

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(com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback)

Deprecated.

Get list of entities in exclude list.

Use the following Policy API -
GET /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

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

Parameters:

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

get

@Deprecated
void get(com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get list of entities in exclude list.

Use the following Policy API -
GET /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

removemember

@Deprecated
ResourceReference removemember(java.lang.String objectId,
                                           java.lang.Boolean deepCheck,
                                           java.lang.String objectType)

Deprecated.

Remove an existing object from the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

Returns:

com.vmware.nsx.model.ResourceReference

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

removemember

@Deprecated
ResourceReference removemember(java.lang.String objectId,
                                           java.lang.Boolean deepCheck,
                                           java.lang.String objectType,
                                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Remove an existing object from the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ResourceReference

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

removemember

@Deprecated
void removemember(java.lang.String objectId,
                              java.lang.Boolean deepCheck,
                              java.lang.String objectType,
                              com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback)

Deprecated.

Remove an existing object from the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

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

removemember

@Deprecated
void removemember(java.lang.String objectId,
                              java.lang.Boolean deepCheck,
                              java.lang.String objectType,
                              com.vmware.vapi.bindings.client.AsyncCallback<ResourceReference> asyncCallback,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Remove an existing object from the exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

Parameters:

objectId - identifier of the object (required)

deepCheck - Check all parents (optional, default to false)

objectType - Object type of an entity (optional)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
ExcludeList update(ExcludeList excludeList)

Deprecated.

Modify exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

Parameters:

excludeList - (required)

Returns:

com.vmware.nsx.model.ExcludeList

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

@Deprecated
ExcludeList update(ExcludeList excludeList,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modify exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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:

excludeList - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ExcludeList

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

@Deprecated
void update(ExcludeList excludeList,
                        com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback)

Deprecated.

Modify exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

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

Parameters:

excludeList - (required)

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

update

@Deprecated
void update(ExcludeList excludeList,
                        com.vmware.vapi.bindings.client.AsyncCallback<ExcludeList> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modify exclude list.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list

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

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

Parameters:

excludeList - (required)

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

invocationConfig - Configuration for the method invocation.