job

package
v11.3.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package job implements the Azure ARM Job service API version 2017-09-01-preview.

Creates an Azure Data Lake Analytics job client.

Index

Constants

View Source 
const (
	// DefaultAdlaJobDNSSuffix is the default value for adla job dns suffix
	DefaultAdlaJobDNSSuffix = "azuredatalakeanalytics.net"
)

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 BaseJobParameters 

type BaseJobParameters struct {
	Type       Type                `json:"type,omitempty"`
	Properties CreateJobProperties `json:"properties,omitempty"`
}

BaseJobParameters is data Lake Analytics Job Parameters base class for build and submit.

func (*BaseJobParameters) UnmarshalJSON 

func (bjp *BaseJobParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BaseJobParameters struct.

type BuildJobParameters 

type BuildJobParameters struct {
	Type       Type                `json:"type,omitempty"`
	Properties CreateJobProperties `json:"properties,omitempty"`
	Name       *string             `json:"name,omitempty"`
}

BuildJobParameters is the parameters used to build a new Data Lake Analytics job.

func (*BuildJobParameters) UnmarshalJSON 

func (bjp *BuildJobParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BuildJobParameters struct.

type CompileMode 

type CompileMode string

CompileMode enumerates the values for compile mode. 

const (
	// Full specifies the full state for compile mode.
	Full CompileMode = "Full"
	// Semantic specifies the semantic state for compile mode.
	Semantic CompileMode = "Semantic"
	// SingleBox specifies the single box state for compile mode.
	SingleBox CompileMode = "SingleBox"
)

type CreateJobParameters 

type CreateJobParameters struct {
	Type                Type                    `json:"type,omitempty"`
	Properties          CreateJobProperties     `json:"properties,omitempty"`
	Name                *string                 `json:"name,omitempty"`
	DegreeOfParallelism *int32                  `json:"degreeOfParallelism,omitempty"`
	Priority            *int32                  `json:"priority,omitempty"`
	LogFilePatterns     *[]string               `json:"logFilePatterns,omitempty"`
	Related             *RelationshipProperties `json:"related,omitempty"`
}

CreateJobParameters is the parameters used to submit a new Data Lake Analytics job.

func (*CreateJobParameters) UnmarshalJSON 

func (cjp *CreateJobParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateJobParameters struct.

type CreateJobProperties 

type CreateJobProperties interface {
	AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)
	AsCreateScopeJobProperties() (*CreateScopeJobProperties, bool)
}

CreateJobProperties is the common Data Lake Analytics job properties for job submission.

type CreateScopeJobParameters 

type CreateScopeJobParameters struct {
	Type                Type                    `json:"type,omitempty"`
	Properties          CreateJobProperties     `json:"properties,omitempty"`
	Name                *string                 `json:"name,omitempty"`
	DegreeOfParallelism *int32                  `json:"degreeOfParallelism,omitempty"`
	Priority            *int32                  `json:"priority,omitempty"`
	LogFilePatterns     *[]string               `json:"logFilePatterns,omitempty"`
	Related             *RelationshipProperties `json:"related,omitempty"`
	Tags                *map[string]*string     `json:"tags,omitempty"`
}

CreateScopeJobParameters is the parameters used to submit a new Data Lake Analytics Scope job. (Only for use internally with Scope job type.)

func (*CreateScopeJobParameters) UnmarshalJSON 

func (csjp *CreateScopeJobParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateScopeJobParameters struct.

type CreateScopeJobProperties 

type CreateScopeJobProperties struct {
	RuntimeVersion *string             `json:"runtimeVersion,omitempty"`
	Script         *string             `json:"script,omitempty"`
	Type           Type                `json:"type,omitempty"`
	Resources      *[]ScopeJobResource `json:"resources,omitempty"`
	Notifier       *string             `json:"notifier,omitempty"`
}

CreateScopeJobProperties is scope job properties used when submitting Scope jobs.

func (CreateScopeJobProperties) AsCreateScopeJobProperties 

func (csjp CreateScopeJobProperties) AsCreateScopeJobProperties() (*CreateScopeJobProperties, bool)

AsCreateScopeJobProperties is the CreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) AsCreateUSQLJobProperties 

func (csjp CreateScopeJobProperties) AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)

AsCreateUSQLJobProperties is the CreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) MarshalJSON 

func (csjp CreateScopeJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateScopeJobProperties.

type CreateUSQLJobProperties 

type CreateUSQLJobProperties struct {
	RuntimeVersion *string     `json:"runtimeVersion,omitempty"`
	Script         *string     `json:"script,omitempty"`
	Type           Type        `json:"type,omitempty"`
	CompileMode    CompileMode `json:"compileMode,omitempty"`
}

CreateUSQLJobProperties is u-SQL job properties used when submitting U-SQL jobs.

func (CreateUSQLJobProperties) AsCreateScopeJobProperties 

func (cusjp CreateUSQLJobProperties) AsCreateScopeJobProperties() (*CreateScopeJobProperties, bool)

AsCreateScopeJobProperties is the CreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) AsCreateUSQLJobProperties 

func (cusjp CreateUSQLJobProperties) AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)

AsCreateUSQLJobProperties is the CreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) MarshalJSON 

func (cusjp CreateUSQLJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateUSQLJobProperties.

type DataPath 

type DataPath struct {
	autorest.Response `json:"-"`
	JobID             *uuid.UUID `json:"jobId,omitempty"`
	Command           *string    `json:"command,omitempty"`
	Paths             *[]string  `json:"paths,omitempty"`
}

DataPath is a Data Lake Analytics job data path item.

type Diagnostics 

type Diagnostics struct {
	ColumnNumber *int32        `json:"columnNumber,omitempty"`
	End          *int32        `json:"end,omitempty"`
	LineNumber   *int32        `json:"lineNumber,omitempty"`
	Message      *string       `json:"message,omitempty"`
	Severity     SeverityTypes `json:"severity,omitempty"`
	Start        *int32        `json:"start,omitempty"`
}

Diagnostics is error diagnostic information for failed jobs.

type ErrorDetails 

type ErrorDetails struct {
	Description         *string       `json:"description,omitempty"`
	Details             *string       `json:"details,omitempty"`
	EndOffset           *int32        `json:"endOffset,omitempty"`
	ErrorID             *string       `json:"errorId,omitempty"`
	FilePath            *string       `json:"filePath,omitempty"`
	HelpLink            *string       `json:"helpLink,omitempty"`
	InternalDiagnostics *string       `json:"internalDiagnostics,omitempty"`
	LineNumber          *int32        `json:"lineNumber,omitempty"`
	Message             *string       `json:"message,omitempty"`
	Resolution          *string       `json:"resolution,omitempty"`
	InnerError          *InnerError   `json:"innerError,omitempty"`
	Severity            SeverityTypes `json:"severity,omitempty"`
	Source              *string       `json:"source,omitempty"`
	StartOffset         *int32        `json:"startOffset,omitempty"`
}

ErrorDetails is the Data Lake Analytics job error details.

type GroupClient 

type GroupClient struct {
	ManagementClient
}

GroupClient is the creates an Azure Data Lake Analytics job client.

func NewGroupClient 

func NewGroupClient() GroupClient

NewGroupClient creates an instance of the GroupClient client.

func (GroupClient) Build 

func (client GroupClient) Build(accountName string, parameters BuildJobParameters) (result Information, err error)

Build builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.

accountName is the Azure Data Lake Analytics account to execute job operations on. parameters is the parameters to build a job.

func (GroupClient) BuildPreparer 

func (client GroupClient) BuildPreparer(accountName string, parameters BuildJobParameters) (*http.Request, error)

BuildPreparer prepares the Build request.

func (GroupClient) BuildResponder 

func (client GroupClient) BuildResponder(resp *http.Response) (result Information, err error)

BuildResponder handles the response to the Build request. The method always closes the http.Response Body.

func (GroupClient) BuildSender 

func (client GroupClient) BuildSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) Cancel 

func (client GroupClient) Cancel(accountName string, jobIdentity uuid.UUID, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Cancel cancels the running job specified by the job ID. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job identifier. Uniquely identifies the job across all jobs submitted to the service.

func (GroupClient) CancelPreparer 

func (client GroupClient) CancelPreparer(accountName string, jobIdentity uuid.UUID, cancel <-chan struct{}) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (GroupClient) CancelResponder 

func (client GroupClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (GroupClient) CancelSender 

func (client GroupClient) CancelSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) Create 

func (client GroupClient) Create(accountName string, jobIdentity uuid.UUID, parameters CreateJobParameters) (result Information, err error)

Create submits a job to the specified Data Lake Analytics account.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job identifier. Uniquely identifies the job across all jobs submitted to the service. parameters is the parameters to submit a job.

func (GroupClient) CreatePreparer 

func (client GroupClient) CreatePreparer(accountName string, jobIdentity uuid.UUID, parameters CreateJobParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GroupClient) CreateResponder 

func (client GroupClient) CreateResponder(resp *http.Response) (result Information, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (GroupClient) CreateSender 

func (client GroupClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) Get 

func (client GroupClient) Get(accountName string, jobIdentity uuid.UUID) (result Information, err error)

Get gets the job information for the specified job ID.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is jobInfo ID.

func (GroupClient) GetDebugDataPath 

func (client GroupClient) GetDebugDataPath(accountName string, jobIdentity uuid.UUID) (result DataPath, err error)

GetDebugDataPath gets the job debug data information specified by the job ID.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job identifier. Uniquely identifies the job across all jobs submitted to the service.

func (GroupClient) GetDebugDataPathPreparer 

func (client GroupClient) GetDebugDataPathPreparer(accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetDebugDataPathPreparer prepares the GetDebugDataPath request.

func (GroupClient) GetDebugDataPathResponder 

func (client GroupClient) GetDebugDataPathResponder(resp *http.Response) (result DataPath, err error)

GetDebugDataPathResponder handles the response to the GetDebugDataPath request. The method always closes the http.Response Body.

func (GroupClient) GetDebugDataPathSender 

func (client GroupClient) GetDebugDataPathSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) GetPreparer 

func (client GroupClient) GetPreparer(accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) GetResponder(resp *http.Response) (result Information, err error)

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

func (GroupClient) GetSender 

func (client GroupClient) 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 (GroupClient) GetStatistics 

func (client GroupClient) GetStatistics(accountName string, jobIdentity uuid.UUID) (result Statistics, err error)

GetStatistics gets statistics of the specified job.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job Information ID.

func (GroupClient) GetStatisticsPreparer 

func (client GroupClient) GetStatisticsPreparer(accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetStatisticsPreparer prepares the GetStatistics request.

func (GroupClient) GetStatisticsResponder 

func (client GroupClient) GetStatisticsResponder(resp *http.Response) (result Statistics, err error)

GetStatisticsResponder handles the response to the GetStatistics request. The method always closes the http.Response Body.

func (GroupClient) GetStatisticsSender 

func (client GroupClient) GetStatisticsSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) List 

func (client GroupClient) List(accountName string, filter string, top *int32, skip *int32, selectParameter string, orderby string, count *bool) (result InfoListResult, err error)

List lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.

accountName is the Azure Data Lake Analytics account to execute job operations on. filter is oData filter. Optional. top is the number of items to return. Optional. skip is the number of items to skip over before returning elements. Optional. selectParameter is oData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. orderby is orderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. count is the Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.

func (GroupClient) ListComplete 

func (client GroupClient) ListComplete(accountName string, filter string, top *int32, skip *int32, selectParameter string, orderby string, count *bool, cancel <-chan struct{}) (<-chan InformationBasic, <-chan error)

ListComplete gets all elements from the list without paging.

func (GroupClient) ListNextResults 

func (client GroupClient) ListNextResults(lastResults InfoListResult) (result InfoListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (GroupClient) ListPreparer 

func (client GroupClient) ListPreparer(accountName string, filter string, top *int32, skip *int32, selectParameter string, orderby string, count *bool) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

func (client GroupClient) ListResponder(resp *http.Response) (result InfoListResult, err error)

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

func (GroupClient) ListSender 

func (client GroupClient) 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 (GroupClient) Update 

func (client GroupClient) Update(accountName string, jobIdentity uuid.UUID, parameters *UpdateJobParameters, cancel <-chan struct{}) (<-chan Information, <-chan error)

Update updates the job information for the specified job ID. (Only for use internally with Scope job type.) This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job identifier. Uniquely identifies the job across all jobs submitted to the service. parameters is the parameters to update a job.

func (GroupClient) UpdatePreparer 

func (client GroupClient) UpdatePreparer(accountName string, jobIdentity uuid.UUID, parameters *UpdateJobParameters, cancel <-chan struct{}) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (GroupClient) UpdateResponder 

func (client GroupClient) UpdateResponder(resp *http.Response) (result Information, err error)

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

func (GroupClient) UpdateSender 

func (client GroupClient) UpdateSender(req *http.Request) (*http.Response, error)

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

func (GroupClient) Yield 

func (client GroupClient) Yield(accountName string, jobIdentity uuid.UUID, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Yield pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.) This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

accountName is the Azure Data Lake Analytics account to execute job operations on. jobIdentity is job identifier. Uniquely identifies the job across all jobs submitted to the service.

func (GroupClient) YieldPreparer 

func (client GroupClient) YieldPreparer(accountName string, jobIdentity uuid.UUID, cancel <-chan struct{}) (*http.Request, error)

YieldPreparer prepares the Yield request.

func (GroupClient) YieldResponder 

func (client GroupClient) YieldResponder(resp *http.Response) (result autorest.Response, err error)

YieldResponder handles the response to the Yield request. The method always closes the http.Response Body.

func (GroupClient) YieldSender 

func (client GroupClient) YieldSender(req *http.Request) (*http.Response, error)

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

type HiveJobProperties 

type HiveJobProperties struct {
	RuntimeVersion         *string `json:"runtimeVersion,omitempty"`
	Script                 *string `json:"script,omitempty"`
	Type                   Type    `json:"type,omitempty"`
	LogsLocation           *string `json:"logsLocation,omitempty"`
	OutputLocation         *string `json:"outputLocation,omitempty"`
	StatementCount         *int32  `json:"statementCount,omitempty"`
	ExecutedStatementCount *int32  `json:"executedStatementCount,omitempty"`
}

HiveJobProperties is hive job properties used when retrieving Hive jobs.

func (HiveJobProperties) AsHiveJobProperties 

func (hjp HiveJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)

AsHiveJobProperties is the Properties implementation for HiveJobProperties.

func (HiveJobProperties) AsScopeJobProperties 

func (hjp HiveJobProperties) AsScopeJobProperties() (*ScopeJobProperties, bool)

AsScopeJobProperties is the Properties implementation for HiveJobProperties.

func (HiveJobProperties) AsUSQLJobProperties 

func (hjp HiveJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)

AsUSQLJobProperties is the Properties implementation for HiveJobProperties.

func (HiveJobProperties) MarshalJSON 

func (hjp HiveJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HiveJobProperties.

type InfoListResult 

type InfoListResult struct {
	autorest.Response `json:"-"`
	Value             *[]InformationBasic `json:"value,omitempty"`
	NextLink          *string             `json:"nextLink,omitempty"`
}

InfoListResult is list of JobInfo items.

func (InfoListResult) InfoListResultPreparer 

func (client InfoListResult) InfoListResultPreparer() (*http.Request, error)

InfoListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type Information 

type Information struct {
	autorest.Response   `json:"-"`
	JobID               *uuid.UUID              `json:"jobId,omitempty"`
	Name                *string                 `json:"name,omitempty"`
	Type                Type                    `json:"type,omitempty"`
	Submitter           *string                 `json:"submitter,omitempty"`
	DegreeOfParallelism *int32                  `json:"degreeOfParallelism,omitempty"`
	Priority            *int32                  `json:"priority,omitempty"`
	SubmitTime          *date.Time              `json:"submitTime,omitempty"`
	StartTime           *date.Time              `json:"startTime,omitempty"`
	EndTime             *date.Time              `json:"endTime,omitempty"`
	State               State                   `json:"state,omitempty"`
	Result              Result                  `json:"result,omitempty"`
	LogFolder           *string                 `json:"logFolder,omitempty"`
	LogFilePatterns     *[]string               `json:"logFilePatterns,omitempty"`
	Related             *RelationshipProperties `json:"related,omitempty"`
	Tags                *map[string]*string     `json:"tags,omitempty"`
	ErrorMessage        *[]ErrorDetails         `json:"errorMessage,omitempty"`
	StateAuditRecords   *[]StateAuditRecord     `json:"stateAuditRecords,omitempty"`
	Properties          Properties              `json:"properties,omitempty"`
}

Information is the extended Data Lake Analytics job information properties returned when retrieving a specific job.

func (*Information) UnmarshalJSON 

func (i *Information) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Information struct.

type InformationBasic 

type InformationBasic struct {
	JobID               *uuid.UUID              `json:"jobId,omitempty"`
	Name                *string                 `json:"name,omitempty"`
	Type                Type                    `json:"type,omitempty"`
	Submitter           *string                 `json:"submitter,omitempty"`
	DegreeOfParallelism *int32                  `json:"degreeOfParallelism,omitempty"`
	Priority            *int32                  `json:"priority,omitempty"`
	SubmitTime          *date.Time              `json:"submitTime,omitempty"`
	StartTime           *date.Time              `json:"startTime,omitempty"`
	EndTime             *date.Time              `json:"endTime,omitempty"`
	State               State                   `json:"state,omitempty"`
	Result              Result                  `json:"result,omitempty"`
	LogFolder           *string                 `json:"logFolder,omitempty"`
	LogFilePatterns     *[]string               `json:"logFilePatterns,omitempty"`
	Related             *RelationshipProperties `json:"related,omitempty"`
	Tags                *map[string]*string     `json:"tags,omitempty"`
}

InformationBasic is the common Data Lake Analytics job information properties.

type InnerError 

type InnerError struct {
	DiagnosticCode      *int32        `json:"diagnosticCode,omitempty"`
	Severity            SeverityTypes `json:"severity,omitempty"`
	Details             *string       `json:"details,omitempty"`
	Component           *string       `json:"component,omitempty"`
	ErrorID             *string       `json:"errorId,omitempty"`
	HelpLink            *string       `json:"helpLink,omitempty"`
	InternalDiagnostics *string       `json:"internalDiagnostics,omitempty"`
	Message             *string       `json:"message,omitempty"`
	Resolution          *string       `json:"resolution,omitempty"`
	Source              *string       `json:"source,omitempty"`
	Description         *string       `json:"description,omitempty"`
	InnerError          *InnerError   `json:"innerError,omitempty"`
}

InnerError is the Data Lake Analytics job error details.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	AdlaJobDNSSuffix string
}

ManagementClient is the base client for Job.

func New 

func New() ManagementClient

New creates an instance of the ManagementClient client.

func NewWithoutDefaults 

func NewWithoutDefaults(adlaJobDNSSuffix string) ManagementClient

NewWithoutDefaults creates an instance of the ManagementClient client.

type PipelineClient 

type PipelineClient struct {
	ManagementClient
}

PipelineClient is the creates an Azure Data Lake Analytics job client.

func NewPipelineClient 

func NewPipelineClient() PipelineClient

NewPipelineClient creates an instance of the PipelineClient client.

func (PipelineClient) Get 

func (client PipelineClient) Get(accountName string, pipelineIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (result PipelineInformation, err error)

Get gets the Pipeline information for the specified pipeline ID.

accountName is the Azure Data Lake Analytics account to execute job operations on. pipelineIdentity is pipeline ID. startDateTime is the start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime is the end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

func (PipelineClient) GetPreparer 

func (client PipelineClient) GetPreparer(accountName string, pipelineIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)

GetPreparer prepares the Get request.

func (PipelineClient) GetResponder 

func (client PipelineClient) GetResponder(resp *http.Response) (result PipelineInformation, err error)

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

func (PipelineClient) GetSender 

func (client PipelineClient) 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 (PipelineClient) List 

func (client PipelineClient) List(accountName string, startDateTime *date.Time, endDateTime *date.Time) (result PipelineInformationListResult, err error)

List lists all pipelines.

accountName is the Azure Data Lake Analytics account to execute job operations on. startDateTime is the start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime is the end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.

func (PipelineClient) ListComplete 

func (client PipelineClient) ListComplete(accountName string, startDateTime *date.Time, endDateTime *date.Time, cancel <-chan struct{}) (<-chan PipelineInformation, <-chan error)

ListComplete gets all elements from the list without paging.

func (PipelineClient) ListNextResults 

func (client PipelineClient) ListNextResults(lastResults PipelineInformationListResult) (result PipelineInformationListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (PipelineClient) ListPreparer 

func (client PipelineClient) ListPreparer(accountName string, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)

ListPreparer prepares the List request.

func (PipelineClient) ListResponder 

func (client PipelineClient) ListResponder(resp *http.Response) (result PipelineInformationListResult, err error)

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

func (PipelineClient) ListSender 

func (client PipelineClient) 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 PipelineInformation 

type PipelineInformation struct {
	autorest.Response `json:"-"`
	PipelineID        *uuid.UUID                `json:"pipelineId,omitempty"`
	PipelineName      *string                   `json:"pipelineName,omitempty"`
	PipelineURI       *string                   `json:"pipelineUri,omitempty"`
	NumJobsFailed     *int32                    `json:"numJobsFailed,omitempty"`
	NumJobsCanceled   *int32                    `json:"numJobsCanceled,omitempty"`
	NumJobsSucceeded  *int32                    `json:"numJobsSucceeded,omitempty"`
	AuHoursFailed     *float64                  `json:"auHoursFailed,omitempty"`
	AuHoursCanceled   *float64                  `json:"auHoursCanceled,omitempty"`
	AuHoursSucceeded  *float64                  `json:"auHoursSucceeded,omitempty"`
	LastSubmitTime    *date.Time                `json:"lastSubmitTime,omitempty"`
	Runs              *[]PipelineRunInformation `json:"runs,omitempty"`
	Recurrences       *[]uuid.UUID              `json:"recurrences,omitempty"`
}

PipelineInformation is job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline.

type PipelineInformationListResult 

type PipelineInformationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]PipelineInformation `json:"value,omitempty"`
	NextLink          *string                `json:"nextLink,omitempty"`
}

PipelineInformationListResult is list of job pipeline information items.

func (PipelineInformationListResult) PipelineInformationListResultPreparer 

func (client PipelineInformationListResult) PipelineInformationListResultPreparer() (*http.Request, error)

PipelineInformationListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type PipelineRunInformation 

type PipelineRunInformation struct {
	RunID          *uuid.UUID `json:"runId,omitempty"`
	LastSubmitTime *date.Time `json:"lastSubmitTime,omitempty"`
}

PipelineRunInformation is run info for a specific job pipeline.

type Properties 

type Properties interface {
	AsUSQLJobProperties() (*USQLJobProperties, bool)
	AsScopeJobProperties() (*ScopeJobProperties, bool)
	AsHiveJobProperties() (*HiveJobProperties, bool)
}

Properties is the common Data Lake Analytics job properties.

type RecurrenceClient 

type RecurrenceClient struct {
	ManagementClient
}

RecurrenceClient is the creates an Azure Data Lake Analytics job client.

func NewRecurrenceClient 

func NewRecurrenceClient() RecurrenceClient

NewRecurrenceClient creates an instance of the RecurrenceClient client.

func (RecurrenceClient) Get 

func (client RecurrenceClient) Get(accountName string, recurrenceIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (result RecurrenceInformation, err error)

Get gets the recurrence information for the specified recurrence ID.

accountName is the Azure Data Lake Analytics account to execute job operations on. recurrenceIdentity is recurrence ID. startDateTime is the start date for when to get the recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime is the end date for when to get recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

func (RecurrenceClient) GetPreparer 

func (client RecurrenceClient) GetPreparer(accountName string, recurrenceIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)

GetPreparer prepares the Get request.

func (RecurrenceClient) GetResponder 

func (client RecurrenceClient) GetResponder(resp *http.Response) (result RecurrenceInformation, err error)

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

func (RecurrenceClient) GetSender 

func (client RecurrenceClient) 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 (RecurrenceClient) List 

func (client RecurrenceClient) List(accountName string, startDateTime *date.Time, endDateTime *date.Time) (result RecurrenceInformationListResult, err error)

List lists all recurrences.

accountName is the Azure Data Lake Analytics account to execute job operations on. startDateTime is the start date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime is the end date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.

func (RecurrenceClient) ListComplete 

func (client RecurrenceClient) ListComplete(accountName string, startDateTime *date.Time, endDateTime *date.Time, cancel <-chan struct{}) (<-chan RecurrenceInformation, <-chan error)

ListComplete gets all elements from the list without paging.

func (RecurrenceClient) ListNextResults 

func (client RecurrenceClient) ListNextResults(lastResults RecurrenceInformationListResult) (result RecurrenceInformationListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (RecurrenceClient) ListPreparer 

func (client RecurrenceClient) ListPreparer(accountName string, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)

ListPreparer prepares the List request.

func (RecurrenceClient) ListResponder 

func (client RecurrenceClient) ListResponder(resp *http.Response) (result RecurrenceInformationListResult, err error)

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

func (RecurrenceClient) ListSender 

func (client RecurrenceClient) 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 RecurrenceInformation 

type RecurrenceInformation struct {
	autorest.Response `json:"-"`
	RecurrenceID      *uuid.UUID `json:"recurrenceId,omitempty"`
	RecurrenceName    *string    `json:"recurrenceName,omitempty"`
	NumJobsFailed     *int32     `json:"numJobsFailed,omitempty"`
	NumJobsCanceled   *int32     `json:"numJobsCanceled,omitempty"`
	NumJobsSucceeded  *int32     `json:"numJobsSucceeded,omitempty"`
	AuHoursFailed     *float64   `json:"auHoursFailed,omitempty"`
	AuHoursCanceled   *float64   `json:"auHoursCanceled,omitempty"`
	AuHoursSucceeded  *float64   `json:"auHoursSucceeded,omitempty"`
	LastSubmitTime    *date.Time `json:"lastSubmitTime,omitempty"`
}

RecurrenceInformation is recurrence job information for a specific recurrence.

type RecurrenceInformationListResult 

type RecurrenceInformationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]RecurrenceInformation `json:"value,omitempty"`
	NextLink          *string                  `json:"nextLink,omitempty"`
}

RecurrenceInformationListResult is list of job recurrence information items.

func (RecurrenceInformationListResult) RecurrenceInformationListResultPreparer 

func (client RecurrenceInformationListResult) RecurrenceInformationListResultPreparer() (*http.Request, error)

RecurrenceInformationListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type RelationshipProperties 

type RelationshipProperties struct {
	PipelineID     *uuid.UUID `json:"pipelineId,omitempty"`
	PipelineName   *string    `json:"pipelineName,omitempty"`
	PipelineURI    *string    `json:"pipelineUri,omitempty"`
	RunID          *uuid.UUID `json:"runId,omitempty"`
	RecurrenceID   *uuid.UUID `json:"recurrenceId,omitempty"`
	RecurrenceName *string    `json:"recurrenceName,omitempty"`
}

RelationshipProperties is job relationship information properties including pipeline information, correlation information, etc.

type Resource 

type Resource struct {
	Name         *string      `json:"name,omitempty"`
	ResourcePath *string      `json:"resourcePath,omitempty"`
	Type         ResourceType `json:"type,omitempty"`
}

Resource is the Data Lake Analytics job resources.

type ResourceType 

type ResourceType string

ResourceType enumerates the values for resource type. 

const (
	// JobManagerResource specifies the job manager resource state for resource type.
	JobManagerResource ResourceType = "JobManagerResource"
	// JobManagerResourceInUserFolder specifies the job manager resource in user folder state for resource type.
	JobManagerResourceInUserFolder ResourceType = "JobManagerResourceInUserFolder"
	// StatisticsResource specifies the statistics resource state for resource type.
	StatisticsResource ResourceType = "StatisticsResource"
	// StatisticsResourceInUserFolder specifies the statistics resource in user folder state for resource type.
	StatisticsResourceInUserFolder ResourceType = "StatisticsResourceInUserFolder"
	// VertexResource specifies the vertex resource state for resource type.
	VertexResource ResourceType = "VertexResource"
	// VertexResourceInUserFolder specifies the vertex resource in user folder state for resource type.
	VertexResourceInUserFolder ResourceType = "VertexResourceInUserFolder"
)

type ResourceUsageStatistics 

type ResourceUsageStatistics struct {
	Average *float64 `json:"average,omitempty"`
	Minimum *int64   `json:"minimum,omitempty"`
	Maximum *int64   `json:"maximum,omitempty"`
}

ResourceUsageStatistics is the statistics information for resource usage.

type Result 

type Result string

Result enumerates the values for result. 

const (
	// Cancelled specifies the cancelled state for result.
	Cancelled Result = "Cancelled"
	// Failed specifies the failed state for result.
	Failed Result = "Failed"
	// None specifies the none state for result.
	None Result = "None"
	// Succeeded specifies the succeeded state for result.
	Succeeded Result = "Succeeded"
)

type ScopeJobProperties 

type ScopeJobProperties struct {
	RuntimeVersion       *string             `json:"runtimeVersion,omitempty"`
	Script               *string             `json:"script,omitempty"`
	Type                 Type                `json:"type,omitempty"`
	Resources            *[]ScopeJobResource `json:"resources,omitempty"`
	UserAlgebraPath      *string             `json:"userAlgebraPath,omitempty"`
	Notifier             *string             `json:"notifier,omitempty"`
	TotalCompilationTime *string             `json:"totalCompilationTime,omitempty"`
	TotalPausedTime      *string             `json:"totalPausedTime,omitempty"`
	TotalQueuedTime      *string             `json:"totalQueuedTime,omitempty"`
	TotalRunningTime     *string             `json:"totalRunningTime,omitempty"`
	RootProcessNodeID    *string             `json:"rootProcessNodeId,omitempty"`
	YarnApplicationID    *string             `json:"yarnApplicationId,omitempty"`
}

ScopeJobProperties is scope job properties used when submitting and retrieving Scope jobs. (Only for use internally with Scope job type.)

func (ScopeJobProperties) AsHiveJobProperties 

func (sjp ScopeJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)

AsHiveJobProperties is the Properties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsScopeJobProperties 

func (sjp ScopeJobProperties) AsScopeJobProperties() (*ScopeJobProperties, bool)

AsScopeJobProperties is the Properties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsUSQLJobProperties 

func (sjp ScopeJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)

AsUSQLJobProperties is the Properties implementation for ScopeJobProperties.

func (ScopeJobProperties) MarshalJSON 

func (sjp ScopeJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ScopeJobProperties.

type ScopeJobResource 

type ScopeJobResource struct {
	Name *string `json:"name,omitempty"`
	Path *string `json:"path,omitempty"`
}

ScopeJobResource is the Scope job resources. (Only for use internally with Scope job type.)

type SeverityTypes 

type SeverityTypes string

SeverityTypes enumerates the values for severity types. 

const (
	// Deprecated specifies the deprecated state for severity types.
	Deprecated SeverityTypes = "Deprecated"
	// Error specifies the error state for severity types.
	Error SeverityTypes = "Error"
	// Info specifies the info state for severity types.
	Info SeverityTypes = "Info"
	// SevereWarning specifies the severe warning state for severity types.
	SevereWarning SeverityTypes = "SevereWarning"
	// UserWarning specifies the user warning state for severity types.
	UserWarning SeverityTypes = "UserWarning"
	// Warning specifies the warning state for severity types.
	Warning SeverityTypes = "Warning"
)

type State 

type State string

State enumerates the values for state. 

const (
	// StateAccepted specifies the state accepted state for state.
	StateAccepted State = "Accepted"
	// StateCompiling specifies the state compiling state for state.
	StateCompiling State = "Compiling"
	// StateEnded specifies the state ended state for state.
	StateEnded State = "Ended"
	// StateNew specifies the state new state for state.
	StateNew State = "New"
	// StatePaused specifies the state paused state for state.
	StatePaused State = "Paused"
	// StateQueued specifies the state queued state for state.
	StateQueued State = "Queued"
	// StateRunning specifies the state running state for state.
	StateRunning State = "Running"
	// StateScheduling specifies the state scheduling state for state.
	StateScheduling State = "Scheduling"
	// StateStarting specifies the state starting state for state.
	StateStarting State = "Starting"
	// StateWaitingForCapacity specifies the state waiting for capacity state for state.
	StateWaitingForCapacity State = "WaitingForCapacity"
)

type StateAuditRecord 

type StateAuditRecord struct {
	NewState        *string    `json:"newState,omitempty"`
	TimeStamp       *date.Time `json:"timeStamp,omitempty"`
	RequestedByUser *string    `json:"requestedByUser,omitempty"`
	Details         *string    `json:"details,omitempty"`
}

StateAuditRecord is the Data Lake Analytics job state audit records for tracking the lifecycle of a job.

type Statistics 

type Statistics struct {
	autorest.Response `json:"-"`
	LastUpdateTimeUtc *date.Time               `json:"lastUpdateTimeUtc,omitempty"`
	FinalizingTimeUtc *date.Time               `json:"finalizingTimeUtc,omitempty"`
	Stages            *[]StatisticsVertexStage `json:"stages,omitempty"`
}

Statistics is the Data Lake Analytics job execution statistics.

type StatisticsVertex 

type StatisticsVertex struct {
	Name          *string    `json:"name,omitempty"`
	VertexID      *uuid.UUID `json:"vertexId,omitempty"`
	ExecutionTime *string    `json:"executionTime,omitempty"`
	DataRead      *int64     `json:"dataRead,omitempty"`
	PeakMemUsage  *int64     `json:"peakMemUsage,omitempty"`
}

StatisticsVertex is the detailed information for a vertex.

type StatisticsVertexStage 

type StatisticsVertexStage struct {
	DataRead                        *int64                   `json:"dataRead,omitempty"`
	DataReadCrossPod                *int64                   `json:"dataReadCrossPod,omitempty"`
	DataReadIntraPod                *int64                   `json:"dataReadIntraPod,omitempty"`
	DataToRead                      *int64                   `json:"dataToRead,omitempty"`
	DataWritten                     *int64                   `json:"dataWritten,omitempty"`
	DuplicateDiscardCount           *int32                   `json:"duplicateDiscardCount,omitempty"`
	FailedCount                     *int32                   `json:"failedCount,omitempty"`
	MaxVertexDataRead               *int64                   `json:"maxVertexDataRead,omitempty"`
	MinVertexDataRead               *int64                   `json:"minVertexDataRead,omitempty"`
	ReadFailureCount                *int32                   `json:"readFailureCount,omitempty"`
	RevocationCount                 *int32                   `json:"revocationCount,omitempty"`
	RunningCount                    *int32                   `json:"runningCount,omitempty"`
	ScheduledCount                  *int32                   `json:"scheduledCount,omitempty"`
	StageName                       *string                  `json:"stageName,omitempty"`
	SucceededCount                  *int32                   `json:"succeededCount,omitempty"`
	TempDataWritten                 *int64                   `json:"tempDataWritten,omitempty"`
	TotalCount                      *int32                   `json:"totalCount,omitempty"`
	TotalFailedTime                 *string                  `json:"totalFailedTime,omitempty"`
	TotalProgress                   *int32                   `json:"totalProgress,omitempty"`
	TotalSucceededTime              *string                  `json:"totalSucceededTime,omitempty"`
	TotalPeakMemUsage               *int64                   `json:"totalPeakMemUsage,omitempty"`
	TotalExecutionTime              *string                  `json:"totalExecutionTime,omitempty"`
	MaxDataReadVertex               *StatisticsVertex        `json:"maxDataReadVertex,omitempty"`
	MaxExecutionTimeVertex          *StatisticsVertex        `json:"maxExecutionTimeVertex,omitempty"`
	MaxPeakMemUsageVertex           *StatisticsVertex        `json:"maxPeakMemUsageVertex,omitempty"`
	EstimatedVertexCPUCoreCount     *int32                   `json:"estimatedVertexCpuCoreCount,omitempty"`
	EstimatedVertexPeakCPUCoreCount *int32                   `json:"estimatedVertexPeakCpuCoreCount,omitempty"`
	EstimatedVertexMemSize          *int64                   `json:"estimatedVertexMemSize,omitempty"`
	AllocatedContainerCPUCoreCount  *ResourceUsageStatistics `json:"allocatedContainerCpuCoreCount,omitempty"`
	AllocatedContainerMemSize       *ResourceUsageStatistics `json:"allocatedContainerMemSize,omitempty"`
	UsedVertexCPUCoreCount          *ResourceUsageStatistics `json:"usedVertexCpuCoreCount,omitempty"`
	UsedVertexPeakMemSize           *ResourceUsageStatistics `json:"usedVertexPeakMemSize,omitempty"`
}

StatisticsVertexStage is the Data Lake Analytics job statistics vertex stage information.

type Type 

type Type string

Type enumerates the values for type. 

const (
	// Hive specifies the hive state for type.
	Hive Type = "Hive"
	// Scope specifies the scope state for type.
	Scope Type = "Scope"
	// USQL specifies the usql state for type.
	USQL Type = "USql"
)

type USQLJobProperties 

type USQLJobProperties struct {
	RuntimeVersion           *string        `json:"runtimeVersion,omitempty"`
	Script                   *string        `json:"script,omitempty"`
	Type                     Type           `json:"type,omitempty"`
	Resources                *[]Resource    `json:"resources,omitempty"`
	Statistics               *Statistics    `json:"statistics,omitempty"`
	DebugData                *DataPath      `json:"debugData,omitempty"`
	Diagnostics              *[]Diagnostics `json:"diagnostics,omitempty"`
	AlgebraFilePath          *string        `json:"algebraFilePath,omitempty"`
	TotalCompilationTime     *string        `json:"totalCompilationTime,omitempty"`
	TotalPausedTime          *string        `json:"totalPausedTime,omitempty"`
	TotalQueuedTime          *string        `json:"totalQueuedTime,omitempty"`
	TotalRunningTime         *string        `json:"totalRunningTime,omitempty"`
	RootProcessNodeID        *string        `json:"rootProcessNodeId,omitempty"`
	YarnApplicationID        *string        `json:"yarnApplicationId,omitempty"`
	YarnApplicationTimeStamp *int64         `json:"yarnApplicationTimeStamp,omitempty"`
	CompileMode              CompileMode    `json:"compileMode,omitempty"`
}

USQLJobProperties is u-SQL job properties used when retrieving U-SQL jobs.

func (USQLJobProperties) AsHiveJobProperties 

func (usjp USQLJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)

AsHiveJobProperties is the Properties implementation for USQLJobProperties.

func (USQLJobProperties) AsScopeJobProperties 

func (usjp USQLJobProperties) AsScopeJobProperties() (*ScopeJobProperties, bool)

AsScopeJobProperties is the Properties implementation for USQLJobProperties.

func (USQLJobProperties) AsUSQLJobProperties 

func (usjp USQLJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)

AsUSQLJobProperties is the Properties implementation for USQLJobProperties.

func (USQLJobProperties) MarshalJSON 

func (usjp USQLJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for USQLJobProperties.

type UpdateJobParameters 

type UpdateJobParameters struct {
	DegreeOfParallelism *int32              `json:"degreeOfParallelism,omitempty"`
	Priority            *int32              `json:"priority,omitempty"`
	Tags                *map[string]*string `json:"tags,omitempty"`
}

UpdateJobParameters is the parameters that can be used to update existing Data Lake Analytics job information properties. (Only for use internally with Scope job type.)

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.