com.vmware.nsx_policy.infra

Interface LbServices

All Superinterfaces:

LbServicesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LbServicesStub

public interface LbServices
extends com.vmware.vapi.bindings.Service, LbServicesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String lbServiceId, java.lang.Boolean force) Delete the LBService along with all the entities contained by this LBService.
void	delete(java.lang.String lbServiceId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete the LBService along with all the entities contained by this LBService.
void	delete(java.lang.String lbServiceId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the LBService along with all the entities contained by this LBService.
void	delete(java.lang.String lbServiceId, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the LBService along with all the entities contained by this LBService.
LBService	get(java.lang.String lbServiceId) Read an LBService.
void	get(java.lang.String lbServiceId, com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback) Read an LBService.
void	get(java.lang.String lbServiceId, com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read an LBService.
LBService	get(java.lang.String lbServiceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read an LBService.
LBServiceListResult	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) Paginated list of all LBService.
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<LBServiceListResult> asyncCallback) Paginated list of all LBService.
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<LBServiceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Paginated list of all LBService.
LBServiceListResult	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) Paginated list of all LBService.
void	patch(java.lang.String lbServiceId, LBService lbService) If a LBService with the lb-service-id is not already present, create a new LBService.
void	patch(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) If a LBService with the lb-service-id is not already present, create a new LBService.
void	patch(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If a LBService with the lb-service-id is not already present, create a new LBService.
void	patch(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If a LBService with the lb-service-id is not already present, create a new LBService.
LBService	update(java.lang.String lbServiceId, LBService lbService) If a LBService with the lb-service-id is not already present, create a new LBService.
void	update(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback) If a LBService with the lb-service-id is not already present, create a new LBService.
void	update(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If a LBService with the lb-service-id is not already present, create a new LBService.
LBService	update(java.lang.String lbServiceId, LBService lbService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If a LBService with the lb-service-id is not already present, create a new LBService.

Method Detail

delete

void delete(java.lang.String lbServiceId,
            java.lang.Boolean force)

Delete the LBService along with all the entities contained by this LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

Parameters:

lbServiceId - LBService 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

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

Delete the LBService along with all the entities contained by this LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService 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

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

Delete the LBService along with all the entities contained by this LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService 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

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

Delete the LBService along with all the entities contained by this LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService 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

LBService get(java.lang.String lbServiceId)

Read an LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

Parameters:

lbServiceId - LBService ID (required)

Returns:

com.vmware.nsx_policy.model.LBService

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

LBService get(java.lang.String lbServiceId,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read an LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LBService

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

Read an LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

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

Parameters:

lbServiceId - LBService ID (required)

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

get

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

Read an LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

Parameters:

lbServiceId - LBService ID (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Paginated list of all LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

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

Paginated list of all LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

Paginated list of all LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

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

Paginated list of all LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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 lbServiceId,
           LBService lbService)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

Parameters:

lbServiceId - LBService ID (required)

lbService - (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 lbServiceId,
           LBService lbService,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService ID (required)

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

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService ID (required)

lbService - (required)

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

patch

void patch(java.lang.String lbServiceId,
           LBService lbService,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService ID (required)

lbService - (required)

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

invocationConfig - Configuration for the method invocation.

update

LBService update(java.lang.String lbServiceId,
                 LBService lbService)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

Parameters:

lbServiceId - LBService ID (required)

lbService - (required)

Returns:

com.vmware.nsx_policy.model.LBService

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

LBService update(java.lang.String lbServiceId,
                 LBService lbService,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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:

lbServiceId - LBService ID (required)

lbService - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.LBService

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 lbServiceId,
            LBService lbService,
            com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

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

Parameters:

lbServiceId - LBService ID (required)

lbService - (required)

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

update

void update(java.lang.String lbServiceId,
            LBService lbService,
            com.vmware.vapi.bindings.client.AsyncCallback<LBService> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.

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

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

Parameters:

lbServiceId - LBService ID (required)

lbService - (required)

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

invocationConfig - Configuration for the method invocation.