databricks

package
v19.1.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 17, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package databricks implements the Azure ARM Databricks service API version 2018-04-01.

ARM Databricks

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Databricks
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

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
	SubscriptionID string
}

BaseClient is the base client for Databricks.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type ErrorDetail 

type ErrorDetail struct {
	// Code - The error's code.
	Code *string `json:"code,omitempty"`
	// Message - A human readable error message.
	Message *string `json:"message,omitempty"`
	// Target - Indicates which property in the request is responsible for the error.
	Target *string `json:"target,omitempty"`
}

ErrorDetail ...

type ErrorInfo 

type ErrorInfo struct {
	// Code - A machine readable error code.
	Code *string `json:"code,omitempty"`
	// Message - A human readable error message.
	Message *string `json:"message,omitempty"`
	// Details - error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// Innererror - Inner error details if they exist.
	Innererror *string `json:"innererror,omitempty"`
}

ErrorInfo ...

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error details.
	Error *ErrorInfo `json:"error,omitempty"`
}

ErrorResponse contains details when the response code indicates an error.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.ResourceProvider
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Resource Provider operations supported by the Resource Provider resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

type OperationListResultIterator struct {
	// contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage 

type OperationListResultPage struct {
	// contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the ARM Databricks

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available RP operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Accepted ...
	Accepted ProvisioningState = "Accepted"
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Created ...
	Created ProvisioningState = "Created"
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleted ...
	Deleted ProvisioningState = "Deleted"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Ready ...
	Ready ProvisioningState = "Ready"
	// Running ...
	Running ProvisioningState = "Running"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
	// Updating ...
	Updating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Resource 

type Resource struct {
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Resource the core properties of ARM resources

type Sku 

type Sku struct {
	// Name - The SKU name.
	Name *string `json:"name,omitempty"`
	// Tier - The SKU tier.
	Tier *string `json:"tier,omitempty"`
}

Sku SKU for the resource.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type Workspace 

type Workspace struct {
	autorest.Response `json:"-"`
	// WorkspaceProperties - The workspace properties.
	*WorkspaceProperties `json:"properties,omitempty"`
	// Sku - The SKU of the resource.
	Sku *Sku `json:"sku,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Workspace information about workspace.

func (Workspace) MarshalJSON 

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Workspace.

func (*Workspace) UnmarshalJSON 

func (w *Workspace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Workspace struct.

type WorkspaceListResult 

type WorkspaceListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of workspaces.
	Value *[]Workspace `json:"value,omitempty"`
	// NextLink - The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

WorkspaceListResult list of workspaces.

func (WorkspaceListResult) IsEmpty 

func (wlr WorkspaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WorkspaceListResultIterator 

type WorkspaceListResultIterator struct {
	// contains filtered or unexported fields
}

WorkspaceListResultIterator provides access to a complete listing of Workspace values.

func (*WorkspaceListResultIterator) Next 

func (iter *WorkspaceListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (WorkspaceListResultIterator) NotDone 

func (iter WorkspaceListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (WorkspaceListResultIterator) Response 

func (iter WorkspaceListResultIterator) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultIterator) Value 

func (iter WorkspaceListResultIterator) Value() Workspace

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type WorkspaceListResultPage 

type WorkspaceListResultPage struct {
	// contains filtered or unexported fields
}

WorkspaceListResultPage contains a page of Workspace values.

func (*WorkspaceListResultPage) Next 

func (page *WorkspaceListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (WorkspaceListResultPage) NotDone 

func (page WorkspaceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (WorkspaceListResultPage) Response 

func (page WorkspaceListResultPage) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultPage) Values 

func (page WorkspaceListResultPage) Values() []Workspace

Values returns the slice of values for the current page or nil if there are no values.

type WorkspaceProperties 

type WorkspaceProperties struct {
	// ManagedResourceGroupID - The managed resource group Id.
	ManagedResourceGroupID *string `json:"managedResourceGroupId,omitempty"`
	// Parameters - Name and value pairs that define the workspace parameters.
	Parameters interface{} `json:"parameters,omitempty"`
	// ProvisioningState - The workspace provisioning state. Possible values include: 'Accepted', 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Updating'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// UIDefinitionURI - The blob URI where the UI definition file is located.
	UIDefinitionURI *string `json:"uiDefinitionUri,omitempty"`
	// Authorizations - The workspace provider authorizations.
	Authorizations *[]WorkspaceProviderAuthorization `json:"authorizations,omitempty"`
}

WorkspaceProperties the workspace properties.

type WorkspaceProviderAuthorization 

type WorkspaceProviderAuthorization struct {
	// PrincipalID - The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources.
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// RoleDefinitionID - The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group.
	RoleDefinitionID *uuid.UUID `json:"roleDefinitionId,omitempty"`
}

WorkspaceProviderAuthorization the workspace provider authorization.

type WorkspaceUpdate 

type WorkspaceUpdate struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

WorkspaceUpdate an update to a workspace.

func (WorkspaceUpdate) MarshalJSON 

func (wu WorkspaceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceUpdate.

type WorkspacesClient 

type WorkspacesClient struct {
	BaseClient
}

WorkspacesClient is the ARM Databricks

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient client.

func (WorkspacesClient) CreateOrUpdate 

func (client WorkspacesClient) CreateOrUpdate(ctx context.Context, parameters Workspace, resourceGroupName string, workspaceName string) (result WorkspacesCreateOrUpdateFuture, err error)

CreateOrUpdate creates a new workspace. Parameters: parameters - parameters supplied to the create or update a workspace. resourceGroupName - the name of the resource group. The name is case insensitive. workspaceName - the name of the workspace.

func (WorkspacesClient) CreateOrUpdatePreparer 

func (client WorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, parameters Workspace, resourceGroupName string, workspaceName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (WorkspacesClient) CreateOrUpdateResponder 

func (client WorkspacesClient) CreateOrUpdateResponder(resp *http.Response) (result Workspace, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (WorkspacesClient) CreateOrUpdateSender 

func (client WorkspacesClient) CreateOrUpdateSender(req *http.Request) (future WorkspacesCreateOrUpdateFuture, err error)

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

func (WorkspacesClient) Delete 

func (client WorkspacesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string) (result WorkspacesDeleteFuture, err error)

Delete deletes the workspace. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. workspaceName - the name of the workspace.

func (WorkspacesClient) DeletePreparer 

func (client WorkspacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (WorkspacesClient) DeleteResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) DeleteSender 

func (client WorkspacesClient) DeleteSender(req *http.Request) (future WorkspacesDeleteFuture, err error)

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

func (WorkspacesClient) Get 

func (client WorkspacesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string) (result Workspace, err error)

Get gets the workspace. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. workspaceName - the name of the workspace.

func (WorkspacesClient) GetPreparer 

func (client WorkspacesClient) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (WorkspacesClient) GetResponder 

func (client WorkspacesClient) GetResponder(resp *http.Response) (result Workspace, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (WorkspacesClient) GetSender 

func (client WorkspacesClient) GetSender(req *http.Request) (*http.Response, error)

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

func (WorkspacesClient) ListByResourceGroup 

func (client WorkspacesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result WorkspaceListResultPage, err error)

ListByResourceGroup gets all the workspaces within a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (WorkspacesClient) ListByResourceGroupComplete 

func (client WorkspacesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result WorkspaceListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (WorkspacesClient) ListByResourceGroupPreparer 

func (client WorkspacesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (WorkspacesClient) ListByResourceGroupResponder 

func (client WorkspacesClient) ListByResourceGroupResponder(resp *http.Response) (result WorkspaceListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (WorkspacesClient) ListByResourceGroupSender 

func (client WorkspacesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (WorkspacesClient) ListBySubscription 

func (client WorkspacesClient) ListBySubscription(ctx context.Context) (result WorkspaceListResultPage, err error)

ListBySubscription gets all the workspaces within a subscription.

func (WorkspacesClient) ListBySubscriptionComplete 

func (client WorkspacesClient) ListBySubscriptionComplete(ctx context.Context) (result WorkspaceListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (WorkspacesClient) ListBySubscriptionPreparer 

func (client WorkspacesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (WorkspacesClient) ListBySubscriptionResponder 

func (client WorkspacesClient) ListBySubscriptionResponder(resp *http.Response) (result WorkspaceListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (WorkspacesClient) ListBySubscriptionSender 

func (client WorkspacesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (WorkspacesClient) Update 

func (client WorkspacesClient) Update(ctx context.Context, parameters WorkspaceUpdate, resourceGroupName string, workspaceName string) (result WorkspacesUpdateFuture, err error)

Update updates a workspace. Parameters: parameters - the update to the workspace. resourceGroupName - the name of the resource group. The name is case insensitive. workspaceName - the name of the workspace.

func (WorkspacesClient) UpdatePreparer 

func (client WorkspacesClient) UpdatePreparer(ctx context.Context, parameters WorkspaceUpdate, resourceGroupName string, workspaceName string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (WorkspacesClient) UpdateResponder 

func (client WorkspacesClient) UpdateResponder(resp *http.Response) (result Workspace, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (WorkspacesClient) UpdateSender 

func (client WorkspacesClient) UpdateSender(req *http.Request) (future WorkspacesUpdateFuture, err error)

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

type WorkspacesCreateOrUpdateFuture 

type WorkspacesCreateOrUpdateFuture struct {
	azure.Future
}

WorkspacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*WorkspacesCreateOrUpdateFuture) Result 

func (future *WorkspacesCreateOrUpdateFuture) Result(client WorkspacesClient) (w Workspace, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type WorkspacesDeleteFuture 

type WorkspacesDeleteFuture struct {
	azure.Future
}

WorkspacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*WorkspacesDeleteFuture) Result 

func (future *WorkspacesDeleteFuture) Result(client WorkspacesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type WorkspacesUpdateFuture 

type WorkspacesUpdateFuture struct {
	azure.Future
}

WorkspacesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*WorkspacesUpdateFuture) Result 

func (future *WorkspacesUpdateFuture) Result(client WorkspacesClient) (w Workspace, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.