com.edmunds.rest.databricks.service

Interface InstanceProfilesService

All Known Implementing Classes:

InstanceProfilesServiceImpl

public interface InstanceProfilesService

A Wrapper around the instance profiles part of the databricks rest api.

See Also:

https://docs.databricks.com/api/latest/instance-profiles.html#instance-profiles-api

Method Summary

Modifier and Type	Method and Description
void	add(String instanceProfileArn) Registers an instance profile in Databricks.
void	add(String instanceProfileArn, boolean skipValidation) Registers an instance profile in Databricks.
boolean	exists(String instanceProfileArn) Checks if the instance profile is registered.
InstanceProfileDTO[]	list() Lists the instance profiles that the calling user can use to launch a cluster.
void	remove(String instanceProfileArn) Removes the instance profile with the provided ARN.

Method Detail

add

void add(String instanceProfileArn)
  throws IOException,
         DatabricksRestException

Registers an instance profile in Databricks. Does profile validation by default.

Parameters:

instanceProfileArn - the AWS ARN of the instance profile to register

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

add

void add(String instanceProfileArn,
         boolean skipValidation)
  throws IOException,
         DatabricksRestException

Registers an instance profile in Databricks.

Parameters:

instanceProfileArn - the AWS ARN of the instance profile to register

skipValidation - skip validation that profile has sufficient permissions to launch instances

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

list

InstanceProfileDTO[] list()
                   throws IOException,
                          DatabricksRestException

Lists the instance profiles that the calling user can use to launch a cluster.

Returns:

list of instance profiles the user can access

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

remove

void remove(String instanceProfileArn)
     throws IOException,
            DatabricksRestException

Removes the instance profile with the provided ARN.

Parameters:

instanceProfileArn - the arn of the instance profile to remove

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

exists

boolean exists(String instanceProfileArn)
        throws IOException,
               DatabricksRestException

Checks if the instance profile is registered.

Parameters:

instanceProfileArn - arn of the instance profile to check

Returns:

true if arn is in the list of registered profiles

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request