C D E F G H I N P R S T V W

C

Capabilities - Class in co.cask.cdap.runtime.spi.provisioner

A class to encapsulate all the different capabilities of a Provisioner

Capabilities(Set<String>) - Constructor for class co.cask.cdap.runtime.spi.provisioner.Capabilities

Creates a Capabilities object from the given Set.

close() - Method in interface co.cask.cdap.runtime.spi.ssh.PortForwarding

close() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Close this SSH session.

Cluster - Class in co.cask.cdap.runtime.spi.provisioner

Information about a cluster.

Cluster(String, ClusterStatus, Collection<Node>, Map<String, String>) - Constructor for class co.cask.cdap.runtime.spi.provisioner.Cluster

Cluster(Cluster, ClusterStatus) - Constructor for class co.cask.cdap.runtime.spi.provisioner.Cluster

ClusterStatus - Enum in co.cask.cdap.runtime.spi.provisioner

Status for clusters.

co.cask.cdap.runtime.spi - package co.cask.cdap.runtime.spi

co.cask.cdap.runtime.spi.profile - package co.cask.cdap.runtime.spi.profile

co.cask.cdap.runtime.spi.provisioner - package co.cask.cdap.runtime.spi.provisioner

co.cask.cdap.runtime.spi.ssh - package co.cask.cdap.runtime.spi.ssh

copy(Path, String) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Copies a local file to the given target path

copy(InputStream, String, String, long, int, Long, Long) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Copies content to remote host.

createCluster(ProvisionerContext) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Request to create a cluster.

createLocalPortForward(String, int, int, PortForwarding.DataConsumer) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Creates a local port forwarding channel from this SSH session.

createSSHSession(String) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Creates a SSHSession to the given host.

createSSHSession(SSHKeyPair, String) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Creates a SSHSession to the given host.

createSSHSession(String, Supplier<byte[]>, String, int, Map<String, String>) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Creates a SSHSession to the given host, on a specific port, and with extra sets of ssh configurations.

D

DataConsumer() - Constructor for class co.cask.cdap.runtime.spi.ssh.PortForwarding.DataConsumer

deleteCluster(ProvisionerContext, Cluster) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Request to delete a cluster.

destroy() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Attempts to stop the remote process by closing ssh channel.

E

EMPTY - Static variable in class co.cask.cdap.runtime.spi.provisioner.Capabilities

equals(Object) - Method in class co.cask.cdap.runtime.spi.provisioner.Capabilities

equals(Object) - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

equals(Object) - Method in class co.cask.cdap.runtime.spi.provisioner.Node

equals(Object) - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

equals(Object) - Method in class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

execute(String...) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Executes a sequence of commands on the remote host.

execute(List<String>) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Executes a sequence of commands on the remote host.

executeAndWait(String...) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Executes a sequence of commands on the remote host and block until execution completed.

executeAndWait(List<String>) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Executes a sequence of commands on the remote host and block until execution completed.

exitValue() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Returns the exit code of the remote process if it was completed.

F

finished() - Method in class co.cask.cdap.runtime.spi.ssh.PortForwarding.DataConsumer

Invoked when the channel is closed and no more data will be received.

fixedInterval(long, TimeUnit) - Static method in class co.cask.cdap.runtime.spi.provisioner.PollingStrategies

Return a PollingStrategy that polls at a fixed interval.

flush() - Method in interface co.cask.cdap.runtime.spi.ssh.PortForwarding

flushed() - Method in class co.cask.cdap.runtime.spi.ssh.PortForwarding.DataConsumer

Invoked when there is a flush event received from the channel.

G

generate(String) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Generates a 2048 bits RSA secure key pair for SSH operations.

generate(String, int) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Generates a RSA secure key pair for SSH operations.

getAddress() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Returns the remote host and port that this session is connected to.

getApplication() - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

getCapabilities() - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Returns Capabilities of this provisioner.

getCDAPVersion() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerContext

getCDAPVersion() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerSystemContext

Returns the CDAP version

getClusterDetail(ProvisionerContext, Cluster) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Get details about the cluster.

getClusterStatus(ProvisionerContext, Cluster) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Get the status of the cluster.

getCompat() - Method in enum co.cask.cdap.runtime.spi.SparkCompat

getCreateTime() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

getDatasetTypes() - Method in class co.cask.cdap.runtime.spi.provisioner.Capabilities

getDescription() - Method in class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

getErrorStream() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Returns an InputStream for reading from the remote process stderr.

getId() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

getInputStream() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Returns an InputStream for reading from the remote process stdout.

getIpAddress() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

getKey() - Method in class co.cask.cdap.runtime.spi.ssh.SSHPublicKey

Returns the public key in SSH public key format described in RFC-4253.

getLabel() - Method in class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

getName() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

getName() - Method in class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

getNamespace() - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

getNodes() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

getOutputStream() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Returns an OutputStream for writing to the remote process stdin.

getPollingStrategy(ProvisionerContext, Cluster) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Get the PollingStrategy to use when polling for cluster creation or deletion.

getPrivateKeySupplier() - Method in class co.cask.cdap.runtime.spi.ssh.SSHKeyPair

Returns a Supplier that will supply the private key for SSH.

getProgram() - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

getProgramRun() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerContext

getProperties() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

getProperties() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

getProperties() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerContext

Get the provisioner properties for this program run.

getProperties() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerSystemContext

System properties are derived from the CDAP configuration.

getPublicKey() - Method in class co.cask.cdap.runtime.spi.ssh.SSHKeyPair

Returns a SSHPublicKey that contains the user and public key for SSH.

getRun() - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

getSparkCompat() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerContext

Returns a SparkCompat object that represents the Spark version being used in CDAP.

getSpec() - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Return the specification for the provisioner.

getSSHContext() - Method in interface co.cask.cdap.runtime.spi.provisioner.ProvisionerContext

Returns the SSHContext for performing ssh operations.

getSSHKeyPair() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Returns the SSHKeyPair that were set earlier via the SSHContext.setSSHKeyPair(SSHKeyPair) method during the Provisioner.createCluster(ProvisionerContext) time.

getStatus() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

getType() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

getUser() - Method in class co.cask.cdap.runtime.spi.ssh.SSHPublicKey

Returns the user name associated with the key.

getUsername() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Returns the remote user name that this session used to connect to the remote host.

H

hashCode() - Method in class co.cask.cdap.runtime.spi.provisioner.Capabilities

hashCode() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

hashCode() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

hashCode() - Method in class co.cask.cdap.runtime.spi.provisioner.ProgramRun

hashCode() - Method in class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

I

initialDelay(PollingStrategy, long, TimeUnit) - Static method in class co.cask.cdap.runtime.spi.provisioner.PollingStrategies

A PollingStrategy that will wait for a specified amount of time before performing the first poll.

initialDelay(PollingStrategy, long, long, TimeUnit) - Static method in class co.cask.cdap.runtime.spi.provisioner.PollingStrategies

A PollingStrategy that will wait for a specified base amount of time plus some random jitter time before performing the first poll.

initialize(ProvisionerSystemContext) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Initialize the provisioner.

initializeCluster(ProvisionerContext, Cluster) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Responsible for any additional initialization steps for the cluster.

isAlive() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHSession

Returns true if the session is alive; otherwise return false.

isEmpty() - Method in class co.cask.cdap.runtime.spi.provisioner.Capabilities

isOpen() - Method in interface co.cask.cdap.runtime.spi.ssh.PortForwarding

N

nextPoll(int, long) - Method in interface co.cask.cdap.runtime.spi.provisioner.PollingStrategy

Return the number of milliseconds to wait before the next poll, given the time that polling began, and the number of polls already attempted.

Node - Class in co.cask.cdap.runtime.spi.provisioner

Information about a cluster node.

Node(String, Node.Type, String, long, Map<String, String>) - Constructor for class co.cask.cdap.runtime.spi.provisioner.Node

Node.Type - Enum in co.cask.cdap.runtime.spi.provisioner

Node type.

P

PollingStrategies - Class in co.cask.cdap.runtime.spi.provisioner

Some common PollingStrategies

PollingStrategies() - Constructor for class co.cask.cdap.runtime.spi.provisioner.PollingStrategies

PollingStrategy - Interface in co.cask.cdap.runtime.spi.provisioner

Defines how CDAP should poll for cluster status while waiting for a cluster to change state.

PortForwarding - Interface in co.cask.cdap.runtime.spi.ssh

Represents a SSH port forwarding channel.

PortForwarding.DataConsumer - Class in co.cask.cdap.runtime.spi.ssh

This class is for consuming incoming data from the SSH port forwarding channel.

ProfileStatus - Enum in co.cask.cdap.runtime.spi.profile

The status of the profile.

ProgramRun - Class in co.cask.cdap.runtime.spi.provisioner

A program run.

ProgramRun(String, String, String, String) - Constructor for class co.cask.cdap.runtime.spi.provisioner.ProgramRun

Provisioner - Interface in co.cask.cdap.runtime.spi.provisioner

A Provisioner is responsible for creating and deleting clusters for program runs.

ProvisionerContext - Interface in co.cask.cdap.runtime.spi.provisioner

Context for provisioner operations.

ProvisionerSpecification - Class in co.cask.cdap.runtime.spi.provisioner

Specification of a Provisioner.

ProvisionerSpecification(String, String, String) - Constructor for class co.cask.cdap.runtime.spi.provisioner.ProvisionerSpecification

ProvisionerSystemContext - Interface in co.cask.cdap.runtime.spi.provisioner

Context for system level provisioner information.

R

received(ByteBuffer) - Method in class co.cask.cdap.runtime.spi.ssh.PortForwarding.DataConsumer

Invoked when new data is received.

RetryableProvisionException - Exception in co.cask.cdap.runtime.spi.provisioner

An provision exception that indicates a failure that may succeed after a retry.

RetryableProvisionException(String) - Constructor for exception co.cask.cdap.runtime.spi.provisioner.RetryableProvisionException

RetryableProvisionException(Throwable) - Constructor for exception co.cask.cdap.runtime.spi.provisioner.RetryableProvisionException

RetryableProvisionException(String, Throwable) - Constructor for exception co.cask.cdap.runtime.spi.provisioner.RetryableProvisionException

S

setSSHKeyPair(SSHKeyPair) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHContext

Sets the SSH key pair for the platform to communicate with the cluster in future.

SparkCompat - Enum in co.cask.cdap.runtime.spi

Spark compat versions.

SSHContext - Interface in co.cask.cdap.runtime.spi.ssh

This context provides ssh keys and access to SSHSession for interacting with remote hosts.

SSHKeyPair - Class in co.cask.cdap.runtime.spi.ssh

Represents a public-private key pair for SSH authentication.

SSHKeyPair(SSHPublicKey, Supplier<byte[]>) - Constructor for class co.cask.cdap.runtime.spi.ssh.SSHKeyPair

SSHProcess - Interface in co.cask.cdap.runtime.spi.ssh

Represents a process launched via the SSHSession.execute(String...) method.

SSHPublicKey - Class in co.cask.cdap.runtime.spi.ssh

Contains information of a public key.

SSHPublicKey(String, String) - Constructor for class co.cask.cdap.runtime.spi.ssh.SSHPublicKey

SSHSession - Interface in co.cask.cdap.runtime.spi.ssh

This interface represents an SSH session, which allow performing remote ssh commands and scp.

T

toString() - Method in class co.cask.cdap.runtime.spi.provisioner.Capabilities

toString() - Method in class co.cask.cdap.runtime.spi.provisioner.Cluster

toString() - Method in class co.cask.cdap.runtime.spi.provisioner.Node

V

validateProperties(Map<String, String>) - Method in interface co.cask.cdap.runtime.spi.provisioner.Provisioner

Check that the specified properties are valid.

valueOf(String) - Static method in enum co.cask.cdap.runtime.spi.profile.ProfileStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum co.cask.cdap.runtime.spi.provisioner.ClusterStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum co.cask.cdap.runtime.spi.provisioner.Node.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum co.cask.cdap.runtime.spi.SparkCompat

Returns the enum constant of this type with the specified name.

values() - Static method in enum co.cask.cdap.runtime.spi.profile.ProfileStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum co.cask.cdap.runtime.spi.provisioner.ClusterStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum co.cask.cdap.runtime.spi.provisioner.Node.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum co.cask.cdap.runtime.spi.SparkCompat

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitFor() - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Blocks for the remote process to finish.

waitFor(long, TimeUnit) - Method in interface co.cask.cdap.runtime.spi.ssh.SSHProcess

Blocks for the remote process to finish.

write(ByteBuffer) - Method in interface co.cask.cdap.runtime.spi.ssh.PortForwarding

C D E F G H I N P R S T V W