org.opendaylight.yang.gen.v1.http.org.openroadm.file.transfer.rev161014

Interface TransferInput

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<TransferInput>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

public interface TransferInput
extends org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Augmentable<TransferInput>

This class represents the following YANG schema fragment defined in module org-openroadm-file-transfer

 container input {
     leaf action {
         type enumeration;
     }
     leaf local-file-path {
         type string;
     }
     leaf remote-file-path {
         type uri;
     }
 }
 

The schema path to identify an instance is org-openroadm-file-transfer/transfer/input

To create instances of this class use TransferInputBuilder.

See Also:

TransferInputBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TransferInput.Action

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
TransferInput.Action	getAction() Type of action - download/upload.
String	getLocalFilePath() Local file path.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri	getRemoteFilePath() Remote file path.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

getAugmentation

Field Detail

QNAME

static final org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

getAction

TransferInput.Action getAction()

Type of action - download/upload.

Returns:

org.opendaylight.yang.gen.v1.http.org.openroadm.file.transfer.rev161014.TransferInput.Action action, or null if not present

getLocalFilePath

String getLocalFilePath()

Local file path. Ex: /var/shared/example.txt

Returns:

java.lang.String localFilePath, or null if not present

getRemoteFilePath

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getRemoteFilePath()

Remote file path. A URI for the remote file path. Format:sftp://user[:password]@host[:port]/path. Ex: sftp://test:verify@[2001:db8:0:1::10]:22/home/user/sample

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri remoteFilePath, or null if not present