org.springframework.yarn.boot.actuate.endpoint.mvc

Class YarnContainerClusterMvcEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.AbstractEndpointMvcAdapter<org.springframework.boot.actuate.endpoint.Endpoint<?>>

org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter

org.springframework.yarn.boot.actuate.endpoint.mvc.YarnContainerClusterMvcEndpoint

All Implemented Interfaces:

org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

public class YarnContainerClusterMvcEndpoint
extends org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter

A custom MvcEndpoint adding specific rest API used to control YarnContainerClusterEndpoint.

Author:

Janne Valkealahti

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
YarnContainerClusterMvcEndpoint(YarnContainerClusterEndpoint delegate) Instantiates a new yarn container cluster mvc endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.HttpEntity<ContainerClusterResource>	clusterInfo(java.lang.String clusterId) Gets a status of a specific container cluster.
org.springframework.http.HttpEntity<java.lang.Void>	createCluster(ContainerClusterCreateRequest request) Creates a new container cluster.
org.springframework.http.ResponseEntity<java.lang.Void>	destroyCluster(java.lang.String clusterId)
java.lang.Object	invoke() Main EndpointMvcAdapter.invoke() which returns information about existing container clusters.
org.springframework.http.HttpEntity<java.lang.Void>	modifyCluster(java.lang.String clusterId, ContainerClusterModifyRequest request) Modifies a container cluster state.
org.springframework.http.HttpEntity<java.lang.Void>	updateCluster(java.lang.String clusterId, ContainerClusterCreateRequest request) Modify a container cluster

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractEndpointMvcAdapter

getDelegate, getDisabledResponse, getEndpointType, getPath, isSensitive, setPath

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnContainerClusterMvcEndpoint

public YarnContainerClusterMvcEndpoint(YarnContainerClusterEndpoint delegate)

Instantiates a new yarn container cluster mvc endpoint.

Parameters:

delegate - the delegate YarnContainerClusterEndpoint

Method Detail

invoke

@RequestMapping(method=GET)
@ResponseBody
public java.lang.Object invoke()

Main EndpointMvcAdapter.invoke() which returns information about existing container clusters.

Overrides:

invoke in class org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter

createCluster

@RequestMapping(method=POST)
public org.springframework.http.HttpEntity<java.lang.Void> createCluster(@RequestBody
                                                                               ContainerClusterCreateRequest request)

Creates a new container cluster.

Parameters:

request - the container cluster create request

Returns:

the container cluster create response

clusterInfo

@RequestMapping(value="/{clusterId:.*}",
                method=GET)
public org.springframework.http.HttpEntity<ContainerClusterResource> clusterInfo(@PathVariable(value="clusterId")
                                                                                       java.lang.String clusterId)

Gets a status of a specific container cluster.

Parameters:

clusterId - the container cluster identifier

Returns:

the container cluster status response

modifyCluster

@RequestMapping(value="/{clusterId:.*}",
                method=PUT)
public org.springframework.http.HttpEntity<java.lang.Void> modifyCluster(@PathVariable(value="clusterId")
                                                                               java.lang.String clusterId,
                                                                               @RequestBody
                                                                               ContainerClusterModifyRequest request)

Modifies a container cluster state.

Parameters:

clusterId - the container cluster identifier

request - Binding for modify request content

Returns:

the container cluster status response

destroyCluster

@RequestMapping(value="/{clusterId:.*}",
                method=DELETE)
public org.springframework.http.ResponseEntity<java.lang.Void> destroyCluster(@PathVariable(value="clusterId")
                                                                                    java.lang.String clusterId)

updateCluster

@RequestMapping(value="/{clusterId:.*}",
                method=PATCH)
public org.springframework.http.HttpEntity<java.lang.Void> updateCluster(@PathVariable(value="clusterId")
                                                                               java.lang.String clusterId,
                                                                               @RequestBody
                                                                               ContainerClusterCreateRequest request)

Modify a container cluster

Parameters:

clusterId - the container cluster identifier

request - the request

Returns:

the container cluster modify response