com.vmware.vmc.orgs

Interface Sddcs

All Superinterfaces:

SddcsTypes, Service

All Known Implementing Classes:

SddcsStub

public interface Sddcs
extends Service, SddcsTypes

Field Summary

Fields inherited from interface com.vmware.vmc.orgs.SddcsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Task	create(java.lang.String org, AwsSddcConfig sddcConfig, java.lang.Boolean validateOnly) Provision an SDDC in target cloud
void	create(java.lang.String org, AwsSddcConfig sddcConfig, java.lang.Boolean validateOnly, AsyncCallback<Task> asyncCallback) Provision an SDDC in target cloud
void	create(java.lang.String org, AwsSddcConfig sddcConfig, java.lang.Boolean validateOnly, AsyncCallback<Task> asyncCallback, InvocationConfig invocationConfig) Provision an SDDC in target cloud
Task	create(java.lang.String org, AwsSddcConfig sddcConfig, java.lang.Boolean validateOnly, InvocationConfig invocationConfig) Provision an SDDC in target cloud
Task	delete(java.lang.String org, java.lang.String sddc, java.lang.Boolean retainConfiguration, java.lang.String templateName, java.lang.Boolean force) Delete SDDC
void	delete(java.lang.String org, java.lang.String sddc, java.lang.Boolean retainConfiguration, java.lang.String templateName, java.lang.Boolean force, AsyncCallback<Task> asyncCallback) Delete SDDC
void	delete(java.lang.String org, java.lang.String sddc, java.lang.Boolean retainConfiguration, java.lang.String templateName, java.lang.Boolean force, AsyncCallback<Task> asyncCallback, InvocationConfig invocationConfig) Delete SDDC
Task	delete(java.lang.String org, java.lang.String sddc, java.lang.Boolean retainConfiguration, java.lang.String templateName, java.lang.Boolean force, InvocationConfig invocationConfig) Delete SDDC
Sddc	get(java.lang.String org, java.lang.String sddc) Get SDDC
void	get(java.lang.String org, java.lang.String sddc, AsyncCallback<Sddc> asyncCallback) Get SDDC
void	get(java.lang.String org, java.lang.String sddc, AsyncCallback<Sddc> asyncCallback, InvocationConfig invocationConfig) Get SDDC
Sddc	get(java.lang.String org, java.lang.String sddc, InvocationConfig invocationConfig) Get SDDC
java.util.List<Sddc>	list(java.lang.String org, java.lang.Boolean includeDeleted) List all the SDDCs of an organization
void	list(java.lang.String org, java.lang.Boolean includeDeleted, AsyncCallback<java.util.List<Sddc>> asyncCallback) List all the SDDCs of an organization
void	list(java.lang.String org, java.lang.Boolean includeDeleted, AsyncCallback<java.util.List<Sddc>> asyncCallback, InvocationConfig invocationConfig) List all the SDDCs of an organization
java.util.List<Sddc>	list(java.lang.String org, java.lang.Boolean includeDeleted, InvocationConfig invocationConfig) List all the SDDCs of an organization
Sddc	patch(java.lang.String org, java.lang.String sddc, SddcPatchRequest sddcPatchRequest) Patch SDDC
void	patch(java.lang.String org, java.lang.String sddc, SddcPatchRequest sddcPatchRequest, AsyncCallback<Sddc> asyncCallback) Patch SDDC
void	patch(java.lang.String org, java.lang.String sddc, SddcPatchRequest sddcPatchRequest, AsyncCallback<Sddc> asyncCallback, InvocationConfig invocationConfig) Patch SDDC
Sddc	patch(java.lang.String org, java.lang.String sddc, SddcPatchRequest sddcPatchRequest, InvocationConfig invocationConfig) Patch SDDC

Method Detail

create

Task create(java.lang.String org,
            AwsSddcConfig sddcConfig,
            java.lang.Boolean validateOnly)

Provision an SDDC in target cloud

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

Parameters:

org - Organization identifier (required)

sddcConfig - sddcConfig (required)

validateOnly - When true, only validates the given sddc configuration without provisioning. (optional)

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

create

Task create(java.lang.String org,
            AwsSddcConfig sddcConfig,
            java.lang.Boolean validateOnly,
            InvocationConfig invocationConfig)

Provision an SDDC in target cloud

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:

org - Organization identifier (required)

sddcConfig - sddcConfig (required)

validateOnly - When true, only validates the given sddc configuration without provisioning. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

create

void create(java.lang.String org,
            AwsSddcConfig sddcConfig,
            java.lang.Boolean validateOnly,
            AsyncCallback<Task> asyncCallback)

Provision an SDDC in target cloud

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

Invocation Result:
com.vmware.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

sddcConfig - sddcConfig (required)

validateOnly - When true, only validates the given sddc configuration without provisioning. (optional)

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

create

void create(java.lang.String org,
            AwsSddcConfig sddcConfig,
            java.lang.Boolean validateOnly,
            AsyncCallback<Task> asyncCallback,
            InvocationConfig invocationConfig)

Provision an SDDC in target cloud

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.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

sddcConfig - sddcConfig (required)

validateOnly - When true, only validates the given sddc configuration without provisioning. (optional)

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

invocationConfig - Configuration for the method invocation.

delete

Task delete(java.lang.String org,
            java.lang.String sddc,
            java.lang.Boolean retainConfiguration,
            java.lang.String templateName,
            java.lang.Boolean force)

Delete SDDC

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

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

retainConfiguration - If = 'true', the SDDC's configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. (optional)

templateName - Only applicable when retainConfiguration is also set to 'true'. When set, this value will be used as the name of the SDDC configuration template generated. (optional)

force - If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted. (optional)

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - The sddc is not in a state that's valid for deletion

Unauthorized - Access not allowed to the operation for the current user

NotFound - Cannot find the SDDC with given identifier

delete

Task delete(java.lang.String org,
            java.lang.String sddc,
            java.lang.Boolean retainConfiguration,
            java.lang.String templateName,
            java.lang.Boolean force,
            InvocationConfig invocationConfig)

Delete SDDC

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:

org - Organization identifier (required)

sddc - Sddc identifier (required)

retainConfiguration - If = 'true', the SDDC's configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. (optional)

templateName - Only applicable when retainConfiguration is also set to 'true'. When set, this value will be used as the name of the SDDC configuration template generated. (optional)

force - If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - The sddc is not in a state that's valid for deletion

Unauthorized - Access not allowed to the operation for the current user

NotFound - Cannot find the SDDC with given identifier

delete

void delete(java.lang.String org,
            java.lang.String sddc,
            java.lang.Boolean retainConfiguration,
            java.lang.String templateName,
            java.lang.Boolean force,
            AsyncCallback<Task> asyncCallback)

Delete SDDC

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

Invocation Result:
com.vmware.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - The sddc is not in a state that's valid for deletion
Unauthorized - Access not allowed to the operation for the current user
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

retainConfiguration - If = 'true', the SDDC's configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. (optional)

templateName - Only applicable when retainConfiguration is also set to 'true'. When set, this value will be used as the name of the SDDC configuration template generated. (optional)

force - If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted. (optional)

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

delete

void delete(java.lang.String org,
            java.lang.String sddc,
            java.lang.Boolean retainConfiguration,
            java.lang.String templateName,
            java.lang.Boolean force,
            AsyncCallback<Task> asyncCallback,
            InvocationConfig invocationConfig)

Delete SDDC

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.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - The sddc is not in a state that's valid for deletion
Unauthorized - Access not allowed to the operation for the current user
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

retainConfiguration - If = 'true', the SDDC's configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. (optional)

templateName - Only applicable when retainConfiguration is also set to 'true'. When set, this value will be used as the name of the SDDC configuration template generated. (optional)

force - If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted. (optional)

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

invocationConfig - Configuration for the method invocation.

get

Sddc get(java.lang.String org,
         java.lang.String sddc)

Get SDDC

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

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

Returns:

com.vmware.vmc.model.Sddc

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

NotFound - Cannot find the SDDC with given identifier

get

Sddc get(java.lang.String org,
         java.lang.String sddc,
         InvocationConfig invocationConfig)

Get SDDC

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:

org - Organization identifier (required)

sddc - Sddc identifier (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.model.Sddc

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

NotFound - Cannot find the SDDC with given identifier

get

void get(java.lang.String org,
         java.lang.String sddc,
         AsyncCallback<Sddc> asyncCallback)

Get SDDC

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

Invocation Result:
com.vmware.vmc.model.Sddc

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

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

get

void get(java.lang.String org,
         java.lang.String sddc,
         AsyncCallback<Sddc> asyncCallback,
         InvocationConfig invocationConfig)

Get SDDC

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.vmc.model.Sddc

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<Sddc> list(java.lang.String org,
                          java.lang.Boolean includeDeleted)

List all the SDDCs of an organization

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

Parameters:

org - Organization identifier (required)

includeDeleted - When true, forces the result to also include deleted SDDCs. (optional)

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

list

java.util.List<Sddc> list(java.lang.String org,
                          java.lang.Boolean includeDeleted,
                          InvocationConfig invocationConfig)

List all the SDDCs of an organization

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:

org - Organization identifier (required)

includeDeleted - When true, forces the result to also include deleted SDDCs. (optional)

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - Unauthorized

Unauthorized - Forbidden

list

void list(java.lang.String org,
          java.lang.Boolean includeDeleted,
          AsyncCallback<java.util.List<Sddc>> asyncCallback)

List all the SDDCs of an organization

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

Operation Errors:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

includeDeleted - When true, forces the result to also include deleted SDDCs. (optional)

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

list

void list(java.lang.String org,
          java.lang.Boolean includeDeleted,
          AsyncCallback<java.util.List<Sddc>> asyncCallback,
          InvocationConfig invocationConfig)

List all the SDDCs of an organization

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:
Unauthenticated - Unauthorized
Unauthorized - Forbidden

Parameters:

org - Organization identifier (required)

includeDeleted - When true, forces the result to also include deleted SDDCs. (optional)

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

invocationConfig - Configuration for the method invocation.

patch

Sddc patch(java.lang.String org,
           java.lang.String sddc,
           SddcPatchRequest sddcPatchRequest)

Patch SDDC

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

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

sddcPatchRequest - Patch request for the SDDC (required)

Returns:

com.vmware.vmc.model.Sddc

Throws:

Unauthenticated - Unauthorized

InvalidRequest - SDDC cannot be patched

Unauthorized - Forbidden

NotFound - Cannot find the SDDC with given identifier

patch

Sddc patch(java.lang.String org,
           java.lang.String sddc,
           SddcPatchRequest sddcPatchRequest,
           InvocationConfig invocationConfig)

Patch SDDC

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:

org - Organization identifier (required)

sddc - Sddc identifier (required)

sddcPatchRequest - Patch request for the SDDC (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.model.Sddc

Throws:

Unauthenticated - Unauthorized

InvalidRequest - SDDC cannot be patched

Unauthorized - Forbidden

NotFound - Cannot find the SDDC with given identifier

patch

void patch(java.lang.String org,
           java.lang.String sddc,
           SddcPatchRequest sddcPatchRequest,
           AsyncCallback<Sddc> asyncCallback)

Patch SDDC

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

Invocation Result:
com.vmware.vmc.model.Sddc

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - SDDC cannot be patched
Unauthorized - Forbidden
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

sddcPatchRequest - Patch request for the SDDC (required)

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

patch

void patch(java.lang.String org,
           java.lang.String sddc,
           SddcPatchRequest sddcPatchRequest,
           AsyncCallback<Sddc> asyncCallback,
           InvocationConfig invocationConfig)

Patch SDDC

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.vmc.model.Sddc

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - SDDC cannot be patched
Unauthorized - Forbidden
NotFound - Cannot find the SDDC with given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

sddcPatchRequest - Patch request for the SDDC (required)

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

invocationConfig - Configuration for the method invocation.