com.vmware.nsx

Interface Traceflows

All Superinterfaces:

com.vmware.vapi.bindings.Service, TraceflowsTypes

All Known Implementing Classes:

TraceflowsStub

public interface Traceflows
extends com.vmware.vapi.bindings.Service, TraceflowsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.TraceflowsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Traceflow	create(TraceflowRequest traceflowRequest) Deprecated.
void	create(TraceflowRequest traceflowRequest, com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback) Deprecated.
void	create(TraceflowRequest traceflowRequest, com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
Traceflow	create(TraceflowRequest traceflowRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String traceflowId) Deprecated.
void	delete(java.lang.String traceflowId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String traceflowId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String traceflowId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
Traceflow	get(java.lang.String traceflowId) Deprecated.
void	get(java.lang.String traceflowId, com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback) Deprecated.
void	get(java.lang.String traceflowId, com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
Traceflow	get(java.lang.String traceflowId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
TraceflowListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String lportId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String lportId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<TraceflowListResult> asyncCallback) List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String lportId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<TraceflowListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.
TraceflowListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String lportId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

Method Detail

create

@Deprecated
Traceflow create(TraceflowRequest traceflowRequest)

Deprecated.

Initiate a Traceflow Operation on the Specified Port

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

Parameters:

traceflowRequest - (required)

Returns:

com.vmware.nsx.model.Traceflow

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

create

@Deprecated
Traceflow create(TraceflowRequest traceflowRequest,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Initiate a Traceflow Operation on the Specified Port

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:

traceflowRequest - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.Traceflow

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

create

@Deprecated
void create(TraceflowRequest traceflowRequest,
                        com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback)

Deprecated.

Initiate a Traceflow Operation on the Specified Port

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

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

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

Parameters:

traceflowRequest - (required)

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

create

@Deprecated
void create(TraceflowRequest traceflowRequest,
                        com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Initiate a Traceflow Operation on the Specified Port

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

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

Parameters:

traceflowRequest - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String traceflowId)

Deprecated.

Delete the Traceflow round

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

Parameters:

traceflowId - (required)

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

delete

@Deprecated
void delete(java.lang.String traceflowId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete the Traceflow round

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:

traceflowId - (required)

invocationConfig - Configuration for the method invocation.

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

delete

@Deprecated
void delete(java.lang.String traceflowId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Delete the Traceflow round

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

Parameters:

traceflowId - (required)

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

delete

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

Deprecated.

Delete the Traceflow round

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

Parameters:

traceflowId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
Traceflow get(java.lang.String traceflowId)

Deprecated.

Get the Traceflow round status and result summary

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

Parameters:

traceflowId - (required)

Returns:

com.vmware.nsx.model.Traceflow

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

@Deprecated
Traceflow get(java.lang.String traceflowId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get the Traceflow round status and result summary

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:

traceflowId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.Traceflow

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

@Deprecated
void get(java.lang.String traceflowId,
                     com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback)

Deprecated.

Get the Traceflow round status and result summary

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

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

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

Parameters:

traceflowId - (required)

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

get

@Deprecated
void get(java.lang.String traceflowId,
                     com.vmware.vapi.bindings.client.AsyncCallback<Traceflow> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get the Traceflow round status and result summary

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

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

Parameters:

traceflowId - (required)

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

invocationConfig - Configuration for the method invocation.

list

TraceflowListResult list(java.lang.String cursor,
                         java.lang.String includedFields,
                         java.lang.String lportId,
                         java.lang.Long pageSize,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy)

List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

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

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)

lportId - id of the source logical port where the trace flows originated (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.TraceflowListResult

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

list

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

List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

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:

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)

lportId - id of the source logical port where the trace flows originated (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.TraceflowListResult

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

list

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

List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

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

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

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

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)

lportId - id of the source logical port where the trace flows originated (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

void list(java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.String lportId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<TraceflowListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

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

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

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)

lportId - id of the source logical port where the trace flows originated (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.