Class GlobalInitScriptsClient

Index

Constructors

Methods

createGlobalInitScript deleteGlobalInitScript getGlobalInitScript listGlobalInitScripts updateGlobalInitScript

Constructors

constructor

new GlobalInitScriptsClient(options: ClientOptions): GlobalInitScriptsClient
Parameters
- options: ClientOptions
Returns GlobalInitScriptsClient
- Defined in client.ts:59

Methods

createGlobalInitScript

createGlobalInitScript(
req: CreateGlobalInitScriptRequest,
options?: CallOptions,
): Promise<CreateGlobalInitScriptResponse>
Creates a new global init script in this workspace.
Parameters
- req: CreateGlobalInitScriptRequest
- Optionaloptions: CallOptions
Returns Promise<CreateGlobalInitScriptResponse>
- Defined in client.ts:75

deleteGlobalInitScript

deleteGlobalInitScript(
req: DeleteGlobalInitScriptRequest,
options?: CallOptions,
): Promise<DeleteGlobalInitScriptResponse>
Deletes a global init script.
Parameters
- req: DeleteGlobalInitScriptRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteGlobalInitScriptResponse>
- Defined in client.ts:111

getGlobalInitScript

getGlobalInitScript(
req: GetGlobalInitScriptRequest,
options?: CallOptions,
): Promise<GlobalInitScriptDetails>
Gets all the details of a script, including its Base64-encoded contents.
Parameters
- req: GetGlobalInitScriptRequest
- Optionaloptions: CallOptions
Returns Promise<GlobalInitScriptDetails>
- Defined in client.ts:143

listGlobalInitScripts

listGlobalInitScripts(
_req: ListGlobalInitScriptsRequest,
options?: CallOptions,
): Promise<ListGlobalInitScriptsResponse>
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 operation.
Parameters
- _req: ListGlobalInitScriptsRequest
- Optionaloptions: CallOptions
Returns Promise<ListGlobalInitScriptsResponse>
- Defined in client.ts:175

updateGlobalInitScript

updateGlobalInitScript(
req: UpdateGlobalInitScriptRequest,
options?: CallOptions,
): Promise<UpdateGlobalInitScriptResponse>
Updates a global init script, specifying only the fields to change. All fields are optional. Unspecified fields retain their current value.
Parameters
- req: UpdateGlobalInitScriptRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateGlobalInitScriptResponse>
- Defined in client.ts:210