const (
// DefaultAdlaJobDNSSuffix is the default value for adla job dns suffix
DefaultAdlaJobDNSSuffix = "azuredatalakeanalytics.net"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Job.
type BaseClient struct {
autorest.Client
AdlaJobDNSSuffix string
}
func New() BaseClient
New creates an instance of the BaseClient client.
func NewWithoutDefaults(adlaJobDNSSuffix string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
BasicProperties the common Data Lake Analytics job properties.
type BasicProperties interface {
AsUSQLJobProperties() (*USQLJobProperties, bool)
AsHiveJobProperties() (*HiveJobProperties, bool)
AsProperties() (*Properties, bool)
}
Client is the creates an Azure Data Lake Analytics job client.
type Client struct {
BaseClient
}
func NewClient() Client
NewClient creates an instance of the Client client.
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 Client) BuildPreparer(ctx context.Context, accountName string, parameters Information) (*http.Request, error)
BuildPreparer prepares the Build request.
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 Client) 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 (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 Client) CancelPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (client Client) 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 (client Client) 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 (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 Client) CreatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters Information) (*http.Request, error)
CreatePreparer prepares the Create request.
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 Client) 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 (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 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 Client) GetDebugDataPathPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetDebugDataPathPreparer prepares the GetDebugDataPath request.
func (client Client) 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 (client Client) 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 (client Client) GetPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
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 Client) 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 (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 Client) GetStatisticsPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)
GetStatisticsPreparer prepares the GetStatistics request.
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 Client) 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 (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 format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional.
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 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 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.
func (client Client) 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.
CompileMode enumerates the values for compile mode.
type CompileMode string
const (
// Full ...
Full CompileMode = "Full"
// Semantic ...
Semantic CompileMode = "Semantic"
// SingleBox ...
SingleBox CompileMode = "SingleBox"
)
func PossibleCompileModeValues() []CompileMode
PossibleCompileModeValues returns an array of possible values for the CompileMode const type.
DataPath a Data Lake Analytics U-SQL job data path item.
type DataPath struct {
autorest.Response `json:"-"`
// JobID - READ-ONLY; Gets the id of the job this data is for.
JobID *uuid.UUID `json:"jobId,omitempty"`
// Command - READ-ONLY; Gets the command that this job data relates to.
Command *string `json:"command,omitempty"`
// Paths - READ-ONLY; Gets the list of paths to all of the job data.
Paths *[]string `json:"paths,omitempty"`
}
func (dp DataPath) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataPath.
ErrorDetails the Data Lake Analytics job error details.
type ErrorDetails struct {
// Description - READ-ONLY; Gets the error message description
Description *string `json:"description,omitempty"`
// Details - READ-ONLY; Gets the details of the error message.
Details *string `json:"details,omitempty"`
// EndOffset - READ-ONLY; Gets the end offset in the job where the error was found.
EndOffset *int32 `json:"endOffset,omitempty"`
// ErrorID - READ-ONLY; Gets the specific identifier for the type of error encountered in the job.
ErrorID *string `json:"errorId,omitempty"`
// FilePath - READ-ONLY; Gets the path to any supplemental error files, if any.
FilePath *string `json:"filePath,omitempty"`
// HelpLink - READ-ONLY; Gets the link to MSDN or Azure help for this type of error, if any.
HelpLink *string `json:"helpLink,omitempty"`
// InternalDiagnostics - READ-ONLY; 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 - READ-ONLY; Gets the specific line number in the job where the error occurred.
LineNumber *int32 `json:"lineNumber,omitempty"`
// Message - READ-ONLY; Gets the user friendly error message for the failure.
Message *string `json:"message,omitempty"`
// Resolution - READ-ONLY; Gets the recommended resolution for the failure, if any.
Resolution *string `json:"resolution,omitempty"`
// InnerError - READ-ONLY; Gets the inner error of this specific job error message, if any.
InnerError *InnerError `json:"InnerError,omitempty"`
// Severity - READ-ONLY; Gets the severity level of the failure. Possible values include: 'Warning', 'Error'
Severity SeverityTypes `json:"severity,omitempty"`
// Source - READ-ONLY; Gets the ultimate source of the failure (usually either SYSTEM or USER).
Source *string `json:"source,omitempty"`
// StartOffset - READ-ONLY; Gets the start offset in the job where the error was found
StartOffset *int32 `json:"startOffset,omitempty"`
}
func (ed ErrorDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetails.
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"`
}
func (hjp HiveJobProperties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HiveJobProperties.
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"`
}
InfoListResult list of jobInfo items.
type InfoListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Gets the list of jobInfo items.
Value *[]Information `json:"value,omitempty"`
// NextLink - READ-ONLY; Gets the link (url) to the next page of results.
NextLink *string `json:"nextLink,omitempty"`
// Count - READ-ONLY; Gets the total count of results that are available, but might not be returned in the current page.
Count *int64 `json:"count,omitempty"`
}
func (ilr InfoListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ilr InfoListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InfoListResult.
InfoListResultIterator provides access to a complete listing of Information values.
type InfoListResultIterator struct {
// contains filtered or unexported fields
}
func NewInfoListResultIterator(page InfoListResultPage) InfoListResultIterator
Creates a new instance of the InfoListResultIterator type.
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 (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 (iter InfoListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter InfoListResultIterator) Response() InfoListResult
Response returns the raw server response from the last page request.
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.
InfoListResultPage contains a page of Information values.
type InfoListResultPage struct {
// contains filtered or unexported fields
}
func NewInfoListResultPage(cur InfoListResult, getNextPage func(context.Context, InfoListResult) (InfoListResult, error)) InfoListResultPage
Creates a new instance of the InfoListResultPage type.
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 (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 (page InfoListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page InfoListResultPage) Response() InfoListResult
Response returns the raw server response from the last page request.
func (page InfoListResultPage) Values() []Information
Values returns the slice of values for the current page or nil if there are no values.
Information the common Data Lake Analytics job information properties.
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 - READ-ONLY; 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 - READ-ONLY; Gets the time the job was submitted to the service.
SubmitTime *date.Time `json:"submitTime,omitempty"`
// StartTime - READ-ONLY; Gets the start time of the job.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; Gets the completion time of the job.
EndTime *date.Time `json:"endTime,omitempty"`
// State - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; Gets the job state audit records, indicating when various operations have been performed on this job.
StateAuditRecords *[]StateAuditRecord `json:"stateAuditRecords,omitempty"`
// HierarchyQueueNode - READ-ONLY; 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"`
}
func (i Information) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Information.
func (i *Information) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Information struct.
InnerError the Data Lake Analytics job error details.
type InnerError struct {
// DiagnosticCode - READ-ONLY; Gets the diagnostic error code.
DiagnosticCode *int32 `json:"diagnosticCode,omitempty"`
// Severity - READ-ONLY; Gets the severity level of the failure. Possible values include: 'Warning', 'Error'
Severity SeverityTypes `json:"severity,omitempty"`
// Details - READ-ONLY; Gets the details of the error message.
Details *string `json:"details,omitempty"`
// Component - READ-ONLY; Gets the component that failed.
Component *string `json:"component,omitempty"`
// ErrorID - READ-ONLY; Gets the specific identifier for the type of error encountered in the job.
ErrorID *string `json:"errorId,omitempty"`
// HelpLink - READ-ONLY; Gets the link to MSDN or Azure help for this type of error, if any.
HelpLink *string `json:"helpLink,omitempty"`
// InternalDiagnostics - READ-ONLY; 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 - READ-ONLY; Gets the user friendly error message for the failure.
Message *string `json:"message,omitempty"`
// Resolution - READ-ONLY; Gets the recommended resolution for the failure, if any.
Resolution *string `json:"resolution,omitempty"`
// Source - READ-ONLY; Gets the ultimate source of the failure (usually either SYSTEM or USER).
Source *string `json:"source,omitempty"`
// Description - READ-ONLY; Gets the error message description
Description *string `json:"description,omitempty"`
}
func (ie InnerError) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InnerError.
Properties the common Data Lake Analytics job 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"`
}
func (p Properties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for Properties.
func (p Properties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for Properties.
func (p Properties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for Properties.
func (p Properties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for Properties.
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
Resource the Data Lake Analytics U-SQL job resources.
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"`
}
ResourceType enumerates the values for resource type.
type ResourceType string
const (
// StatisticsResource ...
StatisticsResource ResourceType = "StatisticsResource"
// VertexResource ...
VertexResource ResourceType = "VertexResource"
)
func PossibleResourceTypeValues() []ResourceType
PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.
Result enumerates the values for result.
type Result string
const (
// Cancelled ...
Cancelled Result = "Cancelled"
// Failed ...
Failed Result = "Failed"
// None ...
None Result = "None"
// Succeeded ...
Succeeded Result = "Succeeded"
)
func PossibleResultValues() []Result
PossibleResultValues returns an array of possible values for the Result const type.
SeverityTypes enumerates the values for severity types.
type SeverityTypes string
const (
// Error ...
Error SeverityTypes = "Error"
// Warning ...
Warning SeverityTypes = "Warning"
)
func PossibleSeverityTypesValues() []SeverityTypes
PossibleSeverityTypesValues returns an array of possible values for the SeverityTypes const type.
State enumerates the values for state.
type State string
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() []State
PossibleStateValues returns an array of possible values for the State const type.
StateAuditRecord the Data Lake Analytics U-SQL job state audit records for tracking the lifecycle of a job.
type StateAuditRecord struct {
// NewState - READ-ONLY; Gets the new state the job is in.
NewState *string `json:"newState,omitempty"`
// TimeStamp - READ-ONLY; Gets the time stamp that the state change took place.
TimeStamp *date.Time `json:"timeStamp,omitempty"`
// RequestedByUser - READ-ONLY; Gets the user who requests the change.
RequestedByUser *string `json:"requestedByUser,omitempty"`
// Details - READ-ONLY; Gets the details of the audit log.
Details *string `json:"details,omitempty"`
}
func (sar StateAuditRecord) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for StateAuditRecord.
Statistics the Data Lake Analytics U-SQL job execution statistics.
type Statistics struct {
autorest.Response `json:"-"`
// LastUpdateTimeUtc - READ-ONLY; Gets the last update time for the statistics.
LastUpdateTimeUtc *date.Time `json:"lastUpdateTimeUtc,omitempty"`
// Stages - READ-ONLY; Gets the list of stages for the job.
Stages *[]StatisticsVertexStage `json:"stages,omitempty"`
}
func (s Statistics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Statistics.
StatisticsVertexStage the Data Lake Analytics U-SQL job statistics vertex stage information.
type StatisticsVertexStage struct {
// DataRead - READ-ONLY; Gets the amount of data read, in bytes.
DataRead *int64 `json:"dataRead,omitempty"`
// DataReadCrossPod - READ-ONLY; Gets the amount of data read across multiple pods, in bytes.
DataReadCrossPod *int64 `json:"dataReadCrossPod,omitempty"`
// DataReadIntraPod - READ-ONLY; Gets the amount of data read in one pod, in bytes.
DataReadIntraPod *int64 `json:"dataReadIntraPod,omitempty"`
// DataToRead - READ-ONLY; Gets the amount of data remaining to be read, in bytes.
DataToRead *int64 `json:"dataToRead,omitempty"`
// DataWritten - READ-ONLY; Gets the amount of data written, in bytes.
DataWritten *int64 `json:"dataWritten,omitempty"`
// DuplicateDiscardCount - READ-ONLY; Gets the number of duplicates that were discarded.
DuplicateDiscardCount *int32 `json:"duplicateDiscardCount,omitempty"`
// FailedCount - READ-ONLY; Gets the number of failures that occurred in this stage.
FailedCount *int32 `json:"failedCount,omitempty"`
// MaxVertexDataRead - READ-ONLY; Gets the maximum amount of data read in a single vertex, in bytes.
MaxVertexDataRead *int64 `json:"maxVertexDataRead,omitempty"`
// MinVertexDataRead - READ-ONLY; Gets the minimum amount of data read in a single vertex, in bytes.
MinVertexDataRead *int64 `json:"minVertexDataRead,omitempty"`
// ReadFailureCount - READ-ONLY; Gets the number of read failures in this stage.
ReadFailureCount *int32 `json:"readFailureCount,omitempty"`
// RevocationCount - READ-ONLY; Gets the number of vertices that were revoked during this stage.
RevocationCount *int32 `json:"revocationCount,omitempty"`
// RunningCount - READ-ONLY; Gets the number of currently running vertices in this stage.
RunningCount *int32 `json:"runningCount,omitempty"`
// ScheduledCount - READ-ONLY; Gets the number of currently scheduled vertices in this stage
ScheduledCount *int32 `json:"scheduledCount,omitempty"`
// StageName - READ-ONLY; Gets the name of this stage in job execution.
StageName *string `json:"stageName,omitempty"`
// SucceededCount - READ-ONLY; Gets the number of vertices that succeeded in this stage.
SucceededCount *int32 `json:"succeededCount,omitempty"`
// TempDataWritten - READ-ONLY; Gets the amount of temporary data written, in bytes.
TempDataWritten *int64 `json:"tempDataWritten,omitempty"`
// TotalCount - READ-ONLY; Gets the total vertex count for this stage.
TotalCount *int32 `json:"totalCount,omitempty"`
// TotalFailedTime - READ-ONLY; Gets the amount of time that failed vertices took up in this stage.
TotalFailedTime *string `json:"totalFailedTime,omitempty"`
// TotalProgress - READ-ONLY; Gets the current progress of this stage, as a percentage.
TotalProgress *int32 `json:"totalProgress,omitempty"`
// TotalSucceededTime - READ-ONLY; Gets the amount of time all successful vertices took in this stage.
TotalSucceededTime *string `json:"totalSucceededTime,omitempty"`
}
func (svs StatisticsVertexStage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for StatisticsVertexStage.
Type enumerates the values for type.
type Type string
const (
// TypeHive ...
TypeHive Type = "Hive"
// TypeJobProperties ...
TypeJobProperties Type = "JobProperties"
// TypeUSQL ...
TypeUSQL Type = "USql"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
TypeEnum enumerates the values for type enum.
type TypeEnum string
const (
// Hive ...
Hive TypeEnum = "Hive"
// USQL ...
USQL TypeEnum = "USql"
)
func PossibleTypeEnumValues() []TypeEnum
PossibleTypeEnumValues returns an array of possible values for the TypeEnum const 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 - READ-ONLY; Gets the U-SQL algebra file path after the job has completed
AlgebraFilePath *string `json:"algebraFilePath,omitempty"`
// TotalCompilationTime - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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"`
}
func (usjp USQLJobProperties) AsBasicProperties() (BasicProperties, bool)
AsBasicProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool)
AsHiveJobProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsProperties() (*Properties, bool)
AsProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool)
AsUSQLJobProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for USQLJobProperties.