Package com.vmware.nsx_policy.infra

Class LbNodeUsageSummaryStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.infra.LbNodeUsageSummaryStub

All Implemented Interfaces:

LbNodeUsageSummary, LbNodeUsageSummaryTypes, com.vmware.vapi.bindings.Service

public class LbNodeUsageSummaryStub
extends com.vmware.vapi.internal.bindings.Stub
implements LbNodeUsageSummary

Remote stub implementation of the LbNodeUsageSummary 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_policy.infra.LbNodeUsageSummaryTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor	Description
LbNodeUsageSummaryStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
LbNodeUsageSummaryStub(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	Description
AggregateLBNodeUsageSummary	get(java.lang.String enforcementPointPath, java.lang.Boolean includeUsages)	The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point.
void	get(java.lang.String enforcementPointPath, java.lang.Boolean includeUsages, com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBNodeUsageSummary> asyncCallback)	The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point.
void	get(java.lang.String enforcementPointPath, java.lang.Boolean includeUsages, com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBNodeUsageSummary> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point.
AggregateLBNodeUsageSummary	get(java.lang.String enforcementPointPath, java.lang.Boolean includeUsages, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point.

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

LbNodeUsageSummaryStub

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

LbNodeUsageSummaryStub

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

Method Detail

get

public AggregateLBNodeUsageSummary get(java.lang.String enforcementPointPath,
                                       java.lang.Boolean includeUsages)

Description copied from interface: LbNodeUsageSummary

The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point. - If the parameter ?include_usages=true exists, the property node_usages are included in response. By default, the property node_usages is not included in response. - If parameter ?enforcement_point_path= exists, only node usage summary from specific enforcement point is included in response. If no enforcement point path is specified, information will be aggregated from each enforcement point.

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 LbNodeUsageSummary

Parameters:

enforcementPointPath - enforcement point path (optional)

includeUsages - Whether to include usages (optional)

Returns:

com.vmware.nsx_policy.model.AggregateLBNodeUsageSummary

get

public AggregateLBNodeUsageSummary get(java.lang.String enforcementPointPath,
                                       java.lang.Boolean includeUsages,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: LbNodeUsageSummary

The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point. - If the parameter ?include_usages=true exists, the property node_usages are included in response. By default, the property node_usages is not included in response. - If parameter ?enforcement_point_path= exists, only node usage summary from specific enforcement point is included in response. If no enforcement point path is specified, information will be aggregated from each enforcement point.

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 LbNodeUsageSummary

Parameters:

enforcementPointPath - enforcement point path (optional)

includeUsages - Whether to include usages (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.AggregateLBNodeUsageSummary

get

public void get(java.lang.String enforcementPointPath,
                java.lang.Boolean includeUsages,
                com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBNodeUsageSummary> asyncCallback)

Description copied from interface: LbNodeUsageSummary

The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point. - If the parameter ?include_usages=true exists, the property node_usages are included in response. By default, the property node_usages is not included in response. - If parameter ?enforcement_point_path= exists, only node usage summary from specific enforcement point is included in response. If no enforcement point path is specified, information will be aggregated from each enforcement point.

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_policy.model.AggregateLBNodeUsageSummary

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

Specified by:

get in interface LbNodeUsageSummary

Parameters:

enforcementPointPath - enforcement point path (optional)

includeUsages - Whether to include usages (optional)

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

get

public void get(java.lang.String enforcementPointPath,
                java.lang.Boolean includeUsages,
                com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBNodeUsageSummary> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: LbNodeUsageSummary

The API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point. - If the parameter ?include_usages=true exists, the property node_usages are included in response. By default, the property node_usages is not included in response. - If parameter ?enforcement_point_path= exists, only node usage summary from specific enforcement point is included in response. If no enforcement point path is specified, information will be aggregated from each enforcement point.

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_policy.model.AggregateLBNodeUsageSummary

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

Specified by:

get in interface LbNodeUsageSummary

Parameters:

enforcementPointPath - enforcement point path (optional)

includeUsages - Whether to include usages (optional)

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

invocationConfig - Configuration for the method invocation.