Package com.vmware.nsx_policy.infra

Interface ServiceChains

All Superinterfaces:

com.vmware.vapi.bindings.Service, ServiceChainsTypes

All Known Implementing Classes:

ServiceChainsStub

public interface ServiceChains
extends com.vmware.vapi.bindings.Service, ServiceChainsTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String serviceChainId)	This API can be user to delete service chain with given service-chain-id.
void	delete(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	This API can be user to delete service chain with given service-chain-id.
void	delete(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This API can be user to delete service chain with given service-chain-id.
void	delete(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This API can be user to delete service chain with given service-chain-id.
PolicyServiceChain	get(java.lang.String serviceChainId)	This API can be used to read service chain with given service-chain-id.
void	get(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback)	This API can be used to read service chain with given service-chain-id.
void	get(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This API can be used to read service chain with given service-chain-id.
PolicyServiceChain	get(java.lang.String serviceChainId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This API can be used to read service chain with given service-chain-id.
PolicyServiceChainListResult	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)	List all the service chains available for service insertion
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<PolicyServiceChainListResult> asyncCallback)	List all the service chains available for service insertion
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<PolicyServiceChainListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List all the service chains available for service insertion
PolicyServiceChainListResult	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)	List all the service chains available for service insertion
void	patch(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain)	Create Service chain representing the sequence in which 3rd party services must be consumed.
void	patch(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Create Service chain representing the sequence in which 3rd party services must be consumed.
void	patch(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create Service chain representing the sequence in which 3rd party services must be consumed.
void	patch(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create Service chain representing the sequence in which 3rd party services must be consumed.
PolicyServiceChain	update(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain)	Create or update Service chain representing the sequence in which 3rd party services must be consumed.
void	update(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback)	Create or update Service chain representing the sequence in which 3rd party services must be consumed.
void	update(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or update Service chain representing the sequence in which 3rd party services must be consumed.
PolicyServiceChain	update(java.lang.String serviceChainId, PolicyServiceChain policyServiceChain, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or update Service chain representing the sequence in which 3rd party services must be consumed.

Method Detail

delete

void delete(java.lang.String serviceChainId)

This API can be user to delete service chain with given service-chain-id.

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

Parameters:

serviceChainId - Id of Service chain (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 serviceChainId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API can be user to delete service chain with given service-chain-id.

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:

serviceChainId - Id of Service chain (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 serviceChainId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

This API can be user to delete service chain with given service-chain-id.

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:

serviceChainId - Id of Service chain (required)

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

delete

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

This API can be user to delete service chain with given service-chain-id.

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:

serviceChainId - Id of Service chain (required)

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

invocationConfig - Configuration for the method invocation.

get

PolicyServiceChain get(java.lang.String serviceChainId)

This API can be used to read service chain with given service-chain-id.

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

Parameters:

serviceChainId - Id of Service chain (required)

Returns:

com.vmware.nsx_policy.model.PolicyServiceChain

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

PolicyServiceChain get(java.lang.String serviceChainId,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API can be used to read service chain with given service-chain-id.

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:

serviceChainId - Id of Service chain (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyServiceChain

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

This API can be used to read service chain with given service-chain-id.

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

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

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

Parameters:

serviceChainId - Id of Service chain (required)

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

get

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

This API can be used to read service chain with given service-chain-id.

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

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

Parameters:

serviceChainId - Id of Service chain (required)

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

invocationConfig - Configuration for the method invocation.

list

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

List all the service chains available for service insertion

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

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

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

List all the service chains available for service insertion

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

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

List all the service chains available for service insertion

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

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

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

List all the service chains available for service insertion

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

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 serviceChainId,
           PolicyServiceChain policyServiceChain)

Create Service chain representing the sequence in which 3rd party services must be consumed.

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

Parameters:

serviceChainId - Service chain id (required)

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

patch

void patch(java.lang.String serviceChainId,
           PolicyServiceChain policyServiceChain,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service chain representing the sequence in which 3rd party services must be consumed.

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:

serviceChainId - Service chain id (required)

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

patch

void patch(java.lang.String serviceChainId,
           PolicyServiceChain policyServiceChain,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Create Service chain representing the sequence in which 3rd party services must be consumed.

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:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

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

patch

void patch(java.lang.String serviceChainId,
           PolicyServiceChain policyServiceChain,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service chain representing the sequence in which 3rd party services must be consumed.

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:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

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

invocationConfig - Configuration for the method invocation.

update

PolicyServiceChain update(java.lang.String serviceChainId,
                          PolicyServiceChain policyServiceChain)

Create or update Service chain representing the sequence in which 3rd party services must be consumed.

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

Parameters:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

Returns:

com.vmware.nsx_policy.model.PolicyServiceChain

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

PolicyServiceChain update(java.lang.String serviceChainId,
                          PolicyServiceChain policyServiceChain,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or update Service chain representing the sequence in which 3rd party services must be consumed.

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:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyServiceChain

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 serviceChainId,
            PolicyServiceChain policyServiceChain,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback)

Create or update Service chain representing the sequence in which 3rd party services must be consumed.

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

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

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

Parameters:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

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

update

void update(java.lang.String serviceChainId,
            PolicyServiceChain policyServiceChain,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyServiceChain> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or update Service chain representing the sequence in which 3rd party services must be consumed.

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

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

Parameters:

serviceChainId - Service chain id (required)

policyServiceChain - (required)

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

invocationConfig - Configuration for the method invocation.