com.vmware.nsx

Interface NsProfiles

All Superinterfaces:

NsProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NsProfilesStub

public interface NsProfiles
extends com.vmware.vapi.bindings.Service, NsProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.NsProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NSProfile	create(NSProfile nsProfile) Deprecated.
void	create(NSProfile nsProfile, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback) Deprecated.
void	create(NSProfile nsProfile, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfile	create(NSProfile nsProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String nsProfileId, java.lang.Boolean force) Deprecated.
void	delete(java.lang.String nsProfileId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String nsProfileId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String nsProfileId, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfile	get(java.lang.String nsProfileId) Deprecated.
void	get(java.lang.String nsProfileId, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback) Deprecated.
void	get(java.lang.String nsProfileId, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfile	get(java.lang.String nsProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfileListResult	list(java.lang.String attributeType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
void	list(java.lang.String attributeType, 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<NSProfileListResult> asyncCallback) Deprecated.
void	list(java.lang.String attributeType, 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<NSProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfileListResult	list(java.lang.String attributeType, 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) Deprecated.
NSProfile	update(java.lang.String nsProfileId, NSProfile nsProfile) Deprecated.
void	update(java.lang.String nsProfileId, NSProfile nsProfile, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback) Deprecated.
void	update(java.lang.String nsProfileId, NSProfile nsProfile, com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NSProfile	update(java.lang.String nsProfileId, NSProfile nsProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
NSProfile create(NSProfile nsProfile)

Deprecated.

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

Parameters:

nsProfile - (required)

Returns:

com.vmware.nsx.model.NSProfile

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

@Deprecated
NSProfile create(NSProfile nsProfile,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

nsProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NSProfile

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

@Deprecated
void create(NSProfile nsProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback)

Deprecated.

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

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

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

Parameters:

nsProfile - (required)

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

create

@Deprecated
void create(NSProfile nsProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

nsProfile - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String nsProfileId,
                        java.lang.Boolean force)

Deprecated.

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

Parameters:

nsProfileId - NSProfile Id (required)

force - Force delete the resource even if it is being used somewhere (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

@Deprecated
void delete(java.lang.String nsProfileId,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

nsProfileId - NSProfile Id (required)

force - Force delete the resource even if it is being used somewhere (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

@Deprecated
void delete(java.lang.String nsProfileId,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

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:

nsProfileId - NSProfile Id (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

delete

@Deprecated
void delete(java.lang.String nsProfileId,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

nsProfileId - NSProfile Id (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
NSProfile get(java.lang.String nsProfileId)

Deprecated.

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

Parameters:

nsProfileId - NSProfile Id (required)

Returns:

com.vmware.nsx.model.NSProfile

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
NSProfile get(java.lang.String nsProfileId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

nsProfileId - NSProfile Id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NSProfile

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(java.lang.String nsProfileId,
                     com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback)

Deprecated.

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

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

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

Parameters:

nsProfileId - NSProfile Id (required)

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

get

@Deprecated
void get(java.lang.String nsProfileId,
                     com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

nsProfileId - NSProfile Id (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
NSProfileListResult list(java.lang.String attributeType,
                                     java.lang.String cursor,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy)

Deprecated.

List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple attributes and multiple attribute values for each attribute.
This API is deprecated. Use GET /infra/context-profiles

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

Parameters:

attributeType - Fetch NSProfiles for the given attribute type (optional)

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.model.NSProfileListResult

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

@Deprecated
NSProfileListResult list(java.lang.String attributeType,
                                     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)

Deprecated.

List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple attributes and multiple attribute values for each attribute.
This API is deprecated. Use GET /infra/context-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:

attributeType - Fetch NSProfiles for the given attribute type (optional)

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.model.NSProfileListResult

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

@Deprecated
void list(java.lang.String attributeType,
                      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<NSProfileListResult> asyncCallback)

Deprecated.

List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple attributes and multiple attribute values for each attribute.
This API is deprecated. Use GET /infra/context-profiles

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

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

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

Parameters:

attributeType - Fetch NSProfiles for the given attribute type (optional)

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

@Deprecated
void list(java.lang.String attributeType,
                      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<NSProfileListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple attributes and multiple attribute values for each attribute.
This API is deprecated. Use GET /infra/context-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.model.NSProfileListResult

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

Parameters:

attributeType - Fetch NSProfiles for the given attribute type (optional)

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.

update

@Deprecated
NSProfile update(java.lang.String nsProfileId,
                             NSProfile nsProfile)

Deprecated.

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

Parameters:

nsProfileId - NSProfile Id (required)

nsProfile - (required)

Returns:

com.vmware.nsx.model.NSProfile

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
NSProfile update(java.lang.String nsProfileId,
                             NSProfile nsProfile,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

nsProfileId - NSProfile Id (required)

nsProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NSProfile

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(java.lang.String nsProfileId,
                        NSProfile nsProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback)

Deprecated.

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

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

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

Parameters:

nsProfileId - NSProfile Id (required)

nsProfile - (required)

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

update

@Deprecated
void update(java.lang.String nsProfileId,
                        NSProfile nsProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<NSProfile> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

nsProfileId - NSProfile Id (required)

nsProfile - (required)

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

invocationConfig - Configuration for the method invocation.