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.
BaseJobParameters data Lake Analytics Job Parameters base class for build and submit.
type BaseJobParameters struct {
// Type - the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive'
Type TypeEnum `json:"type,omitempty"`
// Properties - the job specific properties.
Properties BasicCreateJobProperties `json:"properties,omitempty"`
}
func (bjp *BaseJobParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BaseJobParameters struct.
BasicCreateJobProperties the common Data Lake Analytics job properties for job submission.
type BasicCreateJobProperties interface {
AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)
AsCreateJobProperties() (*CreateJobProperties, bool)
}
BasicProperties the common Data Lake Analytics job properties.
type BasicProperties interface {
AsUSQLJobProperties() (*USQLJobProperties, bool)
AsHiveJobProperties() (*HiveJobProperties, bool)
AsProperties() (*Properties, bool)
}
BuildJobParameters the parameters used to build a new Data Lake Analytics job.
type BuildJobParameters struct {
// Name - the friendly name of the job to build.
Name *string `json:"name,omitempty"`
// Type - the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive'
Type TypeEnum `json:"type,omitempty"`
// Properties - the job specific properties.
Properties BasicCreateJobProperties `json:"properties,omitempty"`
}
func (bjp *BuildJobParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BuildJobParameters struct.
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 BuildJobParameters) (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 BuildJobParameters) (*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 - job identifier. Uniquely identifies the job across all jobs submitted to the service.
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 CreateJobParameters) (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 - job identifier. Uniquely identifies the job across all jobs submitted to the service. parameters - the parameters to submit a job.
func (client Client) CreatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters CreateJobParameters) (*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 job debug data information specified by the job ID. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - job identifier. Uniquely identifies the job across all jobs submitted to the service.
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 - job Information 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, selectParameter string, orderby string, count *bool) (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. 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.
func (client Client) ListComplete(ctx context.Context, accountName string, filter string, top *int32, skip *int32, selectParameter string, orderby string, count *bool) (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, selectParameter string, orderby string, count *bool) (*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.
CreateJobParameters the parameters used to submit a new Data Lake Analytics job.
type CreateJobParameters struct {
// Name - the friendly name of the job to submit.
Name *string `json:"name,omitempty"`
// DegreeOfParallelism - the degree of parallelism used for this job. At most one of degreeOfParallelism and degreeOfParallelismPercent should be specified. If none, a default value of 1 will be used.
DegreeOfParallelism *int32 `json:"degreeOfParallelism,omitempty"`
// DegreeOfParallelismPercent - the degree of parallelism in percentage used for this job. At most one of degreeOfParallelism and degreeOfParallelismPercent should be specified. If none, a default value of 1 will be used for degreeOfParallelism.
DegreeOfParallelismPercent *float64 `json:"degreeOfParallelismPercent,omitempty"`
// Priority - the priority value to use 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"`
// LogFilePatterns - the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt
LogFilePatterns *[]string `json:"logFilePatterns,omitempty"`
// Related - the recurring job relationship information properties.
Related *RelationshipProperties `json:"related,omitempty"`
// Type - the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive'
Type TypeEnum `json:"type,omitempty"`
// Properties - the job specific properties.
Properties BasicCreateJobProperties `json:"properties,omitempty"`
}
func (cjp *CreateJobParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateJobParameters struct.
CreateJobProperties the common Data Lake Analytics job properties for job submission.
type CreateJobProperties struct {
// RuntimeVersion - the runtime version of the Data Lake Analytics engine to use for the specific type of job being run.
RuntimeVersion *string `json:"runtimeVersion,omitempty"`
// Script - the script to run. Please note that the maximum script size is 3 MB.
Script *string `json:"script,omitempty"`
// Type - Possible values include: 'TypeBasicCreateJobPropertiesTypeCreateJobProperties', 'TypeBasicCreateJobPropertiesTypeUSQL'
Type TypeBasicCreateJobProperties `json:"type,omitempty"`
}
func (cjp CreateJobProperties) AsBasicCreateJobProperties() (BasicCreateJobProperties, bool)
AsBasicCreateJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.
func (cjp CreateJobProperties) AsCreateJobProperties() (*CreateJobProperties, bool)
AsCreateJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.
func (cjp CreateJobProperties) AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)
AsCreateUSQLJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.
func (cjp CreateJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateJobProperties.
CreateUSQLJobProperties u-SQL job properties used when submitting U-SQL jobs.
type CreateUSQLJobProperties struct {
// CompileMode - the specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode. Possible values include: 'Semantic', 'Full', 'SingleBox'
CompileMode CompileMode `json:"compileMode,omitempty"`
// RuntimeVersion - the runtime version of the Data Lake Analytics engine to use for the specific type of job being run.
RuntimeVersion *string `json:"runtimeVersion,omitempty"`
// Script - the script to run. Please note that the maximum script size is 3 MB.
Script *string `json:"script,omitempty"`
// Type - Possible values include: 'TypeBasicCreateJobPropertiesTypeCreateJobProperties', 'TypeBasicCreateJobPropertiesTypeUSQL'
Type TypeBasicCreateJobProperties `json:"type,omitempty"`
}
func (cusjp CreateUSQLJobProperties) AsBasicCreateJobProperties() (BasicCreateJobProperties, bool)
AsBasicCreateJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.
func (cusjp CreateUSQLJobProperties) AsCreateJobProperties() (*CreateJobProperties, bool)
AsCreateJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.
func (cusjp CreateUSQLJobProperties) AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)
AsCreateUSQLJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.
func (cusjp CreateUSQLJobProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateUSQLJobProperties.
DataPath a Data Lake Analytics job data path item.
type DataPath struct {
autorest.Response `json:"-"`
// JobID - READ-ONLY; the id of the job this data is for.
JobID *uuid.UUID `json:"jobId,omitempty"`
// Command - READ-ONLY; the command that this job data relates to.
Command *string `json:"command,omitempty"`
// Paths - READ-ONLY; 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.
Diagnostics error diagnostic information for failed jobs.
type Diagnostics struct {
// ColumnNumber - READ-ONLY; the column where the error occurred.
ColumnNumber *int32 `json:"columnNumber,omitempty"`
// End - READ-ONLY; the ending index of the error.
End *int32 `json:"end,omitempty"`
// LineNumber - READ-ONLY; the line number the error occurred on.
LineNumber *int32 `json:"lineNumber,omitempty"`
// Message - READ-ONLY; the error message.
Message *string `json:"message,omitempty"`
// Severity - READ-ONLY; the severity of the error. Possible values include: 'Warning', 'Error', 'Info', 'SevereWarning', 'Deprecated', 'UserWarning'
Severity SeverityTypes `json:"severity,omitempty"`
// Start - READ-ONLY; the starting index of the error.
Start *int32 `json:"start,omitempty"`
}
func (d Diagnostics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Diagnostics.
ErrorDetails the Data Lake Analytics job error details.
type ErrorDetails struct {
// Description - READ-ONLY; the error message description
Description *string `json:"description,omitempty"`
// Details - READ-ONLY; the details of the error message.
Details *string `json:"details,omitempty"`
// EndOffset - READ-ONLY; the end offset in the job where the error was found.
EndOffset *int32 `json:"endOffset,omitempty"`
// ErrorID - READ-ONLY; the specific identifier for the type of error encountered in the job.
ErrorID *string `json:"errorId,omitempty"`
// FilePath - READ-ONLY; the path to any supplemental error files, if any.
FilePath *string `json:"filePath,omitempty"`
// HelpLink - READ-ONLY; the link to MSDN or Azure help for this type of error, if any.
HelpLink *string `json:"helpLink,omitempty"`
// InternalDiagnostics - READ-ONLY; 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; the specific line number in the job where the error occurred.
LineNumber *int32 `json:"lineNumber,omitempty"`
// Message - READ-ONLY; the user friendly error message for the failure.
Message *string `json:"message,omitempty"`
// Resolution - READ-ONLY; the recommended resolution for the failure, if any.
Resolution *string `json:"resolution,omitempty"`
// InnerError - READ-ONLY; the inner error of this specific job error message, if any.
InnerError *InnerError `json:"innerError,omitempty"`
// Severity - READ-ONLY; the severity level of the failure. Possible values include: 'Warning', 'Error', 'Info', 'SevereWarning', 'Deprecated', 'UserWarning'
Severity SeverityTypes `json:"severity,omitempty"`
// Source - READ-ONLY; the ultimate source of the failure (usually either SYSTEM or USER).
Source *string `json:"source,omitempty"`
// StartOffset - READ-ONLY; 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 hive job properties used when retrieving Hive jobs.
type HiveJobProperties struct {
// LogsLocation - READ-ONLY; the Hive logs location
LogsLocation *string `json:"logsLocation,omitempty"`
// OutputLocation - READ-ONLY; the location of Hive job output files (both execution output and results)
OutputLocation *string `json:"outputLocation,omitempty"`
// StatementCount - READ-ONLY; the number of statements that will be run based on the script
StatementCount *int32 `json:"statementCount,omitempty"`
// ExecutedStatementCount - READ-ONLY; the number of statements that have been run based on the script
ExecutedStatementCount *int32 `json:"executedStatementCount,omitempty"`
// RuntimeVersion - READ-ONLY; the runtime version of the Data Lake Analytics engine to use for the specific type of job being run.
RuntimeVersion *string `json:"runtimeVersion,omitempty"`
// Script - the script to run. Please note that the maximum script size is 3 MB.
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.
InfoListResult list of JobInfo items.
type InfoListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; the list of JobInfo items.
Value *[]InformationBasic `json:"value,omitempty"`
// NextLink - READ-ONLY; the link (url) to the next page of results.
NextLink *string `json:"nextLink,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 InformationBasic 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() InformationBasic
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 InformationBasic 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() []InformationBasic
Values returns the slice of values for the current page or nil if there are no values.
Information the extended Data Lake Analytics job information properties returned when retrieving a specific job.
type Information struct {
autorest.Response `json:"-"`
// ErrorMessage - READ-ONLY; the error message details for the job, if the job failed.
ErrorMessage *[]ErrorDetails `json:"errorMessage,omitempty"`
// StateAuditRecords - READ-ONLY; the job state audit records, indicating when various operations have been performed on this job.
StateAuditRecords *[]StateAuditRecord `json:"stateAuditRecords,omitempty"`
// Properties - the job specific properties.
Properties BasicProperties `json:"properties,omitempty"`
// JobID - READ-ONLY; the job's unique identifier (a GUID).
JobID *uuid.UUID `json:"jobId,omitempty"`
// Name - the friendly name of the job.
Name *string `json:"name,omitempty"`
// Type - the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive'
Type TypeEnum `json:"type,omitempty"`
// Submitter - READ-ONLY; the user or account that submitted the job.
Submitter *string `json:"submitter,omitempty"`
// DegreeOfParallelism - READ-ONLY; the degree of parallelism used for this job.
DegreeOfParallelism *int32 `json:"degreeOfParallelism,omitempty"`
// DegreeOfParallelismPercent - READ-ONLY; the degree of parallelism in percentage used for this job.
DegreeOfParallelismPercent *float64 `json:"degreeOfParallelismPercent,omitempty"`
// Priority - READ-ONLY; 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; the time the job was submitted to the service.
SubmitTime *date.Time `json:"submitTime,omitempty"`
// StartTime - READ-ONLY; the start time of the job.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; the completion time of the job.
EndTime *date.Time `json:"endTime,omitempty"`
// State - READ-ONLY; 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; 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"`
// LogFolder - READ-ONLY; the log folder path to use in the following format: adl://<accountName>.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.
LogFolder *string `json:"logFolder,omitempty"`
// LogFilePatterns - READ-ONLY; the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt
LogFilePatterns *[]string `json:"logFilePatterns,omitempty"`
// Related - the recurring job relationship information properties.
Related *RelationshipProperties `json:"related,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"`
}
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.
InformationBasic the common Data Lake Analytics job information properties.
type InformationBasic struct {
// JobID - READ-ONLY; the job's unique identifier (a GUID).
JobID *uuid.UUID `json:"jobId,omitempty"`
// Name - the friendly name of the job.
Name *string `json:"name,omitempty"`
// Type - the job type of the current job (Hive or USql). Possible values include: 'USQL', 'Hive'
Type TypeEnum `json:"type,omitempty"`
// Submitter - READ-ONLY; the user or account that submitted the job.
Submitter *string `json:"submitter,omitempty"`
// DegreeOfParallelism - READ-ONLY; the degree of parallelism used for this job.
DegreeOfParallelism *int32 `json:"degreeOfParallelism,omitempty"`
// DegreeOfParallelismPercent - READ-ONLY; the degree of parallelism in percentage used for this job.
DegreeOfParallelismPercent *float64 `json:"degreeOfParallelismPercent,omitempty"`
// Priority - READ-ONLY; 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; the time the job was submitted to the service.
SubmitTime *date.Time `json:"submitTime,omitempty"`
// StartTime - READ-ONLY; the start time of the job.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; the completion time of the job.
EndTime *date.Time `json:"endTime,omitempty"`
// State - READ-ONLY; 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; 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"`
// LogFolder - READ-ONLY; the log folder path to use in the following format: adl://<accountName>.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.
LogFolder *string `json:"logFolder,omitempty"`
// LogFilePatterns - READ-ONLY; the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt
LogFilePatterns *[]string `json:"logFilePatterns,omitempty"`
// Related - the recurring job relationship information properties.
Related *RelationshipProperties `json:"related,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"`
}
func (ib InformationBasic) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InformationBasic.
InnerError the Data Lake Analytics job error details.
type InnerError struct {
// DiagnosticCode - READ-ONLY; the diagnostic error code.
DiagnosticCode *int32 `json:"diagnosticCode,omitempty"`
// Severity - READ-ONLY; the severity level of the failure. Possible values include: 'Warning', 'Error', 'Info', 'SevereWarning', 'Deprecated', 'UserWarning'
Severity SeverityTypes `json:"severity,omitempty"`
// Details - READ-ONLY; the details of the error message.
Details *string `json:"details,omitempty"`
// Component - READ-ONLY; the component that failed.
Component *string `json:"component,omitempty"`
// ErrorID - READ-ONLY; the specific identifier for the type of error encountered in the job.
ErrorID *string `json:"errorId,omitempty"`
// HelpLink - READ-ONLY; the link to MSDN or Azure help for this type of error, if any.
HelpLink *string `json:"helpLink,omitempty"`
// InternalDiagnostics - READ-ONLY; 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; the user friendly error message for the failure.
Message *string `json:"message,omitempty"`
// Resolution - READ-ONLY; the recommended resolution for the failure, if any.
Resolution *string `json:"resolution,omitempty"`
// Source - READ-ONLY; the ultimate source of the failure (usually either SYSTEM or USER).
Source *string `json:"source,omitempty"`
// Description - READ-ONLY; the error message description
Description *string `json:"description,omitempty"`
// InnerError - READ-ONLY; the inner error of this specific job error message, if any.
InnerError *InnerError `json:"innerError,omitempty"`
}
func (ie InnerError) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InnerError.
PipelineClient is the creates an Azure Data Lake Analytics job client.
type PipelineClient struct {
BaseClient
}
func NewPipelineClient() PipelineClient
NewPipelineClient creates an instance of the PipelineClient client.
func (client PipelineClient) Get(ctx context.Context, 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. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. pipelineIdentity - pipeline ID. startDateTime - 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 - 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 (client PipelineClient) GetPreparer(ctx context.Context, accountName string, pipelineIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client PipelineClient) List(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (result PipelineInformationListResultPage, err error)
List lists all pipelines. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. startDateTime - the start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime - the end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
func (client PipelineClient) ListComplete(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (result PipelineInformationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client PipelineClient) ListPreparer(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
PipelineInformation job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline.
type PipelineInformation struct {
autorest.Response `json:"-"`
// PipelineID - READ-ONLY; the job relationship pipeline identifier (a GUID).
PipelineID *uuid.UUID `json:"pipelineId,omitempty"`
// PipelineName - READ-ONLY; the friendly name of the job relationship pipeline, which does not need to be unique.
PipelineName *string `json:"pipelineName,omitempty"`
// PipelineURI - READ-ONLY; the pipeline uri, unique, links to the originating service for this pipeline.
PipelineURI *string `json:"pipelineUri,omitempty"`
// NumJobsFailed - READ-ONLY; the number of jobs in this pipeline that have failed.
NumJobsFailed *int32 `json:"numJobsFailed,omitempty"`
// NumJobsCanceled - READ-ONLY; the number of jobs in this pipeline that have been canceled.
NumJobsCanceled *int32 `json:"numJobsCanceled,omitempty"`
// NumJobsSucceeded - READ-ONLY; the number of jobs in this pipeline that have succeeded.
NumJobsSucceeded *int32 `json:"numJobsSucceeded,omitempty"`
// AuHoursFailed - READ-ONLY; the number of job execution hours that resulted in failed jobs.
AuHoursFailed *float64 `json:"auHoursFailed,omitempty"`
// AuHoursCanceled - READ-ONLY; the number of job execution hours that resulted in canceled jobs.
AuHoursCanceled *float64 `json:"auHoursCanceled,omitempty"`
// AuHoursSucceeded - READ-ONLY; the number of job execution hours that resulted in successful jobs.
AuHoursSucceeded *float64 `json:"auHoursSucceeded,omitempty"`
// LastSubmitTime - READ-ONLY; the last time a job in this pipeline was submitted.
LastSubmitTime *date.Time `json:"lastSubmitTime,omitempty"`
// Runs - READ-ONLY; the list of run identifiers representing each run of this pipeline.
Runs *[]PipelineRunInformation `json:"runs,omitempty"`
// Recurrences - READ-ONLY; the list of recurrence identifiers representing each recurrence in this pipeline.
Recurrences *[]uuid.UUID `json:"recurrences,omitempty"`
}
func (pi PipelineInformation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineInformation.
PipelineInformationListResult list of job pipeline information items.
type PipelineInformationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; the list of job pipeline information items.
Value *[]PipelineInformation `json:"value,omitempty"`
// NextLink - READ-ONLY; the link (url) to the next page of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (pilr PipelineInformationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (pilr PipelineInformationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineInformationListResult.
PipelineInformationListResultIterator provides access to a complete listing of PipelineInformation values.
type PipelineInformationListResultIterator struct {
// contains filtered or unexported fields
}
func NewPipelineInformationListResultIterator(page PipelineInformationListResultPage) PipelineInformationListResultIterator
Creates a new instance of the PipelineInformationListResultIterator type.
func (iter *PipelineInformationListResultIterator) 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 *PipelineInformationListResultIterator) 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 PipelineInformationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PipelineInformationListResultIterator) Response() PipelineInformationListResult
Response returns the raw server response from the last page request.
func (iter PipelineInformationListResultIterator) Value() PipelineInformation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PipelineInformationListResultPage contains a page of PipelineInformation values.
type PipelineInformationListResultPage struct {
// contains filtered or unexported fields
}
func NewPipelineInformationListResultPage(cur PipelineInformationListResult, getNextPage func(context.Context, PipelineInformationListResult) (PipelineInformationListResult, error)) PipelineInformationListResultPage
Creates a new instance of the PipelineInformationListResultPage type.
func (page *PipelineInformationListResultPage) 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 *PipelineInformationListResultPage) 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 PipelineInformationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PipelineInformationListResultPage) Response() PipelineInformationListResult
Response returns the raw server response from the last page request.
func (page PipelineInformationListResultPage) Values() []PipelineInformation
Values returns the slice of values for the current page or nil if there are no values.
PipelineRunInformation run info for a specific job pipeline.
type PipelineRunInformation struct {
// RunID - READ-ONLY; the run identifier of an instance of pipeline executions (a GUID).
RunID *uuid.UUID `json:"runId,omitempty"`
// LastSubmitTime - READ-ONLY; the time this instance was last submitted.
LastSubmitTime *date.Time `json:"lastSubmitTime,omitempty"`
}
func (pri PipelineRunInformation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineRunInformation.
Properties the common Data Lake Analytics job properties.
type Properties struct {
// RuntimeVersion - READ-ONLY; the runtime version of the Data Lake Analytics engine to use for the specific type of job being run.
RuntimeVersion *string `json:"runtimeVersion,omitempty"`
// Script - the script to run. Please note that the maximum script size is 3 MB.
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.
RecurrenceClient is the creates an Azure Data Lake Analytics job client.
type RecurrenceClient struct {
BaseClient
}
func NewRecurrenceClient() RecurrenceClient
NewRecurrenceClient creates an instance of the RecurrenceClient client.
func (client RecurrenceClient) Get(ctx context.Context, 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. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. recurrenceIdentity - recurrence ID. startDateTime - 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 - 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 (client RecurrenceClient) GetPreparer(ctx context.Context, accountName string, recurrenceIdentity uuid.UUID, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client RecurrenceClient) List(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (result RecurrenceInformationListResultPage, err error)
List lists all recurrences. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. startDateTime - the start date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart. endDateTime - the end date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.
func (client RecurrenceClient) ListComplete(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (result RecurrenceInformationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client RecurrenceClient) ListPreparer(ctx context.Context, accountName string, startDateTime *date.Time, endDateTime *date.Time) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
RecurrenceInformation recurrence job information for a specific recurrence.
type RecurrenceInformation struct {
autorest.Response `json:"-"`
// RecurrenceID - READ-ONLY; the recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together.
RecurrenceID *uuid.UUID `json:"recurrenceId,omitempty"`
// RecurrenceName - READ-ONLY; the recurrence name, user friendly name for the correlation between jobs.
RecurrenceName *string `json:"recurrenceName,omitempty"`
// NumJobsFailed - READ-ONLY; the number of jobs in this recurrence that have failed.
NumJobsFailed *int32 `json:"numJobsFailed,omitempty"`
// NumJobsCanceled - READ-ONLY; the number of jobs in this recurrence that have been canceled.
NumJobsCanceled *int32 `json:"numJobsCanceled,omitempty"`
// NumJobsSucceeded - READ-ONLY; the number of jobs in this recurrence that have succeeded.
NumJobsSucceeded *int32 `json:"numJobsSucceeded,omitempty"`
// AuHoursFailed - READ-ONLY; the number of job execution hours that resulted in failed jobs.
AuHoursFailed *float64 `json:"auHoursFailed,omitempty"`
// AuHoursCanceled - READ-ONLY; the number of job execution hours that resulted in canceled jobs.
AuHoursCanceled *float64 `json:"auHoursCanceled,omitempty"`
// AuHoursSucceeded - READ-ONLY; the number of job execution hours that resulted in successful jobs.
AuHoursSucceeded *float64 `json:"auHoursSucceeded,omitempty"`
// LastSubmitTime - READ-ONLY; the last time a job in this recurrence was submitted.
LastSubmitTime *date.Time `json:"lastSubmitTime,omitempty"`
}
func (ri RecurrenceInformation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecurrenceInformation.
RecurrenceInformationListResult list of job recurrence information items.
type RecurrenceInformationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; the list of job recurrence information items.
Value *[]RecurrenceInformation `json:"value,omitempty"`
// NextLink - READ-ONLY; the link (url) to the next page of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (rilr RecurrenceInformationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (rilr RecurrenceInformationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecurrenceInformationListResult.
RecurrenceInformationListResultIterator provides access to a complete listing of RecurrenceInformation values.
type RecurrenceInformationListResultIterator struct {
// contains filtered or unexported fields
}
func NewRecurrenceInformationListResultIterator(page RecurrenceInformationListResultPage) RecurrenceInformationListResultIterator
Creates a new instance of the RecurrenceInformationListResultIterator type.
func (iter *RecurrenceInformationListResultIterator) 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 *RecurrenceInformationListResultIterator) 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 RecurrenceInformationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RecurrenceInformationListResultIterator) Response() RecurrenceInformationListResult
Response returns the raw server response from the last page request.
func (iter RecurrenceInformationListResultIterator) Value() RecurrenceInformation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RecurrenceInformationListResultPage contains a page of RecurrenceInformation values.
type RecurrenceInformationListResultPage struct {
// contains filtered or unexported fields
}
func NewRecurrenceInformationListResultPage(cur RecurrenceInformationListResult, getNextPage func(context.Context, RecurrenceInformationListResult) (RecurrenceInformationListResult, error)) RecurrenceInformationListResultPage
Creates a new instance of the RecurrenceInformationListResultPage type.
func (page *RecurrenceInformationListResultPage) 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 *RecurrenceInformationListResultPage) 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 RecurrenceInformationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RecurrenceInformationListResultPage) Response() RecurrenceInformationListResult
Response returns the raw server response from the last page request.
func (page RecurrenceInformationListResultPage) Values() []RecurrenceInformation
Values returns the slice of values for the current page or nil if there are no values.
RelationshipProperties job relationship information properties including pipeline information, correlation information, etc.
type RelationshipProperties struct {
// PipelineID - the job relationship pipeline identifier (a GUID).
PipelineID *uuid.UUID `json:"pipelineId,omitempty"`
// PipelineName - the friendly name of the job relationship pipeline, which does not need to be unique.
PipelineName *string `json:"pipelineName,omitempty"`
// PipelineURI - the pipeline uri, unique, links to the originating service for this pipeline.
PipelineURI *string `json:"pipelineUri,omitempty"`
// RunID - the run identifier (a GUID), unique identifier of the iteration of this pipeline.
RunID *uuid.UUID `json:"runId,omitempty"`
// RecurrenceID - the recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together.
RecurrenceID *uuid.UUID `json:"recurrenceId,omitempty"`
// RecurrenceName - the recurrence name, user friendly name for the correlation between jobs.
RecurrenceName *string `json:"recurrenceName,omitempty"`
}
Resource the Data Lake Analytics job resources.
type Resource struct {
// Name - the name of the resource.
Name *string `json:"name,omitempty"`
// ResourcePath - the path to the resource.
ResourcePath *string `json:"resourcePath,omitempty"`
// Type - the job resource type. Possible values include: 'VertexResource', 'JobManagerResource', 'StatisticsResource', 'VertexResourceInUserFolder', 'JobManagerResourceInUserFolder', 'StatisticsResourceInUserFolder'
Type ResourceType `json:"type,omitempty"`
}
ResourceType enumerates the values for resource type.
type ResourceType string
const (
// JobManagerResource ...
JobManagerResource ResourceType = "JobManagerResource"
// JobManagerResourceInUserFolder ...
JobManagerResourceInUserFolder ResourceType = "JobManagerResourceInUserFolder"
// StatisticsResource ...
StatisticsResource ResourceType = "StatisticsResource"
// StatisticsResourceInUserFolder ...
StatisticsResourceInUserFolder ResourceType = "StatisticsResourceInUserFolder"
// VertexResource ...
VertexResource ResourceType = "VertexResource"
// VertexResourceInUserFolder ...
VertexResourceInUserFolder ResourceType = "VertexResourceInUserFolder"
)
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 (
// Deprecated ...
Deprecated SeverityTypes = "Deprecated"
// Error ...
Error SeverityTypes = "Error"
// Info ...
Info SeverityTypes = "Info"
// SevereWarning ...
SevereWarning SeverityTypes = "SevereWarning"
// UserWarning ...
UserWarning SeverityTypes = "UserWarning"
// 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 job state audit records for tracking the lifecycle of a job.
type StateAuditRecord struct {
// NewState - READ-ONLY; the new state the job is in.
NewState *string `json:"newState,omitempty"`
// TimeStamp - READ-ONLY; the time stamp that the state change took place.
TimeStamp *date.Time `json:"timeStamp,omitempty"`
// RequestedByUser - READ-ONLY; the user who requests the change.
RequestedByUser *string `json:"requestedByUser,omitempty"`
// Details - READ-ONLY; 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 job execution statistics.
type Statistics struct {
autorest.Response `json:"-"`
// LastUpdateTimeUtc - READ-ONLY; the last update time for the statistics.
LastUpdateTimeUtc *date.Time `json:"lastUpdateTimeUtc,omitempty"`
// FinalizingTimeUtc - READ-ONLY; the job finalizing start time.
FinalizingTimeUtc *date.Time `json:"finalizingTimeUtc,omitempty"`
// Stages - READ-ONLY; 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 job statistics vertex stage information.
type StatisticsVertexStage struct {
// DataRead - READ-ONLY; the amount of data read, in bytes.
DataRead *int64 `json:"dataRead,omitempty"`
// DataReadCrossPod - READ-ONLY; the amount of data read across multiple pods, in bytes.
DataReadCrossPod *int64 `json:"dataReadCrossPod,omitempty"`
// DataReadIntraPod - READ-ONLY; the amount of data read in one pod, in bytes.
DataReadIntraPod *int64 `json:"dataReadIntraPod,omitempty"`
// DataToRead - READ-ONLY; the amount of data remaining to be read, in bytes.
DataToRead *int64 `json:"dataToRead,omitempty"`
// DataWritten - READ-ONLY; the amount of data written, in bytes.
DataWritten *int64 `json:"dataWritten,omitempty"`
// DuplicateDiscardCount - READ-ONLY; the number of duplicates that were discarded.
DuplicateDiscardCount *int32 `json:"duplicateDiscardCount,omitempty"`
// FailedCount - READ-ONLY; the number of failures that occurred in this stage.
FailedCount *int32 `json:"failedCount,omitempty"`
// MaxVertexDataRead - READ-ONLY; the maximum amount of data read in a single vertex, in bytes.
MaxVertexDataRead *int64 `json:"maxVertexDataRead,omitempty"`
// MinVertexDataRead - READ-ONLY; the minimum amount of data read in a single vertex, in bytes.
MinVertexDataRead *int64 `json:"minVertexDataRead,omitempty"`
// ReadFailureCount - READ-ONLY; the number of read failures in this stage.
ReadFailureCount *int32 `json:"readFailureCount,omitempty"`
// RevocationCount - READ-ONLY; the number of vertices that were revoked during this stage.
RevocationCount *int32 `json:"revocationCount,omitempty"`
// RunningCount - READ-ONLY; the number of currently running vertices in this stage.
RunningCount *int32 `json:"runningCount,omitempty"`
// ScheduledCount - READ-ONLY; the number of currently scheduled vertices in this stage
ScheduledCount *int32 `json:"scheduledCount,omitempty"`
// StageName - READ-ONLY; the name of this stage in job execution.
StageName *string `json:"stageName,omitempty"`
// SucceededCount - READ-ONLY; the number of vertices that succeeded in this stage.
SucceededCount *int32 `json:"succeededCount,omitempty"`
// TempDataWritten - READ-ONLY; the amount of temporary data written, in bytes.
TempDataWritten *int64 `json:"tempDataWritten,omitempty"`
// TotalCount - READ-ONLY; the total vertex count for this stage.
TotalCount *int32 `json:"totalCount,omitempty"`
// TotalFailedTime - READ-ONLY; the amount of time that failed vertices took up in this stage.
TotalFailedTime *string `json:"totalFailedTime,omitempty"`
// TotalProgress - READ-ONLY; the current progress of this stage, as a percentage.
TotalProgress *int32 `json:"totalProgress,omitempty"`
// TotalSucceededTime - READ-ONLY; 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.
TypeBasicCreateJobProperties enumerates the values for type basic create job properties.
type TypeBasicCreateJobProperties string
const (
// TypeBasicCreateJobPropertiesTypeCreateJobProperties ...
TypeBasicCreateJobPropertiesTypeCreateJobProperties TypeBasicCreateJobProperties = "CreateJobProperties"
// TypeBasicCreateJobPropertiesTypeUSQL ...
TypeBasicCreateJobPropertiesTypeUSQL TypeBasicCreateJobProperties = "USql"
)
func PossibleTypeBasicCreateJobPropertiesValues() []TypeBasicCreateJobProperties
PossibleTypeBasicCreateJobPropertiesValues returns an array of possible values for the TypeBasicCreateJobProperties 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 u-SQL job properties used when retrieving U-SQL jobs.
type USQLJobProperties struct {
// Resources - READ-ONLY; the list of resources that are required by the job
Resources *[]Resource `json:"resources,omitempty"`
// Statistics - the job specific statistics.
Statistics *Statistics `json:"statistics,omitempty"`
// DebugData - the job specific debug data locations.
DebugData *DataPath `json:"debugData,omitempty"`
// Diagnostics - READ-ONLY; the diagnostics for the job.
Diagnostics *[]Diagnostics `json:"diagnostics,omitempty"`
// AlgebraFilePath - READ-ONLY; the algebra file path after the job has completed
AlgebraFilePath *string `json:"algebraFilePath,omitempty"`
// TotalCompilationTime - READ-ONLY; 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; 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; 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; 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; 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; 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; 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 - READ-ONLY; the specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode. Possible values include: 'Semantic', 'Full', 'SingleBox'
CompileMode CompileMode `json:"compileMode,omitempty"`
// RuntimeVersion - READ-ONLY; the runtime version of the Data Lake Analytics engine to use for the specific type of job being run.
RuntimeVersion *string `json:"runtimeVersion,omitempty"`
// Script - the script to run. Please note that the maximum script size is 3 MB.
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.