com.vmware.nsx.loadbalancer

Class RulesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.loadbalancer.RulesStub

All Implemented Interfaces:

Rules, RulesTypes, com.vmware.vapi.bindings.Service

public class RulesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Rules

Remote stub implementation of the Rules 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.RulesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
RulesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
RulesStub(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
LbRule	create(LbRule lbRule) Create a load balancer rule.
void	create(LbRule lbRule, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback) Create a load balancer rule.
void	create(LbRule lbRule, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a load balancer rule.
LbRule	create(LbRule lbRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a load balancer rule.
void	delete(java.lang.String ruleId) Delete a load balancer rule.
void	delete(java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a load balancer rule.
void	delete(java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a load balancer rule.
void	delete(java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a load balancer rule.
LbRule	get(java.lang.String ruleId) Retrieve a load balancer rule.
void	get(java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback) Retrieve a load balancer rule.
void	get(java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve a load balancer rule.
LbRule	get(java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve a load balancer rule.
LbRuleListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Retrieve a paginated list of load balancer rules.
void	list(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<LbRuleListResult> asyncCallback) Retrieve a paginated list of load balancer rules.
void	list(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<LbRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve a paginated list of load balancer rules.
LbRuleListResult	list(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) Retrieve a paginated list of load balancer rules.
LbRule	update(java.lang.String ruleId, LbRule lbRule) Update a load balancer rule.
void	update(java.lang.String ruleId, LbRule lbRule, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback) Update a load balancer rule.
void	update(java.lang.String ruleId, LbRule lbRule, com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a load balancer rule.
LbRule	update(java.lang.String ruleId, LbRule lbRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a load balancer rule.

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

RulesStub

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

RulesStub

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

Method Detail

create

public LbRule create(LbRule lbRule)

Description copied from interface: Rules

Create a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

Specified by:

create in interface Rules

Parameters:

lbRule - (required)

Returns:

com.vmware.nsx.model.LbRule

create

public LbRule create(LbRule lbRule,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Create a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

lbRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbRule

create

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

Description copied from interface: Rules

Create a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

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

Specified by:

create in interface Rules

Parameters:

lbRule - (required)

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

create

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

Description copied from interface: Rules

Create a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

Specified by:

create in interface Rules

Parameters:

lbRule - (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 ruleId)

Description copied from interface: Rules

Delete a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

Specified by:

delete in interface Rules

Parameters:

ruleId - (required)

delete

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

Description copied from interface: Rules

Delete a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

ruleId - (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Rules

Delete a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

ruleId - (required)

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

delete

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

Description copied from interface: Rules

Delete a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

get

public LbRule get(java.lang.String ruleId)

Description copied from interface: Rules

Retrieve a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

Specified by:

get in interface Rules

Parameters:

ruleId - (required)

Returns:

com.vmware.nsx.model.LbRule

get

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

Description copied from interface: Rules

Retrieve a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbRule

get

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

Description copied from interface: Rules

Retrieve a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

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

Specified by:

get in interface Rules

Parameters:

ruleId - (required)

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

get

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

Description copied from interface: Rules

Retrieve a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

Specified by:

get in interface Rules

Parameters:

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Description copied from interface: Rules

Retrieve a paginated list of load balancer rules.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

Specified by:

list in interface Rules

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)

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

list

public LbRuleListResult list(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)

Description copied from interface: Rules

Retrieve a paginated list of load balancer rules.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

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)

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

list

public void list(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<LbRuleListResult> asyncCallback)

Description copied from interface: Rules

Retrieve a paginated list of load balancer rules.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

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

Specified by:

list in interface Rules

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)

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.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<LbRuleListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Retrieve a paginated list of load balancer rules.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

Specified by:

list in interface Rules

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)

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 LbRule update(java.lang.String ruleId,
                     LbRule lbRule)

Description copied from interface: Rules

Update a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

Specified by:

update in interface Rules

Parameters:

ruleId - (required)

lbRule - (required)

Returns:

com.vmware.nsx.model.LbRule

update

public LbRule update(java.lang.String ruleId,
                     LbRule lbRule,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Update a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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 Rules

Parameters:

ruleId - (required)

lbRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LbRule

update

public void update(java.lang.String ruleId,
                   LbRule lbRule,
                   com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback)

Description copied from interface: Rules

Update a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

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

Specified by:

update in interface Rules

Parameters:

ruleId - (required)

lbRule - (required)

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

update

public void update(java.lang.String ruleId,
                   LbRule lbRule,
                   com.vmware.vapi.bindings.client.AsyncCallback<LbRule> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Update a load balancer rule.

NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.

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

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

Specified by:

update in interface Rules

Parameters:

ruleId - (required)

lbRule - (required)

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

invocationConfig - Configuration for the method invocation.