com.vmware.nsx.livetraces

Class ResultsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.livetraces.ResultsStub

All Implemented Interfaces:

Results, ResultsTypes, com.vmware.vapi.bindings.Service

public class ResultsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Results

Remote stub implementation of the Results 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.livetraces.ResultsTypes

_VAPI_SERVICE_ID, GET_ACTION_TYPE_COUNT, GET_ACTION_TYPE_DATAPATH_STATS, GET_ACTION_TYPE_PKTCAP, GET_ACTION_TYPE_TRACE

Constructor Summary

Constructors

Constructor and Description
ResultsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ResultsStub(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
LiveTraceResult	get(java.lang.String livetraceSessionId, java.lang.String actionType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get the result of a livetrace session
void	get(java.lang.String livetraceSessionId, java.lang.String actionType, 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<LiveTraceResult> asyncCallback) Get the result of a livetrace session
void	get(java.lang.String livetraceSessionId, java.lang.String actionType, 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<LiveTraceResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the result of a livetrace session
LiveTraceResult	get(java.lang.String livetraceSessionId, java.lang.String actionType, 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) Get the result of a livetrace session

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

ResultsStub

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

ResultsStub

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

Method Detail

get

public LiveTraceResult get(java.lang.String livetraceSessionId,
                           java.lang.String actionType,
                           java.lang.String cursor,
                           java.lang.String includedFields,
                           java.lang.Long pageSize,
                           java.lang.Boolean sortAscending,
                           java.lang.String sortBy)

Description copied from interface: Results

Get the result of a livetrace session

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

Specified by:

get in interface Results

Parameters:

livetraceSessionId - (required)

actionType - The type of observations that will be listed. (optional)

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

get

public LiveTraceResult get(java.lang.String livetraceSessionId,
                           java.lang.String actionType,
                           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: Results

Get the result of a livetrace session

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 Results

Parameters:

livetraceSessionId - (required)

actionType - The type of observations that will be listed. (optional)

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

get

public void get(java.lang.String livetraceSessionId,
                java.lang.String actionType,
                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<LiveTraceResult> asyncCallback)

Description copied from interface: Results

Get the result of a livetrace session

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

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

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

Specified by:

get in interface Results

Parameters:

livetraceSessionId - (required)

actionType - The type of observations that will be listed. (optional)

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.

get

public void get(java.lang.String livetraceSessionId,
                java.lang.String actionType,
                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<LiveTraceResult> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Results

Get the result of a livetrace session

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

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

Specified by:

get in interface Results

Parameters:

livetraceSessionId - (required)

actionType - The type of observations that will be listed. (optional)

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.