Package com.oracle.cloud.baremetal.jenkins.client

Class SDKBaremetalCloudClient

java.lang.Object

com.oracle.cloud.baremetal.jenkins.client.SDKBaremetalCloudClient

All Implemented Interfaces:

BaremetalCloudClient, AutoCloseable

public class SDKBaremetalCloudClient
extends Object
implements BaremetalCloudClient

An implementation of ComputeCloudClient using the JAX-RS client API.

Constructor Summary

Constructors

Constructor	Description
SDKBaremetalCloudClient(com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider instancePrincipalsProvider, String regionId, int maxAsyncThreads, String instancePrincipalsTenantId)
SDKBaremetalCloudClient(com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider provider, String regionId, int maxAsyncThreads)

Method Summary

Modifier and Type	Method	Description
void	authenticate()
void	close()
com.oracle.bmc.core.model.Instance	createInstance(String name, BaremetalCloudAgentTemplate template)	Creates an instance with the specified template
List<com.oracle.bmc.identity.model.AvailabilityDomain>	getAvailabilityDomainsList(String compartmentId)	Get the available domain response
List<com.oracle.bmc.identity.model.Compartment>	getCompartmentsList()	Get the compartment list
List<com.oracle.bmc.core.model.Image>	getImagesList(String compartmentId)	Get the available image list
String	getInstanceIp(BaremetalCloudAgentTemplate template, String instanceId)	Get an instance public or private ip with the specified instance id
com.oracle.bmc.core.model.Instance.LifecycleState	getInstanceState(String instanceId)	Check instance's state
Integer[]	getMinMaxMemory(String compartmentId, String availableDomain, String imageId, String shape)	Get the memory options of Flex shapes
Integer[]	getMinMaxOcpus(String compartmentId, String availableDomain, String imageId, String shape)	Get the OCPUs options
List<com.oracle.bmc.core.model.NetworkSecurityGroup>	getNsgIdsList(String compartmentId)	Get the network security group list
List<com.oracle.bmc.core.model.Shape>	getShapesList(String compartmentId, String availableDomain, String imageId)	Get the shape list
List<com.oracle.bmc.core.model.Instance>	getStoppedInstances(String compartmentId, String availableDomain)	Get a list of stopped instances on OCI
com.oracle.bmc.core.responses.GetSubnetResponse	getSubNet(String subnetId)	Get the sub net
List<com.oracle.bmc.core.model.Subnet>	getSubNetList(String compartmentId, String vcnId)	Get the sub net list
List<com.oracle.bmc.identity.model.TagNamespaceSummary>	getTagNamespaces(String compartmentId)	Start instance with the specified instance id
com.oracle.bmc.identity.model.Tenancy	getTenant()	Get root compartment
List<com.oracle.bmc.core.model.Vcn>	getVcnList(String compartmentId)	Get the Virtual Cloud Network list
com.oracle.bmc.core.model.Instance	startInstance(String instanceId)	Start instance with the specified instance id
String	stopInstance(String instanceId)	Stop instance with the specified instance id
String	terminateInstance(String instanceId)	Terminate instance with the specified instance id
com.oracle.bmc.core.model.Instance	waitForInstanceProvisioningToComplete(String instanceId)	Creates an instance with the specified instance id
com.oracle.bmc.core.model.Instance	waitForInstanceTerminationToComplete(String instanceId)	Wait for the termination with the specified instance id to complete

Methods inherited from class java.lang.Object

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

Constructor Detail

SDKBaremetalCloudClient

public SDKBaremetalCloudClient(com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider provider,
                               String regionId,
                               int maxAsyncThreads)

SDKBaremetalCloudClient

public SDKBaremetalCloudClient(com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider instancePrincipalsProvider,
                               String regionId,
                               int maxAsyncThreads,
                               String instancePrincipalsTenantId)

Method Detail

authenticate

public void authenticate()
                  throws com.oracle.bmc.model.BmcException

Specified by:

authenticate in interface BaremetalCloudClient

Throws:

com.oracle.bmc.model.BmcException - if an error occurs

createInstance

public com.oracle.bmc.core.model.Instance createInstance(String name,
                                                         BaremetalCloudAgentTemplate template)
                                                  throws Exception

Description copied from interface: BaremetalCloudClient

Creates an instance with the specified template

Specified by:

createInstance in interface BaremetalCloudClient

Parameters:

name - instance name

template - the instance configuration

Returns:

Instance

Throws:

Exception - if an error occurs

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

waitForInstanceProvisioningToComplete

public com.oracle.bmc.core.model.Instance waitForInstanceProvisioningToComplete(String instanceId)
                                                                         throws Exception

Description copied from interface: BaremetalCloudClient

Creates an instance with the specified instance id

Specified by:

waitForInstanceProvisioningToComplete in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Instance

Throws:

Exception - if an error occurs

getInstanceIp

public String getInstanceIp(BaremetalCloudAgentTemplate template,
                            String instanceId)
                     throws Exception

Description copied from interface: BaremetalCloudClient

Get an instance public or private ip with the specified instance id

Specified by:

getInstanceIp in interface BaremetalCloudClient

Parameters:

template - baremetal cloud agent template

instanceId - the instance id created before

Returns:

the instance ip

Throws:

Exception - if an error occurs

getTenant

public com.oracle.bmc.identity.model.Tenancy getTenant()
                                                throws Exception

Description copied from interface: BaremetalCloudClient

Get root compartment

Specified by:

getTenant in interface BaremetalCloudClient

Returns:

tenancy

Throws:

Exception - if an error occurs

getCompartmentsList

public List<com.oracle.bmc.identity.model.Compartment> getCompartmentsList()
                                                                    throws Exception

Description copied from interface: BaremetalCloudClient

Get the compartment list

Specified by:

getCompartmentsList in interface BaremetalCloudClient

Returns:

compartment list

Throws:

Exception - if an error occurs

getAvailabilityDomainsList

public List<com.oracle.bmc.identity.model.AvailabilityDomain> getAvailabilityDomainsList(String compartmentId)
                                                                                  throws Exception

Description copied from interface: BaremetalCloudClient

Get the available domain response

Specified by:

getAvailabilityDomainsList in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

Returns:

ad list

Throws:

Exception - if an error occurs

getImagesList

public List<com.oracle.bmc.core.model.Image> getImagesList(String compartmentId)
                                                    throws Exception

Description copied from interface: BaremetalCloudClient

Get the available image list

Specified by:

getImagesList in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

Returns:

image list

Throws:

Exception - if an error occurs

getShapesList

public List<com.oracle.bmc.core.model.Shape> getShapesList(String compartmentId,
                                                           String availableDomain,
                                                           String imageId)
                                                    throws Exception

Description copied from interface: BaremetalCloudClient

Get the shape list

Specified by:

getShapesList in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

availableDomain - available domain

imageId - image id

Returns:

shape list

Throws:

Exception - if an error occurs

getMinMaxOcpus

public Integer[] getMinMaxOcpus(String compartmentId,
                                String availableDomain,
                                String imageId,
                                String shape)
                         throws Exception

Description copied from interface: BaremetalCloudClient

Get the OCPUs options

Specified by:

getMinMaxOcpus in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

availableDomain - available domain

imageId - image id

shape - shape name

Returns:

an array with min (array[0]) and max (array[1])

Throws:

Exception - if an error occurs

getMinMaxMemory

public Integer[] getMinMaxMemory(String compartmentId,
                                 String availableDomain,
                                 String imageId,
                                 String shape)
                          throws Exception

Description copied from interface: BaremetalCloudClient

Get the memory options of Flex shapes

Specified by:

getMinMaxMemory in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

availableDomain - available domain

imageId - image id

shape - shape name

Returns:

an array with min (array[0]) and max (array[1])

Throws:

Exception - if an error occurs

getVcnList

public List<com.oracle.bmc.core.model.Vcn> getVcnList(String compartmentId)
                                               throws Exception

Description copied from interface: BaremetalCloudClient

Get the Virtual Cloud Network list

Specified by:

getVcnList in interface BaremetalCloudClient

Parameters:

compartmentId - the tenant id

Returns:

vcn list

Throws:

Exception - if an error occurs

getSubNetList

public List<com.oracle.bmc.core.model.Subnet> getSubNetList(String compartmentId,
                                                            String vcnId)
                                                     throws Exception

Description copied from interface: BaremetalCloudClient

Get the sub net list

Specified by:

getSubNetList in interface BaremetalCloudClient

Parameters:

compartmentId - the tenant id

vcnId - vcn id

Returns:

subnet list

Throws:

Exception - if an error occurs

getNsgIdsList

public List<com.oracle.bmc.core.model.NetworkSecurityGroup> getNsgIdsList(String compartmentId)
                                                                   throws Exception

Description copied from interface: BaremetalCloudClient

Get the network security group list

Specified by:

getNsgIdsList in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

Returns:

network security group list

Throws:

Exception - if an error occurs

getSubNet

public com.oracle.bmc.core.responses.GetSubnetResponse getSubNet(String subnetId)
                                                          throws Exception

Description copied from interface: BaremetalCloudClient

Get the sub net

Specified by:

getSubNet in interface BaremetalCloudClient

Parameters:

subnetId - subnet id

Returns:

GetSubnetResponse

Throws:

Exception - if an error occurs

terminateInstance

public String terminateInstance(String instanceId)
                         throws Exception

Description copied from interface: BaremetalCloudClient

Terminate instance with the specified instance id

Specified by:

terminateInstance in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Opc Request Id

Throws:

Exception - if an error occurs

waitForInstanceTerminationToComplete

public com.oracle.bmc.core.model.Instance waitForInstanceTerminationToComplete(String instanceId)
                                                                        throws Exception

Description copied from interface: BaremetalCloudClient

Wait for the termination with the specified instance id to complete

Specified by:

waitForInstanceTerminationToComplete in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Instance

Throws:

Exception - if an error occurs

getInstanceState

public com.oracle.bmc.core.model.Instance.LifecycleState getInstanceState(String instanceId)
                                                                   throws Exception

Description copied from interface: BaremetalCloudClient

Check instance's state

Specified by:

getInstanceState in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Instance.LifecycleState

Throws:

Exception - if an error occurs

getStoppedInstances

public List<com.oracle.bmc.core.model.Instance> getStoppedInstances(String compartmentId,
                                                                    String availableDomain)
                                                             throws Exception

Description copied from interface: BaremetalCloudClient

Get a list of stopped instances on OCI

Specified by:

getStoppedInstances in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

availableDomain - available domain

Returns:

Instance.LifecycleState

Throws:

Exception - if an error occurs

stopInstance

public String stopInstance(String instanceId)
                    throws Exception

Description copied from interface: BaremetalCloudClient

Stop instance with the specified instance id

Specified by:

stopInstance in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Instance.LifecycleState

Throws:

Exception - if an error occurs

startInstance

public com.oracle.bmc.core.model.Instance startInstance(String instanceId)
                                                 throws Exception

Description copied from interface: BaremetalCloudClient

Start instance with the specified instance id

Specified by:

startInstance in interface BaremetalCloudClient

Parameters:

instanceId - the instance id created before

Returns:

Instance.LifecycleState

Throws:

Exception - if an error occurs

getTagNamespaces

public List<com.oracle.bmc.identity.model.TagNamespaceSummary> getTagNamespaces(String compartmentId)
                                                                         throws Exception

Description copied from interface: BaremetalCloudClient

Start instance with the specified instance id

Specified by:

getTagNamespaces in interface BaremetalCloudClient

Parameters:

compartmentId - the compartment id

Returns:

tag namespace summary list

Throws:

Exception - if an error occurs