com.vmware.nsx

Interface ManualHealthChecks

All Superinterfaces:

ManualHealthChecksTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ManualHealthChecksStub

public interface ManualHealthChecks
extends com.vmware.vapi.bindings.Service, ManualHealthChecksTypes

Field Summary

Fields inherited from interface com.vmware.nsx.ManualHealthChecksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ManualHealthCheck	create(ManualHealthCheck manualHealthCheck) Create a new manual health check request with essential properties.
void	create(ManualHealthCheck manualHealthCheck, com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback) Create a new manual health check request with essential properties.
void	create(ManualHealthCheck manualHealthCheck, com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a new manual health check request with essential properties.
ManualHealthCheck	create(ManualHealthCheck manualHealthCheck, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a new manual health check request with essential properties.
void	delete(java.lang.String manualHealthCheckId) Delete an existing manual health check by ID.
void	delete(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete an existing manual health check by ID.
void	delete(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an existing manual health check by ID.
void	delete(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an existing manual health check by ID.
ManualHealthCheck	get(java.lang.String manualHealthCheckId) Get an existing manual health check by health check ID.
void	get(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback) Get an existing manual health check by health check ID.
void	get(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get an existing manual health check by health check ID.
ManualHealthCheck	get(java.lang.String manualHealthCheckId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get an existing manual health check by health check ID.
ManualHealthCheckListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Query manual health checks with list parameters.
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<ManualHealthCheckListResult> asyncCallback) Query manual health checks with list parameters.
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<ManualHealthCheckListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Query manual health checks with list parameters.
ManualHealthCheckListResult	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) Query manual health checks with list parameters.

Method Detail

create

ManualHealthCheck create(ManualHealthCheck manualHealthCheck)

Create a new manual health check request with essential properties. It's disallowed to create new one until the count of in-progress manual health check is less than 50. A manual health check will be deleted automatically after finished for 24 hours.

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

Parameters:

manualHealthCheck - (required)

Returns:

com.vmware.nsx.model.ManualHealthCheck

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

ManualHealthCheck create(ManualHealthCheck manualHealthCheck,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new manual health check request with essential properties. It's disallowed to create new one until the count of in-progress manual health check is less than 50. A manual health check will be deleted automatically after finished for 24 hours.

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:

manualHealthCheck - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ManualHealthCheck

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

void create(ManualHealthCheck manualHealthCheck,
            com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback)

Create a new manual health check request with essential properties. It's disallowed to create new one until the count of in-progress manual health check is less than 50. A manual health check will be deleted automatically after finished for 24 hours.

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

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

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

Parameters:

manualHealthCheck - (required)

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

create

void create(ManualHealthCheck manualHealthCheck,
            com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a new manual health check request with essential properties. It's disallowed to create new one until the count of in-progress manual health check is less than 50. A manual health check will be deleted automatically after finished for 24 hours.

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

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

Parameters:

manualHealthCheck - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String manualHealthCheckId)

Delete an existing manual health check by ID.

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

Parameters:

manualHealthCheckId - (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

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

Delete an existing manual health check by ID.

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:

manualHealthCheckId - (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

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

Delete an existing manual health check by ID.

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:

manualHealthCheckId - (required)

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

delete

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

Delete an existing manual health check by ID.

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:

manualHealthCheckId - (required)

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

invocationConfig - Configuration for the method invocation.

get

ManualHealthCheck get(java.lang.String manualHealthCheckId)

Get an existing manual health check by health check ID.

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

Parameters:

manualHealthCheckId - (required)

Returns:

com.vmware.nsx.model.ManualHealthCheck

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

ManualHealthCheck get(java.lang.String manualHealthCheckId,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get an existing manual health check by health check ID.

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:

manualHealthCheckId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ManualHealthCheck

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 manualHealthCheckId,
         com.vmware.vapi.bindings.client.AsyncCallback<ManualHealthCheck> asyncCallback)

Get an existing manual health check by health check ID.

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

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

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

Parameters:

manualHealthCheckId - (required)

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

get

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

Get an existing manual health check by health check ID.

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

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

Parameters:

manualHealthCheckId - (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Query manual health checks with list parameters.

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)

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

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

ManualHealthCheckListResult 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)

Query manual health checks with list parameters.

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)

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

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

Query manual health checks with list parameters.

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

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

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)

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

Query manual health checks with list parameters.

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

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)

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.