workspace

Documentation

Overview

Package workspace implements the Azure ARM Workspace service API version 0.1.0.

Databricks REST API

Index

• Constants
• func UserAgent() string
• func Version() string
• type BaseClient
  • func New() BaseClient
  • func NewWithBaseURI(baseURI string) BaseClient
  • func (client BaseClient) Delete(ctx context.Context, body DeleteAttributes) (result autorest.Response, err error)
  • func (client BaseClient) DeletePreparer(ctx context.Context, body DeleteAttributes) (*http.Request, error)
  • func (client BaseClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) DeleteSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) Export(ctx context.Context, pathParameter string, formatParameter string, ...) (result ExportResult, err error)
  • func (client BaseClient) ExportPreparer(ctx context.Context, pathParameter string, formatParameter string, ...) (*http.Request, error)
  • func (client BaseClient) ExportResponder(resp *http.Response) (result ExportResult, err error)
  • func (client BaseClient) ExportSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) GetStatus(ctx context.Context, pathParameter string) (result ObjectInfo, err error)
  • func (client BaseClient) GetStatusPreparer(ctx context.Context, pathParameter string) (*http.Request, error)
  • func (client BaseClient) GetStatusResponder(resp *http.Response) (result ObjectInfo, err error)
  • func (client BaseClient) GetStatusSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) Import(ctx context.Context, body ImportAttributes) (result autorest.Response, err error)
  • func (client BaseClient) ImportPreparer(ctx context.Context, body ImportAttributes) (*http.Request, error)
  • func (client BaseClient) ImportResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) ImportSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) List(ctx context.Context, pathParameter string) (result ListResult, err error)
  • func (client BaseClient) ListPreparer(ctx context.Context, pathParameter string) (*http.Request, error)
  • func (client BaseClient) ListResponder(resp *http.Response) (result ListResult, err error)
  • func (client BaseClient) ListSender(req *http.Request) (*http.Response, error)
  • func (client BaseClient) Mkdirs(ctx context.Context, body MkdirsAttributes) (result autorest.Response, err error)
  • func (client BaseClient) MkdirsPreparer(ctx context.Context, body MkdirsAttributes) (*http.Request, error)
  • func (client BaseClient) MkdirsResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client BaseClient) MkdirsSender(req *http.Request) (*http.Response, error)
• type DeleteAttributes
• type ExportResult
• type Format
  • func PossibleFormatValues() []Format
• type ImportAttributes
• type Language
  • func PossibleLanguageValues() []Language
• type ListResult
• type MkdirsAttributes
• type ObjectInfo
• type ObjectType
  • func PossibleObjectTypeValues() []ObjectType

Constants

const (
	// DefaultBaseURI is the default URI used for the service Workspace
	DefaultBaseURI = "/api/2.0"
)

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Workspace.

func New

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BaseClient) Delete

func (client BaseClient) Delete(ctx context.Context, body DeleteAttributes) (result autorest.Response, err error)

Delete sends the delete request.

func (BaseClient) DeletePreparer

func (client BaseClient) DeletePreparer(ctx context.Context, body DeleteAttributes) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BaseClient) DeleteResponder

func (client BaseClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (BaseClient) DeleteSender

func (client BaseClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (BaseClient) Export

func (client BaseClient) Export(ctx context.Context, pathParameter string, formatParameter string, directDownload *bool) (result ExportResult, err error)

Export sends the export request.

func (BaseClient) ExportPreparer

func (client BaseClient) ExportPreparer(ctx context.Context, pathParameter string, formatParameter string, directDownload *bool) (*http.Request, error)

ExportPreparer prepares the Export request.

func (BaseClient) ExportResponder

func (client BaseClient) ExportResponder(resp *http.Response) (result ExportResult, err error)

ExportResponder handles the response to the Export request. The method always closes the http.Response Body.

func (BaseClient) ExportSender

func (client BaseClient) ExportSender(req *http.Request) (*http.Response, error)

ExportSender sends the Export request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetStatus

func (client BaseClient) GetStatus(ctx context.Context, pathParameter string) (result ObjectInfo, err error)

GetStatus sends the get status request.

func (BaseClient) GetStatusPreparer

func (client BaseClient) GetStatusPreparer(ctx context.Context, pathParameter string) (*http.Request, error)

GetStatusPreparer prepares the GetStatus request.

func (BaseClient) GetStatusResponder

func (client BaseClient) GetStatusResponder(resp *http.Response) (result ObjectInfo, err error)

GetStatusResponder handles the response to the GetStatus request. The method always closes the http.Response Body.

func (BaseClient) GetStatusSender

func (client BaseClient) GetStatusSender(req *http.Request) (*http.Response, error)

GetStatusSender sends the GetStatus request. The method will close the http.Response Body if it receives an error.

func (BaseClient) Import

func (client BaseClient) Import(ctx context.Context, body ImportAttributes) (result autorest.Response, err error)

Import sends the import request.

func (BaseClient) ImportPreparer

func (client BaseClient) ImportPreparer(ctx context.Context, body ImportAttributes) (*http.Request, error)

ImportPreparer prepares the Import request.

func (BaseClient) ImportResponder

func (client BaseClient) ImportResponder(resp *http.Response) (result autorest.Response, err error)

ImportResponder handles the response to the Import request. The method always closes the http.Response Body.

func (BaseClient) ImportSender

func (client BaseClient) ImportSender(req *http.Request) (*http.Response, error)

ImportSender sends the Import request. The method will close the http.Response Body if it receives an error.

func (BaseClient) List

func (client BaseClient) List(ctx context.Context, pathParameter string) (result ListResult, err error)

List sends the list request.

func (BaseClient) ListPreparer

func (client BaseClient) ListPreparer(ctx context.Context, pathParameter string) (*http.Request, error)

ListPreparer prepares the List request.

func (BaseClient) ListResponder

func (client BaseClient) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (BaseClient) ListSender

func (client BaseClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (BaseClient) Mkdirs

func (client BaseClient) Mkdirs(ctx context.Context, body MkdirsAttributes) (result autorest.Response, err error)

Mkdirs sends the mkdirs request.

func (BaseClient) MkdirsPreparer

func (client BaseClient) MkdirsPreparer(ctx context.Context, body MkdirsAttributes) (*http.Request, error)

MkdirsPreparer prepares the Mkdirs request.

func (BaseClient) MkdirsResponder

func (client BaseClient) MkdirsResponder(resp *http.Response) (result autorest.Response, err error)

MkdirsResponder handles the response to the Mkdirs request. The method always closes the http.Response Body.

func (BaseClient) MkdirsSender

func (client BaseClient) MkdirsSender(req *http.Request) (*http.Response, error)

MkdirsSender sends the Mkdirs request. The method will close the http.Response Body if it receives an error.

type DeleteAttributes

type DeleteAttributes struct {
	Path      *string `json:"path,omitempty"`
	Recursive *bool   `json:"recursive,omitempty"`
}

DeleteAttributes ...

type ExportResult

type ExportResult struct {
	autorest.Response `json:"-"`
	Content           *string `json:"content,omitempty"`
}

ExportResult ...

type Format

type Format string

Format enumerates the values for format.

const (
	// DBC ...
	DBC Format = "DBC"
	// HTML ...
	HTML Format = "HTML"
	// JUPYTER ...
	JUPYTER Format = "JUPYTER"
	// SOURCE ...
	SOURCE Format = "SOURCE"
)

func PossibleFormatValues

func PossibleFormatValues() []Format

PossibleFormatValues returns an array of possible values for the Format const type.

type ImportAttributes

type ImportAttributes struct {
	Path *string `json:"path,omitempty"`
	// Format - Possible values include: 'SOURCE', 'HTML', 'JUPYTER', 'DBC'
	Format Format `json:"format,omitempty"`
	// Language - Possible values include: 'SCALA', 'PYTHON', 'SQL', 'R'
	Language  Language `json:"language,omitempty"`
	Content   *string  `json:"content,omitempty"`
	Overwrite *bool    `json:"overwrite,omitempty"`
}

ImportAttributes ...

type Language

type Language string

Language enumerates the values for language.

const (
	// PYTHON ...
	PYTHON Language = "PYTHON"
	// R ...
	R Language = "R"
	// SCALA ...
	SCALA Language = "SCALA"
	// SQL ...
	SQL Language = "SQL"
)

func PossibleLanguageValues

func PossibleLanguageValues() []Language

PossibleLanguageValues returns an array of possible values for the Language const type.

type ListResult

type ListResult struct {
	autorest.Response `json:"-"`
	Objects           *[]ObjectInfo `json:"objects,omitempty"`
}

ListResult ...

type MkdirsAttributes

type MkdirsAttributes struct {
	Path *string `json:"path,omitempty"`
}

MkdirsAttributes ...

type ObjectInfo

type ObjectInfo struct {
	autorest.Response `json:"-"`
	// ObjectType - Possible values include: 'NOTEBOOK', 'DIRECTORY', 'LIBRARY'
	ObjectType ObjectType `json:"object_type,omitempty"`
	ObjectID   *int64     `json:"object_id,omitempty"`
	Path       *string    `json:"path,omitempty"`
	Language   *string    `json:"language,omitempty"`
}

ObjectInfo ...

type ObjectType

type ObjectType string

ObjectType enumerates the values for object type.

const (
	// DIRECTORY ...
	DIRECTORY ObjectType = "DIRECTORY"
	// LIBRARY ...
	LIBRARY ObjectType = "LIBRARY"
	// NOTEBOOK ...
	NOTEBOOK ObjectType = "NOTEBOOK"
)

func PossibleObjectTypeValues

func PossibleObjectTypeValues() []ObjectType

PossibleObjectTypeValues returns an array of possible values for the ObjectType const type.