Documentation ¶
Overview ¶
Package job implements the Azure ARM Job service API version 2015-11-01-preview.
Creates an Azure Data Lake Analytics job client.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type BasicProperties
- type Client
- func (client Client) Build(ctx context.Context, accountName string, parameters Information) (result Information, err error)
- func (client Client) BuildPreparer(ctx context.Context, accountName string, parameters Information) (*http.Request, error)
- func (client Client) BuildResponder(resp *http.Response) (result Information, err error)
- func (client Client) BuildSender(req *http.Request) (*http.Response, error)
- func (client Client) Cancel(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result autorest.Response, err error)
- func (client Client) CancelPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
- func (client Client) CancelResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) CancelSender(req *http.Request) (*http.Response, error)
- func (client Client) Create(ctx context.Context, accountName string, jobIdentity uuid.UUID, ...) (result Information, err error)
- func (client Client) CreatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, ...) (*http.Request, error)
- func (client Client) CreateResponder(resp *http.Response) (result Information, err error)
- func (client Client) CreateSender(req *http.Request) (*http.Response, error)
- func (client Client) Get(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result Information, err error)
- func (client Client) GetDebugDataPath(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result DataPath, err error)
- func (client Client) GetDebugDataPathPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
- func (client Client) GetDebugDataPathResponder(resp *http.Response) (result DataPath, err error)
- func (client Client) GetDebugDataPathSender(req *http.Request) (*http.Response, error)
- func (client Client) GetPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result Information, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) GetStatistics(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result Statistics, err error)
- func (client Client) GetStatisticsPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
- func (client Client) GetStatisticsResponder(resp *http.Response) (result Statistics, err error)
- func (client Client) GetStatisticsSender(req *http.Request) (*http.Response, error)
- func (client Client) List(ctx context.Context, accountName string, filter string, top *int32, ...) (result InfoListResultPage, err error)
- func (client Client) ListComplete(ctx context.Context, accountName string, filter string, top *int32, ...) (result InfoListResultIterator, err error)
- func (client Client) ListPreparer(ctx context.Context, accountName string, filter string, top *int32, ...) (*http.Request, error)
- func (client Client) ListResponder(resp *http.Response) (result InfoListResult, err error)
- func (client Client) ListSender(req *http.Request) (*http.Response, error)
- type CompileMode
- type DataPath
- type ErrorDetails
- type HiveJobProperties
- func (hjp HiveJobProperties) AsBasicProperties() (BasicProperties, bool)
- func (hjp HiveJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
- func (hjp HiveJobProperties) AsProperties() (*Properties, bool)
- func (hjp HiveJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
- func (hjp HiveJobProperties) MarshalJSON() ([]byte, error)
- type HiveJobStatementInfo
- type InfoListResult
- type InfoListResultIterator
- type InfoListResultPage
- type Information
- type InnerError
- type Properties
- func (p Properties) AsBasicProperties() (BasicProperties, bool)
- func (p Properties) AsHiveJobProperties() (*HiveJobProperties, bool)
- func (p Properties) AsProperties() (*Properties, bool)
- func (p Properties) AsUSQLJobProperties() (*USQLJobProperties, bool)
- func (p Properties) MarshalJSON() ([]byte, error)
- type Resource
- type ResourceType
- type Result
- type SeverityTypes
- type State
- type StateAuditRecord
- type Statistics
- type StatisticsVertexStage
- type Type
- type TypeEnum
- type USQLJobProperties
- func (usjp USQLJobProperties) AsBasicProperties() (BasicProperties, bool)
- func (usjp USQLJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
- func (usjp USQLJobProperties) AsProperties() (*Properties, bool)
- func (usjp USQLJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
- func (usjp USQLJobProperties) MarshalJSON() ([]byte, error)
Constants ¶
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 BaseClient ¶
BaseClient is the base client for Job.
func NewWithoutDefaults ¶
func NewWithoutDefaults(adlaJobDNSSuffix string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
type BasicProperties ¶
type BasicProperties interface { AsUSQLJobProperties() (*USQLJobProperties, bool) AsHiveJobProperties() (*HiveJobProperties, bool) AsProperties() (*Properties, bool) }
BasicProperties the common Data Lake Analytics job properties.
type Client ¶
type Client struct {
BaseClient
}
Client is the creates an Azure Data Lake Analytics job client.
func (Client) Build ¶
func (client Client) Build(ctx context.Context, accountName string, parameters Information) (result Information, err error)
Build builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. parameters - the parameters to build a job.
func (Client) BuildPreparer ¶
func (client Client) BuildPreparer(ctx context.Context, accountName string, parameters Information) (*http.Request, error)
BuildPreparer prepares the Build request.
func (Client) BuildResponder ¶
func (client Client) 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 (Client) BuildSender ¶
BuildSender sends the Build request. The method will close the http.Response Body if it receives an error.
func (Client) Cancel ¶
func (client Client) Cancel(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result autorest.Response, err error)
Cancel cancels the running job specified by the job ID. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - jobInfo ID to cancel.
func (Client) CancelPreparer ¶
func (client Client) CancelPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (Client) CancelResponder ¶
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (Client) CancelSender ¶
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (Client) Create ¶
func (client Client) Create(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters Information) (result Information, err error)
Create submits a job to the specified Data Lake Analytics account. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - the job ID (a GUID) for the job being submitted. parameters - the parameters to submit a job.
func (Client) CreatePreparer ¶
func (client Client) CreatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters Information) (*http.Request, error)
CreatePreparer prepares the Create request.
func (Client) CreateResponder ¶
func (client Client) 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 (Client) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (Client) Get ¶
func (client Client) Get(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result Information, err error)
Get gets the job information for the specified job ID. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - jobInfo ID.
func (Client) GetDebugDataPath ¶
func (client Client) GetDebugDataPath(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result DataPath, err error)
GetDebugDataPath gets the U-SQL job debug data information specified by the job ID. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - jobInfo ID.
func (Client) GetDebugDataPathPreparer ¶
func (client Client) GetDebugDataPathPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetDebugDataPathPreparer prepares the GetDebugDataPath request.
func (Client) GetDebugDataPathResponder ¶
GetDebugDataPathResponder handles the response to the GetDebugDataPath request. The method always closes the http.Response Body.
func (Client) GetDebugDataPathSender ¶
GetDebugDataPathSender sends the GetDebugDataPath request. The method will close the http.Response Body if it receives an error.
func (Client) GetPreparer ¶
func (client Client) GetPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
func (Client) GetResponder ¶
func (client Client) 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 (Client) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (Client) GetStatistics ¶
func (client Client) GetStatistics(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result Statistics, err error)
GetStatistics gets statistics of the specified job. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - jobInfo ID.
func (Client) GetStatisticsPreparer ¶
func (client Client) GetStatisticsPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetStatisticsPreparer prepares the GetStatistics request.
func (Client) GetStatisticsResponder ¶
func (client Client) 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 (Client) GetStatisticsSender ¶
GetStatisticsSender sends the GetStatistics request. The method will close the http.Response Body if it receives an error.
func (Client) List ¶
func (client Client) List(ctx context.Context, accountName string, filter string, top *int32, skip *int32, expand string, selectParameter string, orderby string, count *bool, search string, formatParameter string) (result InfoListResultPage, 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. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. filter - oData filter. Optional. top - the number of items to return. Optional. skip - the number of items to skip over before returning elements. Optional. expand - oData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional. selectParameter - oData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. orderby - 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 - 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. search - a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional. formatParameter - the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional.
func (Client) ListComplete ¶
func (client Client) ListComplete(ctx context.Context, accountName string, filter string, top *int32, skip *int32, expand string, selectParameter string, orderby string, count *bool, search string, formatParameter string) (result InfoListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (Client) ListPreparer ¶
func (client Client) ListPreparer(ctx context.Context, accountName string, filter string, top *int32, skip *int32, expand string, selectParameter string, orderby string, count *bool, search string, formatParameter string) (*http.Request, error)
ListPreparer prepares the List request.
func (Client) ListResponder ¶
func (client Client) ListResponder(resp *http.Response) (result InfoListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
type CompileMode ¶
type CompileMode string
CompileMode enumerates the values for compile mode.
const ( // Full ... Full CompileMode = "Full" // Semantic ... Semantic CompileMode = "Semantic" // SingleBox ... SingleBox CompileMode = "SingleBox" )
func PossibleCompileModeValues ¶
func PossibleCompileModeValues() []CompileMode
PossibleCompileModeValues returns an array of possible values for the CompileMode const type.
type DataPath ¶
type DataPath struct { autorest.Response `json:"-"` // JobID - Gets the id of the job this data is for. JobID *uuid.UUID `json:"jobId,omitempty"` // Command - Gets the command that this job data relates to. Command *string `json:"command,omitempty"` // Paths - Gets the list of paths to all of the job data. Paths *[]string `json:"paths,omitempty"` }
DataPath a Data Lake Analytics U-SQL job data path item.
type ErrorDetails ¶
type ErrorDetails struct { // Description - Gets the error message description Description *string `json:"description,omitempty"` // Details - Gets the details of the error message. Details *string `json:"details,omitempty"` // EndOffset - Gets the end offset in the job where the error was found. EndOffset *int32 `json:"endOffset,omitempty"` // ErrorID - Gets the specific identifier for the type of error encountered in the job. ErrorID *string `json:"errorId,omitempty"` // FilePath - Gets the path to any supplemental error files, if any. FilePath *string `json:"filePath,omitempty"` // HelpLink - Gets the link to MSDN or Azure help for this type of error, if any. HelpLink *string `json:"helpLink,omitempty"` // InternalDiagnostics - Gets the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty. InternalDiagnostics *string `json:"internalDiagnostics,omitempty"` // LineNumber - Gets the specific line number in the job where the error occured. LineNumber *int32 `json:"lineNumber,omitempty"` // Message - Gets the user friendly error message for the failure. Message *string `json:"message,omitempty"` // Resolution - Gets the recommended resolution for the failure, if any. Resolution *string `json:"resolution,omitempty"` // InnerError - Gets the inner error of this specific job error message, if any. InnerError *InnerError `json:"InnerError,omitempty"` // Severity - Gets the severity level of the failure. Possible values include: 'Warning', 'Error' Severity SeverityTypes `json:"severity,omitempty"` // Source - Gets the ultimate source of the failure (usually either SYSTEM or USER). Source *string `json:"source,omitempty"` // StartOffset - Gets the start offset in the job where the error was found StartOffset *int32 `json:"startOffset,omitempty"` }
ErrorDetails the Data Lake Analytics job error details.
type HiveJobProperties ¶
type HiveJobProperties struct { // StatementInfo - Gets or sets the statement information for each statement in the script StatementInfo *[]HiveJobStatementInfo `json:"statementInfo,omitempty"` // LogsLocation - Gets or sets the Hive logs location LogsLocation *string `json:"logsLocation,omitempty"` // WarehouseLocation - Gets or sets the runtime version of the U-SQL engine to use WarehouseLocation *string `json:"warehouseLocation,omitempty"` // StatementCount - Gets or sets the number of statements that will be run based on the script StatementCount *int32 `json:"statementCount,omitempty"` // ExecutedStatementCount - Gets or sets the number of statements that have been run based on the script ExecutedStatementCount *int32 `json:"executedStatementCount,omitempty"` // RuntimeVersion - Gets or sets the runtime version of the U-SQL engine to use RuntimeVersion *string `json:"runtimeVersion,omitempty"` // Script - Gets or sets the U-SQL script to run Script *string `json:"script,omitempty"` // Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive' Type Type `json:"type,omitempty"` }
HiveJobProperties ...
func (HiveJobProperties) AsBasicProperties ¶
func (hjp HiveJobProperties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for HiveJobProperties.
func (HiveJobProperties) AsHiveJobProperties ¶
func (hjp HiveJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for HiveJobProperties.
func (HiveJobProperties) AsProperties ¶
func (hjp HiveJobProperties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for HiveJobProperties.
func (HiveJobProperties) AsUSQLJobProperties ¶
func (hjp HiveJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for HiveJobProperties.
func (HiveJobProperties) MarshalJSON ¶
func (hjp HiveJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HiveJobProperties.
type HiveJobStatementInfo ¶
type HiveJobStatementInfo struct { // LogLocation - Gets or sets the log location for this statement. LogLocation *string `json:"logLocation,omitempty"` // ResultPreviewLocation - Gets or sets the result preview location for this statement. ResultPreviewLocation *string `json:"resultPreviewLocation,omitempty"` // ResultLocation - Gets or sets the result location for this statement. ResultLocation *string `json:"resultLocation,omitempty"` // ErrorMessage - Gets or sets the error message for this statement. ErrorMessage *string `json:"errorMessage,omitempty"` }
HiveJobStatementInfo ...
type InfoListResult ¶
type InfoListResult struct { autorest.Response `json:"-"` // Value - Gets the list of jobInfo items. Value *[]Information `json:"value,omitempty"` // NextLink - Gets the link (url) to the next page of results. NextLink *string `json:"nextLink,omitempty"` // Count - Gets the total count of results that are available, but might not be returned in the current page. Count *int64 `json:"count,omitempty"` }
InfoListResult list of jobInfo items.
func (InfoListResult) IsEmpty ¶
func (ilr InfoListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type InfoListResultIterator ¶
type InfoListResultIterator struct {
// contains filtered or unexported fields
}
InfoListResultIterator provides access to a complete listing of Information values.
func (*InfoListResultIterator) Next ¶
func (iter *InfoListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (*InfoListResultIterator) NextWithContext ¶
func (iter *InfoListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (InfoListResultIterator) NotDone ¶
func (iter InfoListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (InfoListResultIterator) Response ¶
func (iter InfoListResultIterator) Response() InfoListResult
Response returns the raw server response from the last page request.
func (InfoListResultIterator) Value ¶
func (iter InfoListResultIterator) Value() Information
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type InfoListResultPage ¶
type InfoListResultPage struct {
// contains filtered or unexported fields
}
InfoListResultPage contains a page of Information values.
func (*InfoListResultPage) Next ¶
func (page *InfoListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (*InfoListResultPage) NextWithContext ¶
func (page *InfoListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (InfoListResultPage) NotDone ¶
func (page InfoListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (InfoListResultPage) Response ¶
func (page InfoListResultPage) Response() InfoListResult
Response returns the raw server response from the last page request.
func (InfoListResultPage) Values ¶
func (page InfoListResultPage) Values() []Information
Values returns the slice of values for the current page or nil if there are no values.
type Information ¶
type Information struct { autorest.Response `json:"-"` // JobID - Gets or sets the job's unique identifier (a GUID). JobID *uuid.UUID `json:"jobId,omitempty"` // Name - Gets or sets the friendly name of the job. Name *string `json:"name,omitempty"` // Type - Gets or sets the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive' Type TypeEnum `json:"type,omitempty"` // Submitter - Gets or sets the user or account that submitted the job. Submitter *string `json:"submitter,omitempty"` // ErrorMessage - Gets the error message details for the job, if the job failed. ErrorMessage *[]ErrorDetails `json:"errorMessage,omitempty"` // DegreeOfParallelism - Gets or sets the degree of parallelism used for this job. This must be greater than 0. DegreeOfParallelism *int32 `json:"degreeOfParallelism,omitempty"` // DegreeOfParallelismPercent - the degree of parallelism in percentage used for this job. DegreeOfParallelismPercent *float64 `json:"degreeOfParallelismPercent,omitempty"` // Priority - Gets or sets the priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0. Priority *int32 `json:"priority,omitempty"` // SubmitTime - Gets the time the job was submitted to the service. SubmitTime *date.Time `json:"submitTime,omitempty"` // StartTime - Gets the start time of the job. StartTime *date.Time `json:"startTime,omitempty"` // EndTime - Gets the completion time of the job. EndTime *date.Time `json:"endTime,omitempty"` // State - Gets the job state. When the job is in the Ended state, refer to Result and ErrorMessage for details. Possible values include: 'StateAccepted', 'StateCompiling', 'StateEnded', 'StateNew', 'StateQueued', 'StateRunning', 'StateScheduling', 'StateStarting', 'StatePaused', 'StateWaitingForCapacity' State State `json:"state,omitempty"` // Result - Gets the result of job execution or the current result of the running job. Possible values include: 'None', 'Succeeded', 'Cancelled', 'Failed' Result Result `json:"result,omitempty"` // StateAuditRecords - Gets the job state audit records, indicating when various operations have been performed on this job. StateAuditRecords *[]StateAuditRecord `json:"stateAuditRecords,omitempty"` // HierarchyQueueNode - the name of hierarchy queue node this job is assigned to, null if job has not been assigned yet or the account doesn't have hierarchy queue. HierarchyQueueNode *string `json:"hierarchyQueueNode,omitempty"` // Properties - Gets or sets the job specific properties. Properties BasicProperties `json:"properties,omitempty"` }
Information the common Data Lake Analytics job information properties.
func (*Information) UnmarshalJSON ¶
func (i *Information) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Information struct.
type InnerError ¶
type InnerError struct { // DiagnosticCode - Gets the diagnostic error code. DiagnosticCode *int32 `json:"diagnosticCode,omitempty"` // Severity - Gets the severity level of the failure. Possible values include: 'Warning', 'Error' Severity SeverityTypes `json:"severity,omitempty"` // Details - Gets the details of the error message. Details *string `json:"details,omitempty"` // Component - Gets the component that failed. Component *string `json:"component,omitempty"` // ErrorID - Gets the specific identifier for the type of error encountered in the job. ErrorID *string `json:"errorId,omitempty"` // HelpLink - Gets the link to MSDN or Azure help for this type of error, if any. HelpLink *string `json:"helpLink,omitempty"` // InternalDiagnostics - Gets the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty. InternalDiagnostics *string `json:"internalDiagnostics,omitempty"` // Message - Gets the user friendly error message for the failure. Message *string `json:"message,omitempty"` // Resolution - Gets the recommended resolution for the failure, if any. Resolution *string `json:"resolution,omitempty"` // Source - Gets the ultimate source of the failure (usually either SYSTEM or USER). Source *string `json:"source,omitempty"` // Description - Gets the error message description Description *string `json:"description,omitempty"` }
InnerError the Data Lake Analytics job error details.
type Properties ¶
type Properties struct { // RuntimeVersion - Gets or sets the runtime version of the U-SQL engine to use RuntimeVersion *string `json:"runtimeVersion,omitempty"` // Script - Gets or sets the U-SQL script to run Script *string `json:"script,omitempty"` // Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive' Type Type `json:"type,omitempty"` }
Properties the common Data Lake Analytics job properties.
func (Properties) AsBasicProperties ¶
func (p Properties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for Properties.
func (Properties) AsHiveJobProperties ¶
func (p Properties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for Properties.
func (Properties) AsProperties ¶
func (p Properties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for Properties.
func (Properties) AsUSQLJobProperties ¶
func (p Properties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for Properties.
func (Properties) MarshalJSON ¶
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
type Resource ¶
type Resource struct { // Name - Gets or set the name of the resource. Name *string `json:"name,omitempty"` // ResourcePath - Gets or sets the path to the resource. ResourcePath *string `json:"resourcePath,omitempty"` // Type - Gets or sets the job resource type. Possible values include: 'VertexResource', 'StatisticsResource' Type ResourceType `json:"type,omitempty"` }
Resource the Data Lake Analytics U-SQL job resources.
type ResourceType ¶
type ResourceType string
ResourceType enumerates the values for resource type.
const ( // StatisticsResource ... StatisticsResource ResourceType = "StatisticsResource" // VertexResource ... VertexResource ResourceType = "VertexResource" )
func PossibleResourceTypeValues ¶
func PossibleResourceTypeValues() []ResourceType
PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.
type Result ¶
type Result string
Result enumerates the values for result.
func PossibleResultValues ¶
func PossibleResultValues() []Result
PossibleResultValues returns an array of possible values for the Result const type.
type SeverityTypes ¶
type SeverityTypes string
SeverityTypes enumerates the values for severity types.
const ( // Error ... Error SeverityTypes = "Error" // Warning ... Warning SeverityTypes = "Warning" )
func PossibleSeverityTypesValues ¶
func PossibleSeverityTypesValues() []SeverityTypes
PossibleSeverityTypesValues returns an array of possible values for the SeverityTypes const type.
type State ¶
type State string
State enumerates the values for state.
const ( // StateAccepted ... StateAccepted State = "Accepted" // StateCompiling ... StateCompiling State = "Compiling" // StateEnded ... StateEnded State = "Ended" // StateNew ... StateNew State = "New" // StatePaused ... StatePaused State = "Paused" // StateQueued ... StateQueued State = "Queued" // StateRunning ... StateRunning State = "Running" // StateScheduling ... StateScheduling State = "Scheduling" // StateStarting ... StateStarting State = "Starting" // StateWaitingForCapacity ... StateWaitingForCapacity State = "WaitingForCapacity" )
func PossibleStateValues ¶
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
type StateAuditRecord ¶
type StateAuditRecord struct { // NewState - Gets the new state the job is in. NewState *string `json:"newState,omitempty"` // TimeStamp - Gets the time stamp that the state change took place. TimeStamp *date.Time `json:"timeStamp,omitempty"` // RequestedByUser - Gets the user who requests the change. RequestedByUser *string `json:"requestedByUser,omitempty"` // Details - Gets the details of the audit log. Details *string `json:"details,omitempty"` }
StateAuditRecord the Data Lake Analytics U-SQL job state audit records for tracking the lifecycle of a job.
type Statistics ¶
type Statistics struct { autorest.Response `json:"-"` // LastUpdateTimeUtc - Gets the last update time for the statistics. LastUpdateTimeUtc *date.Time `json:"lastUpdateTimeUtc,omitempty"` // Stages - Gets the list of stages for the job. Stages *[]StatisticsVertexStage `json:"stages,omitempty"` }
Statistics the Data Lake Analytics U-SQL job execution statistics.
type StatisticsVertexStage ¶
type StatisticsVertexStage struct { // DataRead - Gets the amount of data read, in bytes. DataRead *int64 `json:"dataRead,omitempty"` // DataReadCrossPod - Gets the amount of data read across multiple pods, in bytes. DataReadCrossPod *int64 `json:"dataReadCrossPod,omitempty"` // DataReadIntraPod - Gets the amount of data read in one pod, in bytes. DataReadIntraPod *int64 `json:"dataReadIntraPod,omitempty"` // DataToRead - Gets the amount of data remaining to be read, in bytes. DataToRead *int64 `json:"dataToRead,omitempty"` // DataWritten - Gets the amount of data written, in bytes. DataWritten *int64 `json:"dataWritten,omitempty"` // DuplicateDiscardCount - Gets the number of duplicates that were discarded. DuplicateDiscardCount *int32 `json:"duplicateDiscardCount,omitempty"` // FailedCount - Gets the number of failures that occured in this stage. FailedCount *int32 `json:"failedCount,omitempty"` // MaxVertexDataRead - Gets the maximum amount of data read in a single vertex, in bytes. MaxVertexDataRead *int64 `json:"maxVertexDataRead,omitempty"` // MinVertexDataRead - Gets the minimum amount of data read in a single vertex, in bytes. MinVertexDataRead *int64 `json:"minVertexDataRead,omitempty"` // ReadFailureCount - Gets the number of read failures in this stage. ReadFailureCount *int32 `json:"readFailureCount,omitempty"` // RevocationCount - Gets the number of vertices that were revoked during this stage. RevocationCount *int32 `json:"revocationCount,omitempty"` // RunningCount - Gets the number of currently running vertices in this stage. RunningCount *int32 `json:"runningCount,omitempty"` // ScheduledCount - Gets the number of currently scheduled vertices in this stage ScheduledCount *int32 `json:"scheduledCount,omitempty"` // StageName - Gets the name of this stage in job execution. StageName *string `json:"stageName,omitempty"` // SucceededCount - Gets the number of vertices that succeeded in this stage. SucceededCount *int32 `json:"succeededCount,omitempty"` // TempDataWritten - Gets the amount of temporary data written, in bytes. TempDataWritten *int64 `json:"tempDataWritten,omitempty"` // TotalCount - Gets the total vertex count for this stage. TotalCount *int32 `json:"totalCount,omitempty"` // TotalFailedTime - Gets the amount of time that failed vertices took up in this stage. TotalFailedTime *string `json:"totalFailedTime,omitempty"` // TotalProgress - Gets the current progress of this stage, as a percentage. TotalProgress *int32 `json:"totalProgress,omitempty"` // TotalSucceededTime - Gets the amount of time all successful vertices took in this stage. TotalSucceededTime *string `json:"totalSucceededTime,omitempty"` }
StatisticsVertexStage the Data Lake Analytics U-SQL job statistics vertex stage information.
type Type ¶
type Type string
Type enumerates the values for type.
func PossibleTypeValues ¶
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
type TypeEnum ¶
type TypeEnum string
TypeEnum enumerates the values for type enum.
func PossibleTypeEnumValues ¶
func PossibleTypeEnumValues() []TypeEnum
PossibleTypeEnumValues returns an array of possible values for the TypeEnum const type.
type USQLJobProperties ¶
type USQLJobProperties struct { // Resources - Gets or sets the list of resources that are required by the job Resources *[]Resource `json:"resources,omitempty"` // Statistics - Gets or sets the job specific statistics. Statistics *Statistics `json:"statistics,omitempty"` // DebugData - Gets or sets the job specific debug data locations. DebugData *DataPath `json:"debugData,omitempty"` // AlgebraFilePath - Gets the U-SQL algebra file path after the job has completed AlgebraFilePath *string `json:"algebraFilePath,omitempty"` // TotalCompilationTime - Gets the total time this job spent compiling. This value should not be set by the user and will be ignored if it is. TotalCompilationTime *string `json:"totalCompilationTime,omitempty"` // TotalPauseTime - Gets the total time this job spent paused. This value should not be set by the user and will be ignored if it is. TotalPauseTime *string `json:"totalPauseTime,omitempty"` // TotalQueuedTime - Gets the total time this job spent queued. This value should not be set by the user and will be ignored if it is. TotalQueuedTime *string `json:"totalQueuedTime,omitempty"` // TotalRunningTime - Gets the total time this job spent executing. This value should not be set by the user and will be ignored if it is. TotalRunningTime *string `json:"totalRunningTime,omitempty"` // RootProcessNodeID - Gets the ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is. RootProcessNodeID *string `json:"rootProcessNodeId,omitempty"` // YarnApplicationID - Gets the ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is. YarnApplicationID *string `json:"yarnApplicationId,omitempty"` // YarnApplicationTimeStamp - Gets the timestamp (in ticks) for the yarn application executing the job. This value should not be set by the user and will be ignored if it is. YarnApplicationTimeStamp *int64 `json:"yarnApplicationTimeStamp,omitempty"` // CompileMode - Gets or sets the compile mode for the job. Possible values include: 'Semantic', 'Full', 'SingleBox' CompileMode CompileMode `json:"compileMode,omitempty"` // RuntimeVersion - Gets or sets the runtime version of the U-SQL engine to use RuntimeVersion *string `json:"runtimeVersion,omitempty"` // Script - Gets or sets the U-SQL script to run Script *string `json:"script,omitempty"` // Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive' Type Type `json:"type,omitempty"` }
USQLJobProperties ...
func (USQLJobProperties) AsBasicProperties ¶
func (usjp USQLJobProperties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for USQLJobProperties.
func (USQLJobProperties) AsHiveJobProperties ¶
func (usjp USQLJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for USQLJobProperties.
func (USQLJobProperties) AsProperties ¶
func (usjp USQLJobProperties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for USQLJobProperties.
func (USQLJobProperties) AsUSQLJobProperties ¶
func (usjp USQLJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for USQLJobProperties.
func (USQLJobProperties) MarshalJSON ¶
func (usjp USQLJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for USQLJobProperties.