org.springframework.yarn.boot.app

Interface YarnContainerClusterOperations

All Known Implementing Classes:

YarnContainerClusterTemplate

public interface YarnContainerClusterOperations

An operations interface for YarnContainerClusterTemplate.

Author:

Janne Valkealahti

Method Summary

Methods

Modifier and Type	Method and Description
ContainerClusterResource	clusterCreate(ContainerClusterCreateRequest request) Create a container cluster.
void	clusterDestroy(java.lang.String clusterId) Destroy a container cluster.
ContainerClusterResource	clusterInfo(java.lang.String clusterId) Get a container cluster info.
ContainerClusterResource	clusterModify(java.lang.String clusterId, ContainerClusterCreateRequest request) Modify a container cluster.
ContainerClusterResource	clusterStart(java.lang.String clusterId, ContainerClusterModifyRequest request) Start a container cluster.
ContainerClusterResource	clusterStop(java.lang.String clusterId, ContainerClusterModifyRequest request) Stop a container cluster.
YarnContainerClusterEndpointResource	getClusters() Get a clusters info.

Method Detail

getClusters

YarnContainerClusterEndpointResource getClusters()
                                                 throws YarnContainerClusterClientException

Get a clusters info.

Returns:

the YarnContainerClusterEndpointResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterCreate

ContainerClusterResource clusterCreate(ContainerClusterCreateRequest request)
                                       throws YarnContainerClusterClientException

Create a container cluster.

Parameters:

request - the create request

Returns:

the ContainerClusterResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterInfo

ContainerClusterResource clusterInfo(java.lang.String clusterId)
                                     throws YarnContainerClusterClientException

Get a container cluster info.

Parameters:

clusterId - the cluster identifier

Returns:

the ContainerClusterResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterStart

ContainerClusterResource clusterStart(java.lang.String clusterId,
                                    ContainerClusterModifyRequest request)
                                      throws YarnContainerClusterClientException

Start a container cluster.

Parameters:

clusterId - the cluster identifier

request - the modify request.

Returns:

the ContainerClusterResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterStop

ContainerClusterResource clusterStop(java.lang.String clusterId,
                                   ContainerClusterModifyRequest request)
                                     throws YarnContainerClusterClientException

Stop a container cluster.

Parameters:

clusterId - the cluster identifier

request - the modify request.

Returns:

the ContainerClusterResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterModify

ContainerClusterResource clusterModify(java.lang.String clusterId,
                                     ContainerClusterCreateRequest request)
                                       throws YarnContainerClusterClientException

Modify a container cluster.

Parameters:

clusterId - the cluster identifier

request - the create request.

Returns:

the ContainerClusterResource

Throws:

YarnContainerClusterClientException - if client experienced an error

clusterDestroy

void clusterDestroy(java.lang.String clusterId)
                    throws YarnContainerClusterClientException

Destroy a container cluster.

Parameters:

clusterId - the cluster identifier

Throws:

YarnContainerClusterClientException - if client experienced an error