com.vmware.vcenter.vm.guest.filesystem

Class TransfersStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.guest.filesystem.TransfersStub

All Implemented Interfaces:

Service, Transfers, TransfersTypes

public class TransfersStub
extends com.vmware.vapi.internal.bindings.Stub
implements Transfers

Remote stub implementation of the Transfers API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.guest.filesystem.TransfersTypes

TransfersTypes.CreateSpec, TransfersTypes.FileCreationAttributes, TransfersTypes.PosixFileAttributesCreateSpec, TransfersTypes.WindowsFileAttributesCreateSpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.vm.guest.filesystem.TransfersTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.net.URI	create(java.lang.String vm, Credentials credentials, TransfersTypes.CreateSpec spec) Initiates an operation to transfer a file to or from the guest.
void	create(java.lang.String vm, Credentials credentials, TransfersTypes.CreateSpec spec, AsyncCallback<java.net.URI> asyncCallback) Initiates an operation to transfer a file to or from the guest.
void	create(java.lang.String vm, Credentials credentials, TransfersTypes.CreateSpec spec, AsyncCallback<java.net.URI> asyncCallback, InvocationConfig invocationConfig) Initiates an operation to transfer a file to or from the guest.
java.net.URI	create(java.lang.String vm, Credentials credentials, TransfersTypes.CreateSpec spec, InvocationConfig invocationConfig) Initiates an operation to transfer a file to or from the guest.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TransfersStub

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

TransfersStub

public TransfersStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

create

public java.net.URI create(java.lang.String vm,
                           Credentials credentials,
                           TransfersTypes.CreateSpec spec)

Description copied from interface: Transfers

Initiates an operation to transfer a file to or from the guest.

If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted.

When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved.

In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX

. This method was added in vSphere API 7.0.2.0.

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

Specified by:

create in interface Transfers

Parameters:

vm - Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication credentials.

spec - A specification of the type of file transfer and any applicable attibutes.

Returns:

The URL to which the user has to send an HTTP request. The URL will become invalid once a successful request is sent. If the file is being transferred from the guest, an HTTP GET should be used. If the file is being transferred to the guest, HTTP PUT should be used.
The URL is valid only for 10 minutes from the time it is generated. The URL becomes invalid whenever the virtual machine is powered off, suspended, unregistered or migrated to a new host. The host part of the URL is returned as * if the hostname to be used is the name of the server to which the call was made. For example, if the call is made to esx-svr-1.domain1.com, and the file is available for download from https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL returned may be aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0. The client replaces the asterisk with the server name on which it invoked the call.

create

public java.net.URI create(java.lang.String vm,
                           Credentials credentials,
                           TransfersTypes.CreateSpec spec,
                           InvocationConfig invocationConfig)

Description copied from interface: Transfers

Initiates an operation to transfer a file to or from the guest.

If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted.

When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved.

In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX

. This method was added in vSphere API 7.0.2.0.

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:

create in interface Transfers

Parameters:

vm - Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication credentials.

spec - A specification of the type of file transfer and any applicable attibutes.

invocationConfig - Configuration for the method invocation.

Returns:

The URL to which the user has to send an HTTP request. The URL will become invalid once a successful request is sent. If the file is being transferred from the guest, an HTTP GET should be used. If the file is being transferred to the guest, HTTP PUT should be used.
The URL is valid only for 10 minutes from the time it is generated. The URL becomes invalid whenever the virtual machine is powered off, suspended, unregistered or migrated to a new host. The host part of the URL is returned as * if the hostname to be used is the name of the server to which the call was made. For example, if the call is made to esx-svr-1.domain1.com, and the file is available for download from https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL returned may be aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0. The client replaces the asterisk with the server name on which it invoked the call.

create

public void create(java.lang.String vm,
                   Credentials credentials,
                   TransfersTypes.CreateSpec spec,
                   AsyncCallback<java.net.URI> asyncCallback)

Description copied from interface: Transfers

Initiates an operation to transfer a file to or from the guest.

If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted.

When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved.

In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX

. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
The URL to which the user has to send an HTTP request. The URL will become invalid once a successful request is sent. If the file is being transferred from the guest, an HTTP GET should be used. If the file is being transferred to the guest, HTTP PUT should be used.
The URL is valid only for 10 minutes from the time it is generated. The URL becomes invalid whenever the virtual machine is powered off, suspended, unregistered or migrated to a new host. The host part of the URL is returned as * if the hostname to be used is the name of the server to which the call was made. For example, if the call is made to esx-svr-1.domain1.com, and the file is available for download from https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL returned may be aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0. The client replaces the asterisk with the server name on which it invoked the call.

Operation Errors:
AlreadyExists - if TransfersTypes.CreateSpec.getPath() in spec exists and TransfersTypes.FileCreationAttributes.getOverwrite() is false when transferring a file to the guest.
InvalidArgument - if TransfersTypes.CreateSpec.getPath() in spec is not a file. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
InvalidArgument - if TransfersTypes.CreateSpec.getPath() in spec is too long. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
NotAllowedInCurrentState - if the virtual machine is not running.
NotFound - if the virtual machine is not found.
NotFound - if TransfersTypes.CreateSpec.getPath() in spec is not found. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware Tools is not running.
UnableToAllocateResource - if is insuffcient space for the new file when transferring a file to the guest.
Unauthenticated - if the credentials object was not valid.
Unauthorized - if TransfersTypes.CreateSpec.getPath() in spec cannot be accessed.
Unauthorized - if TransfersTypes.CreateSpec.getPath() in spec cannot be copied because the guest authentication will not allow the operation.
Unsupported - if the operation is not supported by the VMware Tools in the guest OS.
Unsupported - if the operation is disabled by the VMware Tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Specified by:

create in interface Transfers

Parameters:

vm - Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication credentials.

spec - A specification of the type of file transfer and any applicable attibutes.

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

create

public void create(java.lang.String vm,
                   Credentials credentials,
                   TransfersTypes.CreateSpec spec,
                   AsyncCallback<java.net.URI> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Transfers

Initiates an operation to transfer a file to or from the guest.

If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted.

When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved.

In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX

. This method was added in vSphere API 7.0.2.0.

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:
The URL to which the user has to send an HTTP request. The URL will become invalid once a successful request is sent. If the file is being transferred from the guest, an HTTP GET should be used. If the file is being transferred to the guest, HTTP PUT should be used.
The URL is valid only for 10 minutes from the time it is generated. The URL becomes invalid whenever the virtual machine is powered off, suspended, unregistered or migrated to a new host. The host part of the URL is returned as * if the hostname to be used is the name of the server to which the call was made. For example, if the call is made to esx-svr-1.domain1.com, and the file is available for download from https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL returned may be aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0. The client replaces the asterisk with the server name on which it invoked the call.

Operation Errors:
AlreadyExists - if TransfersTypes.CreateSpec.getPath() in spec exists and TransfersTypes.FileCreationAttributes.getOverwrite() is false when transferring a file to the guest.
InvalidArgument - if TransfersTypes.CreateSpec.getPath() in spec is not a file. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
InvalidArgument - if TransfersTypes.CreateSpec.getPath() in spec is too long. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
NotAllowedInCurrentState - if the virtual machine is not running.
NotFound - if the virtual machine is not found.
NotFound - if TransfersTypes.CreateSpec.getPath() in spec is not found. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware Tools is not running.
UnableToAllocateResource - if is insuffcient space for the new file when transferring a file to the guest.
Unauthenticated - if the credentials object was not valid.
Unauthorized - if TransfersTypes.CreateSpec.getPath() in spec cannot be accessed.
Unauthorized - if TransfersTypes.CreateSpec.getPath() in spec cannot be copied because the guest authentication will not allow the operation.
Unsupported - if the operation is not supported by the VMware Tools in the guest OS.
Unsupported - if the operation is disabled by the VMware Tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Specified by:

create in interface Transfers

Parameters:

vm - Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication credentials.

spec - A specification of the type of file transfer and any applicable attibutes.

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

invocationConfig - Configuration for the method invocation.