VMware vCloud Suite SDK for .NET 6.0.0
vmware::content::library::item::FileStub Class Reference

Remote stub implementation of the File API service. More...

Inherits vmware::content::library::item::File.

List of all members.

Public Member Functions

 FileStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.content.library.item.FileTypes.Info Get (string libraryItemId, string name)
 Retrieves the information for a single file in a library item by its name.
vmware.content.library.item.FileTypes.Info Get (string libraryItemId, string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves the information for a single file in a library item by its name.
global::System.Threading.Tasks.Task
< vmware.content.library.item.FileTypes.Info
GetAsync (string libraryItemId, string name)
 Retrieves the information for a single file in a library item by its name.
global::System.Threading.Tasks.Task
< vmware.content.library.item.FileTypes.Info
GetAsync (string libraryItemId, string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves the information for a single file in a library item by its name.
global::System.Collections.Generic.List
< vmware.content.library.item.FileTypes.Info
List (string libraryItemId)
 Lists all of the files that are stored within a given library item.
global::System.Collections.Generic.List
< vmware.content.library.item.FileTypes.Info
List (string libraryItemId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Lists all of the files that are stored within a given library item.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.content.library.item.FileTypes.Info > > 
ListAsync (string libraryItemId)
 Lists all of the files that are stored within a given library item.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.content.library.item.FileTypes.Info > > 
ListAsync (string libraryItemId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Lists all of the files that are stored within a given library item.

Detailed Description

Remote stub implementation of the File API service.


Constructor & Destructor Documentation

vmware::content::library::item::FileStub::FileStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

vmware.content.library.item.FileTypes.Info vmware::content::library::item::FileStub::Get ( string  libraryItemId,
string  name 
) [inline]

Retrieves the information for a single file in a library item by its name.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFoundif name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
nameName of the file in the library item whose information should be returned.
Returns:
The File.Info object with information on the specified file.

Implements vmware::content::library::item::File.

vmware.content.library.item.FileTypes.Info vmware::content::library::item::FileStub::Get ( string  libraryItemId,
string  name,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Retrieves the information for a single file in a library item by its name.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFoundif name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
nameName of the file in the library item whose information should be returned.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The File.Info object with information on the specified file.

Implements vmware::content::library::item::File.

global::System.Threading.Tasks.Task<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::FileStub::GetAsync ( string  libraryItemId,
string  name,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Retrieves the information for a single file in a library item by its name.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFoundif name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
nameName of the file in the library item whose information should be returned.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The File.Info object with information on the specified file.

Implements vmware::content::library::item::File.

global::System.Threading.Tasks.Task<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::FileStub::GetAsync ( string  libraryItemId,
string  name 
) [inline]

Retrieves the information for a single file in a library item by its name.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFoundif name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
nameName of the file in the library item whose information should be returned.
Returns:
The File.Info object with information on the specified file.

Implements vmware::content::library::item::File.

global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::FileStub::List ( string  libraryItemId) [inline]

Lists all of the files that are stored within a given library item.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
Returns:
The list of all of the files that are stored within the given library item.

Implements vmware::content::library::item::File.

global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::FileStub::List ( string  libraryItemId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Lists all of the files that are stored within a given library item.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The list of all of the files that are stored within the given library item.

Implements vmware::content::library::item::File.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> > vmware::content::library::item::FileStub::ListAsync ( string  libraryItemId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Lists all of the files that are stored within a given library item.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The list of all of the files that are stored within the given library item.

Implements vmware::content::library::item::File.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> > vmware::content::library::item::FileStub::ListAsync ( string  libraryItemId) [inline]

Lists all of the files that are stored within a given library item.

Exceptions:
vmware.vapi.std.errors.NotFoundif libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .
Parameters:
libraryItemIdIdentifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
Returns:
The list of all of the files that are stored within the given library item.

Implements vmware::content::library::item::File.


The documentation for this class was generated from the following file: