MagnumServiceImpl (OpenStack4j Core 3.0.5-SNAPSHOT API)

java.lang.Object
- org.openstack4j.openstack.internal.BaseOpenStackService
- - org.openstack4j.openstack.magnum.internal.MagnumServiceImpl

All Implemented Interfaces:

MagnumService, RestService
```
public class MagnumServiceImpl
extends BaseOpenStackService
implements MagnumService
```
OpenStack Container Infrastructure Management service (Magnum) APIs

Author:

Sohan Sangwan

Nested Class Summary
- Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService
  BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors
Constructor and Description

MagnumServiceImpl()

Constructors
Constructor and Description
`MagnumServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bay`	`createBay(Bay bay)` Creates a new bay
`Baymodel`	`createBaymodel(Baymodel baymodel)` Creates a new baymodel
`Cluster`	`createCluster(Cluster cluster)` Create new cluster based on cluster template
`Clustertemplate`	`createClustertemplate(Clustertemplate template)` Create new cluster template
`Container`	`createContainer(Container container)` Creates a new Container
`Pod`	`createPod(Pod pod)` Create a pod
`ActionResponse`	`deleteBay(String id)` Deletes a bay
`ActionResponse`	`deleteBaymodel(String id)` Deletes a baymodel
`ActionResponse`	`deleteCluster(String id)` Delete a cluster.
`ActionResponse`	`deleteClustertemplate(String id)` Delete a cluster template
`ActionResponse`	`deleteContainer(String uuid)` Deletes a Container
`ActionResponse`	`deletePod(String bayUuid, String id)` Delete a pod
`String`	`execCmdInContainer(String id, String cmd)` Execute command in a Container
`Certificate`	`getCertificate(String uuid)` Gets certificate
`String`	`getContainerLogs(String id)` Get logs of a Container
`List<? extends Baymodel>`	`listBaymodels()` Lists all Baymodels
`List<? extends Bay>`	`listBays()` Lists all Bays/clusters
`List<? extends Cluster>`	`listClusters()` List all clusters
`List<? extends Clustertemplate>`	`listClustertemplate()` List all cluster templates
`List<? extends Container>`	`listContainers()` Lists all Containers
`List<? extends Mservice>`	`listMservices()` Lists Magnum Services
`List<? extends Pod>`	`listPods(String bayUuid)` List all pods
`Container`	`pauseContainer(String id)` Pause a Container
`Container`	`rebootContainer(String id)` Reboot a Container
`ActionResponse`	`rotateCertificate(String uuid)` Rotate the CA certificate for a bay/cluster and invalidate all user certificates.
`Bay`	`showBay(String id)` Show a bay
`Baymodel`	`showBaymodel(String id)` Gets all information of a baymodel
`Cluster`	`showCluster(String id)` Get all information of a cluster in Magnum
`Container`	`showContainer(String id)` Show a Container
`Pod`	`showPod(String bayUuid, String id)` Show a pod
`Certificate`	`signCertificate(Carequest ca)` Generates certificate
`Container`	`startContainer(String id)` Start a Container
`Container`	`stopContainer(String id)` Stop a Container
`Container`	`unpauseContainer(String id)` Unpause a Container
`Bay`	`updateBay(String id, String operations)` Update bay
`Baymodel`	`updateBaymodel(String id, String operations)` Updates baymodel attributes
`Cluster`	`updateCluster(String id, String operations)` Update information of one cluster attributes using operations including: ``add``, ``replace`` or ``remove``.
`Clustertemplate`	`updateClustertemplate(String id, String operations)` Update information of one cluster template attributes using operations including: ``add``, ``replace`` or ``remove``.
`Container`	`updateContainer(String id, String operations)` Update a container
`Pod`	`updatePod(String bayUuid, String id, String operations)` Update a pod

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService
delete, deleteWithResponse, get, getProvider, getServiceVersion, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, request, toList, uri

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MagnumServiceImpl
```
public MagnumServiceImpl()
```
- Method Detail
  - listMservices
```
public List<? extends Mservice> listMservices()
```
    Lists Magnum Services
    
    Specified by:
    
    listMservices in interface MagnumService
    
    Returns:
    
    list of Magnum Services
  - listBaymodels
```
public List<? extends Baymodel> listBaymodels()
```
    Description copied from interface: MagnumService
    
    Lists all Baymodels
    
    Specified by:
    
    listBaymodels in interface MagnumService
    
    Returns:
    
    list of Baymodels
  - createBaymodel
```
public Baymodel createBaymodel(Baymodel baymodel)
```
    Description copied from interface: MagnumService
    
    Creates a new baymodel
    
    Specified by:
    
    createBaymodel in interface MagnumService
    
    Returns:
  - deleteBaymodel
```
public ActionResponse deleteBaymodel(String id)
```
    Description copied from interface: MagnumService
    
    Deletes a baymodel
    
    Specified by:
    
    deleteBaymodel in interface MagnumService
    
    Returns:
  - showBaymodel
```
public Baymodel showBaymodel(String id)
```
    Description copied from interface: MagnumService
    
    Gets all information of a baymodel
    
    Specified by:
    
    showBaymodel in interface MagnumService
    
    Returns:
    
    baymodel information
  - updateBaymodel
```
public Baymodel updateBaymodel(String id,
                               String operations)
```
    Description copied from interface: MagnumService
    
    Updates baymodel attributes
    
    Specified by:
    
    updateBaymodel in interface MagnumService
    
    Returns:
    
    updated baymodel
  - listBays
```
public List<? extends Bay> listBays()
```
    Description copied from interface: MagnumService
    
    Lists all Bays/clusters
    
    Specified by:
    
    listBays in interface MagnumService
    
    Returns:
    
    list of Bays
  - createBay
```
public Bay createBay(Bay bay)
```
    Description copied from interface: MagnumService
    
    Creates a new bay
    
    Specified by:
    
    createBay in interface MagnumService
    
    Returns:
    
    newly created bay
  - deleteBay
```
public ActionResponse deleteBay(String id)
```
    Description copied from interface: MagnumService
    
    Deletes a bay
    
    Specified by:
    
    deleteBay in interface MagnumService
    
    Returns:
  - showBay
```
public Bay showBay(String id)
```
    Description copied from interface: MagnumService
    
    Show a bay
    
    Specified by:
    
    showBay in interface MagnumService
    
    Returns:
    
    bay
  - updateBay
```
public Bay updateBay(String id,
                     String operations)
```
    Description copied from interface: MagnumService
    
    Update bay
    
    Specified by:
    
    updateBay in interface MagnumService
    
    Returns:
  - listContainers
```
public List<? extends Container> listContainers()
```
    Description copied from interface: MagnumService
    
    Lists all Containers
    
    Specified by:
    
    listContainers in interface MagnumService
    
    Returns:
    
    list of Containers
  - createContainer
```
public Container createContainer(Container container)
```
    Description copied from interface: MagnumService
    
    Creates a new Container
    
    Specified by:
    
    createContainer in interface MagnumService
    
    Returns:
    
    newly created Container
  - deleteContainer
```
public ActionResponse deleteContainer(String uuid)
```
    Description copied from interface: MagnumService
    
    Deletes a Container
    
    Specified by:
    
    deleteContainer in interface MagnumService
    
    Returns:
    
    success/failure response
  - execCmdInContainer
```
public String execCmdInContainer(String id,
                                 String cmd)
```
    Description copied from interface: MagnumService
    
    Execute command in a Container
    
    Specified by:
    
    execCmdInContainer in interface MagnumService
    
    Returns:
    
    output of the command
  - getContainerLogs
```
public String getContainerLogs(String id)
```
    Description copied from interface: MagnumService
    
    Get logs of a Container
    
    Specified by:
    
    getContainerLogs in interface MagnumService
    
    Returns:
    
    logs
  - pauseContainer
```
public Container pauseContainer(String id)
```
    Description copied from interface: MagnumService
    
    Pause a Container
    
    Specified by:
    
    pauseContainer in interface MagnumService
    
    Returns:
    
    paused Container
  - unpauseContainer
```
public Container unpauseContainer(String id)
```
    Description copied from interface: MagnumService
    
    Unpause a Container
    
    Specified by:
    
    unpauseContainer in interface MagnumService
    
    Returns:
    
    paused Container
  - rebootContainer
```
public Container rebootContainer(String id)
```
    Description copied from interface: MagnumService
    
    Reboot a Container
    
    Specified by:
    
    rebootContainer in interface MagnumService
    
    Returns:
    
    rebooted Container
  - startContainer
```
public Container startContainer(String id)
```
    Description copied from interface: MagnumService
    
    Start a Container
    
    Specified by:
    
    startContainer in interface MagnumService
    
    Returns:
    
    Container
  - stopContainer
```
public Container stopContainer(String id)
```
    Description copied from interface: MagnumService
    
    Stop a Container
    
    Specified by:
    
    stopContainer in interface MagnumService
    
    Returns:
    
    Container
  - showContainer
```
public Container showContainer(String id)
```
    Description copied from interface: MagnumService
    
    Show a Container
    
    Specified by:
    
    showContainer in interface MagnumService
    
    Returns:
    
    Container
  - updateContainer
```
public Container updateContainer(String id,
                                 String operations)
```
    Description copied from interface: MagnumService
    
    Update a container
    
    Specified by:
    
    updateContainer in interface MagnumService
    
    Returns:
  - getCertificate
```
public Certificate getCertificate(String uuid)
```
    Description copied from interface: MagnumService
    
    Gets certificate
    
    Specified by:
    
    getCertificate in interface MagnumService
    
    Parameters:
    
    uuid - of a bay or cluster
    
    Returns:
    
    certificate
  - signCertificate
```
public Certificate signCertificate(Carequest ca)
```
    Description copied from interface: MagnumService
    
    Generates certificate
    
    Specified by:
    
    signCertificate in interface MagnumService
    
    Parameters:
    
    ca - request
    
    Returns:
    
    certificate
  - rotateCertificate
```
public ActionResponse rotateCertificate(String uuid)
```
    Description copied from interface: MagnumService
    
    Rotate the CA certificate for a bay/cluster and invalidate all user certificates.
    
    Specified by:
    
    rotateCertificate in interface MagnumService
    
    Parameters:
    
    uuid - of a bay or cluster
    
    Returns:
    
    status
  - createCluster
```
public Cluster createCluster(Cluster cluster)
```
    Description copied from interface: MagnumService
    
    Create new cluster based on cluster template
    
    Specified by:
    
    createCluster in interface MagnumService
    
    Returns:
  - listClusters
```
public List<? extends Cluster> listClusters()
```
    Description copied from interface: MagnumService
    
    List all clusters
    
    Specified by:
    
    listClusters in interface MagnumService
    
    Returns:
  - showCluster
```
public Cluster showCluster(String id)
```
    Description copied from interface: MagnumService
    
    Get all information of a cluster in Magnum
    
    Specified by:
    
    showCluster in interface MagnumService
    
    Parameters:
    
    id - of the cluster
    
    Returns:
    
    cluster
  - deleteCluster
```
public ActionResponse deleteCluster(String id)
```
    Description copied from interface: MagnumService
    
    Delete a cluster.
    
    Specified by:
    
    deleteCluster in interface MagnumService
    
    Parameters:
    
    id - of the cluster
    
    Returns:
    
    success status
  - updateCluster
```
public Cluster updateCluster(String id,
                             String operations)
```
    Description copied from interface: MagnumService
    
    Update information of one cluster attributes using operations including: ``add``, ``replace`` or ``remove``. The attributes to ``add`` and ``replace`` in the form of ``key=value`` while ``remove`` only needs the keys.
    
    Specified by:
    
    updateCluster in interface MagnumService
    
    Returns:
    
    updated cluster
  - createClustertemplate
```
public Clustertemplate createClustertemplate(Clustertemplate template)
```
    Description copied from interface: MagnumService
    
    Create new cluster template
    
    Specified by:
    
    createClustertemplate in interface MagnumService
    
    Returns:
    
    newly created cluster template
  - listClustertemplate
```
public List<? extends Clustertemplate> listClustertemplate()
```
    Description copied from interface: MagnumService
    
    List all cluster templates
    
    Specified by:
    
    listClustertemplate in interface MagnumService
    
    Returns:
    
    list of cluster templates
  - deleteClustertemplate
```
public ActionResponse deleteClustertemplate(String id)
```
    Description copied from interface: MagnumService
    
    Delete a cluster template
    
    Specified by:
    
    deleteClustertemplate in interface MagnumService
    
    Parameters:
    
    id - of the clustertemplate
    
    Returns:
    
    status
  - updateClustertemplate
```
public Clustertemplate updateClustertemplate(String id,
                                             String operations)
```
    Description copied from interface: MagnumService
    
    Update information of one cluster template attributes using operations including: ``add``, ``replace`` or ``remove``. The attributes to ``add`` and ``replace`` in the form of ``key=value`` while ``remove`` only needs the keys.
    
    Specified by:
    
    updateClustertemplate in interface MagnumService
    
    Returns:
    
    updated clustser template
  - listPods
```
public List<? extends Pod> listPods(String bayUuid)
```
    Description copied from interface: MagnumService
    
    List all pods
    
    Specified by:
    
    listPods in interface MagnumService
    
    Returns:
    
    list of pods
  - createPod
```
public Pod createPod(Pod pod)
```
    Description copied from interface: MagnumService
    
    Create a pod
    
    Specified by:
    
    createPod in interface MagnumService
    
    Returns:
    
    pod
  - deletePod
```
public ActionResponse deletePod(String bayUuid,
                                String id)
```
    Description copied from interface: MagnumService
    
    Delete a pod
    
    Specified by:
    
    deletePod in interface MagnumService
    
    Returns:
    
    status
  - showPod
```
public Pod showPod(String bayUuid,
                   String id)
```
    Description copied from interface: MagnumService
    
    Show a pod
    
    Specified by:
    
    showPod in interface MagnumService
    
    Returns:
    
    pod
  - updatePod
```
public Pod updatePod(String bayUuid,
                     String id,
                     String operations)
```
    Description copied from interface: MagnumService
    
    Update a pod
    
    Specified by:
    
    updatePod in interface MagnumService
    
    Returns:
    
    pod

Class MagnumServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

Constructor Summary

Method Summary

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

Methods inherited from class java.lang.Object

Constructor Detail

MagnumServiceImpl

Method Detail

listMservices

listBaymodels

createBaymodel

deleteBaymodel

showBaymodel

updateBaymodel

listBays

createBay

deleteBay

showBay

updateBay

listContainers

createContainer

deleteContainer

execCmdInContainer

getContainerLogs

pauseContainer

unpauseContainer

rebootContainer

startContainer

stopContainer

showContainer

updateContainer

getCertificate

signCertificate

rotateCertificate

createCluster

listClusters

showCluster

deleteCluster

updateCluster

createClustertemplate

listClustertemplate

deleteClustertemplate

updateClustertemplate

listPods

createPod

deletePod

showPod

updatePod