Package com.vmware.nsx_policy.infra.lb_services

Interface DetailedStatus

All Superinterfaces:

DetailedStatusTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

DetailedStatusStub

public interface DetailedStatus
extends com.vmware.vapi.bindings.Service, DetailedStatusTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.lb_services.DetailedStatusTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME

Method Summary

Modifier and Type	Method	Description
AggregateLBServiceStatus	get(java.lang.String lbServiceId, java.lang.String enforcementPointPath, java.lang.Boolean includeInstanceDetails, java.lang.String source, java.lang.String transportNodeIds)	Get LBService detailed status information.
void	get(java.lang.String lbServiceId, java.lang.String enforcementPointPath, java.lang.Boolean includeInstanceDetails, java.lang.String source, java.lang.String transportNodeIds, com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBServiceStatus> asyncCallback)	Get LBService detailed status information.
void	get(java.lang.String lbServiceId, java.lang.String enforcementPointPath, java.lang.Boolean includeInstanceDetails, java.lang.String source, java.lang.String transportNodeIds, com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBServiceStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get LBService detailed status information.
AggregateLBServiceStatus	get(java.lang.String lbServiceId, java.lang.String enforcementPointPath, java.lang.Boolean includeInstanceDetails, java.lang.String source, java.lang.String transportNodeIds, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get LBService detailed status information.

Method Detail

get

AggregateLBServiceStatus get(java.lang.String lbServiceId,
                             java.lang.String enforcementPointPath,
                             java.lang.Boolean includeInstanceDetails,
                             java.lang.String source,
                             java.lang.String transportNodeIds)

Get LBService detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. 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)

enforcementPointPath - String Path of the enforcement point (optional)

includeInstanceDetails - Flag to indicate whether include detail information (optional, default to false)

source - Data source type. (optional)

transportNodeIds - The UUIDs of transport nodes (optional)

Returns:

com.vmware.nsx_policy.model.AggregateLBServiceStatus

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

AggregateLBServiceStatus get(java.lang.String lbServiceId,
                             java.lang.String enforcementPointPath,
                             java.lang.Boolean includeInstanceDetails,
                             java.lang.String source,
                             java.lang.String transportNodeIds,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get LBService detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. 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)

enforcementPointPath - String Path of the enforcement point (optional)

includeInstanceDetails - Flag to indicate whether include detail information (optional, default to false)

source - Data source type. (optional)

transportNodeIds - The UUIDs of transport nodes (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.AggregateLBServiceStatus

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,
         java.lang.String enforcementPointPath,
         java.lang.Boolean includeInstanceDetails,
         java.lang.String source,
         java.lang.String transportNodeIds,
         com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBServiceStatus> asyncCallback)

Get LBService detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. 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.AggregateLBServiceStatus

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

Parameters:

lbServiceId - LBService id (required)

enforcementPointPath - String Path of the enforcement point (optional)

includeInstanceDetails - Flag to indicate whether include detail information (optional, default to false)

source - Data source type. (optional)

transportNodeIds - The UUIDs of transport nodes (optional)

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

get

void get(java.lang.String lbServiceId,
         java.lang.String enforcementPointPath,
         java.lang.Boolean includeInstanceDetails,
         java.lang.String source,
         java.lang.String transportNodeIds,
         com.vmware.vapi.bindings.client.AsyncCallback<AggregateLBServiceStatus> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get LBService detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. 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.AggregateLBServiceStatus

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

Parameters:

lbServiceId - LBService id (required)

enforcementPointPath - String Path of the enforcement point (optional)

includeInstanceDetails - Flag to indicate whether include detail information (optional, default to false)

source - Data source type. (optional)

transportNodeIds - The UUIDs of transport nodes (optional)

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

invocationConfig - Configuration for the method invocation.