com.databricks.sdk.service.compute

Class GlobalInitScriptsAPI

java.lang.Object

com.databricks.sdk.service.compute.GlobalInitScriptsAPI

@Generated
public class GlobalInitScriptsAPI
extends Object

The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace. These scripts run on every node in every cluster in the workspace.

**Important:** Existing clusters must be restarted to pick up any changes made to global init scripts. Global init scripts are run in order. If the init script returns with a bad exit code, the Apache Spark container fails to launch and init scripts with later position are skipped. If enough containers fail, the entire cluster fails with a `GLOBAL_INIT_SCRIPT_FAILURE` error code.

Constructor Summary

Constructors

Constructor and Description
GlobalInitScriptsAPI(ApiClient apiClient) Regular-use constructor
GlobalInitScriptsAPI(GlobalInitScriptsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreateResponse	create(GlobalInitScriptCreateRequest request) Create init script.
CreateResponse	create(String name, String script)
void	delete(DeleteGlobalInitScriptRequest request) Delete init script.
void	delete(String scriptId)
GlobalInitScriptDetailsWithContent	get(GetGlobalInitScriptRequest request) Get an init script.
GlobalInitScriptDetailsWithContent	get(String scriptId)
GlobalInitScriptsService	impl()
Iterable<GlobalInitScriptDetails>	list() Get init scripts.
void	update(GlobalInitScriptUpdateRequest request) Update init script.
void	update(String scriptId, String name, String script)

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalInitScriptsAPI

public GlobalInitScriptsAPI(ApiClient apiClient)

Regular-use constructor

GlobalInitScriptsAPI

public GlobalInitScriptsAPI(GlobalInitScriptsService mock)

Constructor for mocks

Method Detail

create

public CreateResponse create(String name,
                             String script)

create

public CreateResponse create(GlobalInitScriptCreateRequest request)

Create init script.

Creates a new global init script in this workspace.

delete

public void delete(String scriptId)

delete

public void delete(DeleteGlobalInitScriptRequest request)

Delete init script.

Deletes a global init script.

get

public GlobalInitScriptDetailsWithContent get(String scriptId)

get

public GlobalInitScriptDetailsWithContent get(GetGlobalInitScriptRequest request)

Get an init script.

Gets all the details of a script, including its Base64-encoded contents.

list

public Iterable<GlobalInitScriptDetails> list()

Get init scripts.

Get a list of all global init scripts for this workspace. This returns all properties for each script but **not** the script contents. To retrieve the contents of a script, use the [get a global init script](:method:globalinitscripts/get) operation.

update

public void update(String scriptId,
                   String name,
                   String script)

update

public void update(GlobalInitScriptUpdateRequest request)

Update init script.

Updates a global init script, specifying only the fields to change. All fields are optional. Unspecified fields retain their current value.

impl

public GlobalInitScriptsService impl()