com.vmware.appliance.infraprofile

Interface Configs

All Superinterfaces:

ConfigsTypes, Service

All Known Implementing Classes:

ConfigsStub

public interface Configs
extends Service, ConfigsTypes

Configs interface provides methods to manage desired configuration specification of an appliance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.infraprofile.ConfigsTypes

ConfigsTypes._VAPI_OPERATIONS, ConfigsTypes.ImportProfileSpec, ConfigsTypes.ProfileInfo, ConfigsTypes.ProfilesSpec, ConfigsTypes.ValidationResult, ConfigsTypes.ValidationStatus

Field Summary

Fields inherited from interface com.vmware.appliance.infraprofile.ConfigsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	export(ConfigsTypes.ProfilesSpec spec) Exports the desired profile specification.
void	export(ConfigsTypes.ProfilesSpec spec, AsyncCallback<java.lang.String> asyncCallback) Exports the desired profile specification.
void	export(ConfigsTypes.ProfilesSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Exports the desired profile specification.
java.lang.String	export(ConfigsTypes.ProfilesSpec spec, InvocationConfig invocationConfig) Exports the desired profile specification.
java.lang.String	importProfile_Task(ConfigsTypes.ImportProfileSpec spec) Imports the desired profile specification.
void	importProfile_Task(ConfigsTypes.ImportProfileSpec spec, AsyncCallback<java.lang.String> asyncCallback) Imports the desired profile specification.
void	importProfile_Task(ConfigsTypes.ImportProfileSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Imports the desired profile specification.
java.lang.String	importProfile_Task(ConfigsTypes.ImportProfileSpec spec, InvocationConfig invocationConfig) Imports the desired profile specification.
java.util.List<ConfigsTypes.ProfileInfo>	list() List all the profiles which are registered.
void	list(AsyncCallback<java.util.List<ConfigsTypes.ProfileInfo>> asyncCallback) List all the profiles which are registered.
void	list(AsyncCallback<java.util.List<ConfigsTypes.ProfileInfo>> asyncCallback, InvocationConfig invocationConfig) List all the profiles which are registered.
java.util.List<ConfigsTypes.ProfileInfo>	list(InvocationConfig invocationConfig) List all the profiles which are registered.
java.lang.String	validate_Task(ConfigsTypes.ImportProfileSpec spec) Validates the desired profile specification.
void	validate_Task(ConfigsTypes.ImportProfileSpec spec, AsyncCallback<java.lang.String> asyncCallback) Validates the desired profile specification.
void	validate_Task(ConfigsTypes.ImportProfileSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Validates the desired profile specification.
java.lang.String	validate_Task(ConfigsTypes.ImportProfileSpec spec, InvocationConfig invocationConfig) Validates the desired profile specification.

Method Detail

list

java.util.List<ConfigsTypes.ProfileInfo> list()

List all the profiles which are registered.

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

Returns:

List of profiles with description are registered.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

list

java.util.List<ConfigsTypes.ProfileInfo> list(InvocationConfig invocationConfig)

List all the profiles which are registered.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of profiles with description are registered.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

list

void list(AsyncCallback<java.util.List<ConfigsTypes.ProfileInfo>> asyncCallback)

List all the profiles which are registered.

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

Invocation Result:
List of profiles with description are registered.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

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

list

void list(AsyncCallback<java.util.List<ConfigsTypes.ProfileInfo>> asyncCallback,
          InvocationConfig invocationConfig)

List all the profiles which are registered.

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:
List of profiles with description are registered.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

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

invocationConfig - Configuration for the method invocation.

export

java.lang.String export(ConfigsTypes.ProfilesSpec spec)

Exports the desired profile specification.

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

Parameters:

spec - information to export the profile.

Returns:

Configuration specification JSON in string format.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

export

java.lang.String export(ConfigsTypes.ProfilesSpec spec,
                        InvocationConfig invocationConfig)

Exports the desired profile specification.

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:

spec - information to export the profile.

invocationConfig - Configuration for the method invocation.

Returns:

Configuration specification JSON in string format.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

export

void export(ConfigsTypes.ProfilesSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Exports the desired profile specification.

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

Invocation Result:
Configuration specification JSON in string format.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to export the profile.

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

export

void export(ConfigsTypes.ProfilesSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Exports the desired profile specification.

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:
Configuration specification JSON in string format.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to export the profile.

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

invocationConfig - Configuration for the method invocation.

validate_Task

java.lang.String validate_Task(ConfigsTypes.ImportProfileSpec spec)

Validates the desired profile specification.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec - information to validate the profile.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

validate_Task

java.lang.String validate_Task(ConfigsTypes.ImportProfileSpec spec,
                               InvocationConfig invocationConfig)

Validates the desired profile specification.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - information to validate the profile.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

validate_Task

void validate_Task(ConfigsTypes.ImportProfileSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback)

Validates the desired profile specification.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to validate the profile.

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

validate_Task

void validate_Task(ConfigsTypes.ImportProfileSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback,
                   InvocationConfig invocationConfig)

Validates the desired profile specification.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to validate the profile.

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

invocationConfig - Configuration for the method invocation.

importProfile_Task

java.lang.String importProfile_Task(ConfigsTypes.ImportProfileSpec spec)

Imports the desired profile specification.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec - information to import the profile.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

NotAllowedInCurrentState - If there is another operation in progress.

Unauthenticated - If the caller is not authenticated.

importProfile_Task

java.lang.String importProfile_Task(ConfigsTypes.ImportProfileSpec spec,
                                    InvocationConfig invocationConfig)

Imports the desired profile specification.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - information to import the profile.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no profile associated.

ServiceUnavailable - If the service is not available.

NotAllowedInCurrentState - If there is another operation in progress.

Unauthenticated - If the caller is not authenticated.

importProfile_Task

void importProfile_Task(ConfigsTypes.ImportProfileSpec spec,
                        AsyncCallback<java.lang.String> asyncCallback)

Imports the desired profile specification.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
NotAllowedInCurrentState - If there is another operation in progress.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to import the profile.

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

importProfile_Task

void importProfile_Task(ConfigsTypes.ImportProfileSpec spec,
                        AsyncCallback<java.lang.String> asyncCallback,
                        InvocationConfig invocationConfig)

Imports the desired profile specification.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no profile associated.
ServiceUnavailable - If the service is not available.
NotAllowedInCurrentState - If there is another operation in progress.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec - information to import the profile.

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

invocationConfig - Configuration for the method invocation.