com.vmware.vcenter

Class FolderStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.FolderStub

All Implemented Interfaces:

Service, Folder, FolderTypes

public class FolderStub
extends com.vmware.vapi.internal.bindings.Stub
implements Folder

Remote stub implementation of the Folder API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.FolderTypes

FolderTypes.FilterSpec, FolderTypes.Summary, FolderTypes.Type

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.FolderTypes

RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
FolderStub(ApiProvider apiProvider, StubConfigurationBase config)
FolderStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<FolderTypes.Summary>	list(FolderTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
void	list(FolderTypes.FilterSpec filter, AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
void	list(FolderTypes.FilterSpec filter, AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
java.util.List<FolderTypes.Summary>	list(FolderTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FolderStub

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

FolderStub

public FolderStub(ApiProvider apiProvider,
          StubConfigurationBase config)

Method Detail

list

public java.util.List<FolderTypes.Summary> list(FolderTypes.FilterSpec filter)

Description copied from interface: Folder

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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

Specified by:

list in interface Folder

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

Returns:

Commonly used information about the folders matching the FolderTypes.FilterSpec.

list

public java.util.List<FolderTypes.Summary> list(FolderTypes.FilterSpec filter,
                                       InvocationConfig invocationConfig)

Description copied from interface: Folder

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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:

list in interface Folder

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the folders matching the FolderTypes.FilterSpec.

list

public void list(FolderTypes.FilterSpec filter,
        AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback)

Description copied from interface: Folder

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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

Operation Result:
Commonly used information about the folders matching the FolderTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

list in interface Folder

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

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

list

public void list(FolderTypes.FilterSpec filter,
        AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Folder

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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

Operation Result:
Commonly used information about the folders matching the FolderTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Specified by:

list in interface Folder

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

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

invocationConfig - Configuration for the method invocation.