com.vmware.nsx.loadbalancer

Class ServicesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.loadbalancer.ServicesStub

All Implemented Interfaces:

Services, ServicesTypes, com.vmware.vapi.bindings.Service

public class ServicesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Services

Remote stub implementation of the Services API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.loadbalancer.ServicesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ServicesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ServicesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
LbService	create(LbService lbService) Synchronous method overload.
void	create(LbService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback) Asynchronous method overload.
void	create(LbService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
LbService	create(LbService lbService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
void	delete(java.lang.String serviceId) Synchronous method overload.
void	delete(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Asynchronous method overload.
void	delete(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
void	delete(java.lang.String serviceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
LbService	get(java.lang.String serviceId) Synchronous method overload.
void	get(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback) Asynchronous method overload.
void	get(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
LbService	get(java.lang.String serviceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
LbServiceListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String logicalRouterId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Retrieve a paginated list of load balancer services.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String logicalRouterId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<LbServiceListResult> asyncCallback) Retrieve a paginated list of load balancer services.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String logicalRouterId, 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) Retrieve a paginated list of load balancer services.
LbServiceListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String logicalRouterId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve a paginated list of load balancer services.
LbService	update(java.lang.String serviceId, LbService lbService) Synchronous method overload.
void	update(java.lang.String serviceId, LbService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback) Asynchronous method overload.
void	update(java.lang.String serviceId, LbService lbService, com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
LbService	update(java.lang.String serviceId, LbService lbService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServicesStub

public ServicesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                    com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                    com.vmware.vapi.bindings.StubConfigurationBase config)

ServicesStub

public ServicesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                    com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

create

public LbService create(LbService lbService)

Description copied from interface: Services

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

Specified by:

create in interface Services

Parameters:

lbService - (required)

Returns:

com.vmware.nsx.model.LbService

create

public LbService create(LbService lbService,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

create in interface Services

Parameters:

lbService - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbService

create

public void create(LbService lbService,
                   com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback)

Description copied from interface: Services

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

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

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

Specified by:

create in interface Services

Parameters:

lbService - (required)

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

create

public void create(LbService lbService,
                   com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

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

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

Specified by:

create in interface Services

Parameters:

lbService - (required)

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String serviceId)

Description copied from interface: Services

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

Specified by:

delete in interface Services

Parameters:

serviceId - (required)

delete

public void delete(java.lang.String serviceId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface Services

Parameters:

serviceId - (required)

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String serviceId,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Services

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

Specified by:

delete in interface Services

Parameters:

serviceId - (required)

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

delete

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

Description copied from interface: Services

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

Specified by:

delete in interface Services

Parameters:

serviceId - (required)

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

invocationConfig - Configuration for the method invocation.

get

public LbService get(java.lang.String serviceId)

Description copied from interface: Services

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

Specified by:

get in interface Services

Parameters:

serviceId - (required)

Returns:

com.vmware.nsx.model.LbService

get

public LbService get(java.lang.String serviceId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Services

Parameters:

serviceId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbService

get

public void get(java.lang.String serviceId,
                com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback)

Description copied from interface: Services

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

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

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

Specified by:

get in interface Services

Parameters:

serviceId - (required)

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

get

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

Description copied from interface: Services

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

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

Specified by:

get in interface Services

Parameters:

serviceId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public LbServiceListResult list(java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.String logicalRouterId,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)

Description copied from interface: Services

Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned.

Use the following Policy API -
GET /policy/api/v1/infra/lb-services

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

Specified by:

list in interface Services

Parameters:

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)

logicalRouterId - Logical router identifier (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.LbServiceListResult

list

public LbServiceListResult list(java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.String logicalRouterId,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned.

Use the following Policy API -
GET /policy/api/v1/infra/lb-services

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Services

Parameters:

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)

logicalRouterId - Logical router identifier (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.LbServiceListResult

list

public void list(java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String logicalRouterId,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<LbServiceListResult> asyncCallback)

Description copied from interface: Services

Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned.

Use the following Policy API -
GET /policy/api/v1/infra/lb-services

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

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

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

Specified by:

list in interface Services

Parameters:

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)

logicalRouterId - Logical router identifier (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

public void list(java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String logicalRouterId,
                 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)

Description copied from interface: Services

Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned.

Use the following Policy API -
GET /policy/api/v1/infra/lb-services

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

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

Specified by:

list in interface Services

Parameters:

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)

logicalRouterId - Logical router identifier (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

public LbService update(java.lang.String serviceId,
                        LbService lbService)

Description copied from interface: Services

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

Specified by:

update in interface Services

Parameters:

serviceId - (required)

lbService - (required)

Returns:

com.vmware.nsx.model.LbService

update

public LbService update(java.lang.String serviceId,
                        LbService lbService,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Services

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Services

Parameters:

serviceId - (required)

lbService - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbService

update

public void update(java.lang.String serviceId,
                   LbService lbService,
                   com.vmware.vapi.bindings.client.AsyncCallback<LbService> asyncCallback)

Description copied from interface: Services

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

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

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

Specified by:

update in interface Services

Parameters:

serviceId - (required)

lbService - (required)

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

update

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

Description copied from interface: Services

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

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

Specified by:

update in interface Services

Parameters:

serviceId - (required)

lbService - (required)

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

invocationConfig - Configuration for the method invocation.