1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
|
package job
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"context"
"encoding/json"
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/date"
"github.com/Azure/go-autorest/autorest/to"
"github.com/Azure/go-autorest/tracing"
"github.com/gofrs/uuid"
"net/http"
)
// The package's fully qualified name.
const fqdn = "github.com/Azure/azure-sdk-for-go/services/preview/datalake/analytics/2016-03-20-preview/job"
// 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"`
}
// MarshalJSON is the custom marshaler for DataPath.
func (dp DataPath) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// Diagnostics ...
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'
Severity SeverityTypes `json:"severity,omitempty"`
// Start - READ-ONLY; the starting index of the error.
Start *int32 `json:"start,omitempty"`
}
// MarshalJSON is the custom marshaler for Diagnostics.
func (d Diagnostics) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// 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'
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"`
}
// MarshalJSON is the custom marshaler for ErrorDetails.
func (ed ErrorDetails) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// HiveJobProperties ...
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 - 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
Script *string `json:"script,omitempty"`
// Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive'
Type Type `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for HiveJobProperties.
func (hjp HiveJobProperties) MarshalJSON() ([]byte, error) {
hjp.Type = TypeHive
objectMap := make(map[string]interface{})
if hjp.RuntimeVersion != nil {
objectMap["runtimeVersion"] = hjp.RuntimeVersion
}
if hjp.Script != nil {
objectMap["script"] = hjp.Script
}
if hjp.Type != "" {
objectMap["type"] = hjp.Type
}
return json.Marshal(objectMap)
}
// AsUSQLJobProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool) {
return nil, false
}
// AsHiveJobProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool) {
return &hjp, true
}
// AsProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsProperties() (*Properties, bool) {
return nil, false
}
// AsBasicProperties is the BasicProperties implementation for HiveJobProperties.
func (hjp HiveJobProperties) AsBasicProperties() (BasicProperties, bool) {
return &hjp, true
}
// InfoListResult list of jobInfo items.
type InfoListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; the list of jobInfo items.
Value *[]Information `json:"value,omitempty"`
// NextLink - READ-ONLY; the link (url) to the next page of results.
NextLink *string `json:"nextLink,omitempty"`
// Count - READ-ONLY; the total count of results that are available, but might not be returned in the current page.
Count *int64 `json:"count,omitempty"`
}
// MarshalJSON is the custom marshaler for InfoListResult.
func (ilr InfoListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// InfoListResultIterator provides access to a complete listing of Information values.
type InfoListResultIterator struct {
i int
page InfoListResultPage
}
// 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) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/InfoListResultIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// 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) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter InfoListResultIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter InfoListResultIterator) Response() InfoListResult {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter InfoListResultIterator) Value() Information {
if !iter.page.NotDone() {
return Information{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the InfoListResultIterator type.
func NewInfoListResultIterator(page InfoListResultPage) InfoListResultIterator {
return InfoListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ilr InfoListResult) IsEmpty() bool {
return ilr.Value == nil || len(*ilr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ilr InfoListResult) hasNextLink() bool {
return ilr.NextLink != nil && len(*ilr.NextLink) != 0
}
// infoListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ilr InfoListResult) infoListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ilr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ilr.NextLink)))
}
// InfoListResultPage contains a page of Information values.
type InfoListResultPage struct {
fn func(context.Context, InfoListResult) (InfoListResult, error)
ilr InfoListResult
}
// 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) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/InfoListResultPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
for {
next, err := page.fn(ctx, page.ilr)
if err != nil {
return err
}
page.ilr = next
if !next.hasNextLink() || !next.IsEmpty() {
break
}
}
return nil
}
// 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) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page InfoListResultPage) NotDone() bool {
return !page.ilr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page InfoListResultPage) Response() InfoListResult {
return page.ilr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page InfoListResultPage) Values() []Information {
if page.ilr.IsEmpty() {
return nil
}
return *page.ilr.Value
}
// Creates a new instance of the InfoListResultPage type.
func NewInfoListResultPage(cur InfoListResult, getNextPage func(context.Context, InfoListResult) (InfoListResult, error)) InfoListResultPage {
return InfoListResultPage{
fn: getNextPage,
ilr: cur,
}
}
// Information the common Data Lake Analytics job information properties.
type Information struct {
autorest.Response `json:"-"`
// JobID - 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 - the user or account that submitted the job.
Submitter *string `json:"submitter,omitempty"`
// ErrorMessage - READ-ONLY; the error message details for the job, if the job failed.
ErrorMessage *[]ErrorDetails `json:"errorMessage,omitempty"`
// DegreeOfParallelism - 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 - 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 - 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"`
// StateAuditRecords - READ-ONLY; 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 - the job specific properties.
Properties BasicProperties `json:"properties,omitempty"`
}
// MarshalJSON is the custom marshaler for Information.
func (i Information) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if i.JobID != nil {
objectMap["jobId"] = i.JobID
}
if i.Name != nil {
objectMap["name"] = i.Name
}
if i.Type != "" {
objectMap["type"] = i.Type
}
if i.Submitter != nil {
objectMap["submitter"] = i.Submitter
}
if i.DegreeOfParallelism != nil {
objectMap["degreeOfParallelism"] = i.DegreeOfParallelism
}
if i.DegreeOfParallelismPercent != nil {
objectMap["degreeOfParallelismPercent"] = i.DegreeOfParallelismPercent
}
if i.Priority != nil {
objectMap["priority"] = i.Priority
}
if i.LogFilePatterns != nil {
objectMap["logFilePatterns"] = i.LogFilePatterns
}
objectMap["properties"] = i.Properties
return json.Marshal(objectMap)
}
// UnmarshalJSON is the custom unmarshaler for Information struct.
func (i *Information) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
for k, v := range m {
switch k {
case "jobId":
if v != nil {
var jobID uuid.UUID
err = json.Unmarshal(*v, &jobID)
if err != nil {
return err
}
i.JobID = &jobID
}
case "name":
if v != nil {
var name string
err = json.Unmarshal(*v, &name)
if err != nil {
return err
}
i.Name = &name
}
case "type":
if v != nil {
var typeVar TypeEnum
err = json.Unmarshal(*v, &typeVar)
if err != nil {
return err
}
i.Type = typeVar
}
case "submitter":
if v != nil {
var submitter string
err = json.Unmarshal(*v, &submitter)
if err != nil {
return err
}
i.Submitter = &submitter
}
case "errorMessage":
if v != nil {
var errorMessage []ErrorDetails
err = json.Unmarshal(*v, &errorMessage)
if err != nil {
return err
}
i.ErrorMessage = &errorMessage
}
case "degreeOfParallelism":
if v != nil {
var degreeOfParallelism int32
err = json.Unmarshal(*v, °reeOfParallelism)
if err != nil {
return err
}
i.DegreeOfParallelism = °reeOfParallelism
}
case "degreeOfParallelismPercent":
if v != nil {
var degreeOfParallelismPercent float64
err = json.Unmarshal(*v, °reeOfParallelismPercent)
if err != nil {
return err
}
i.DegreeOfParallelismPercent = °reeOfParallelismPercent
}
case "priority":
if v != nil {
var priority int32
err = json.Unmarshal(*v, &priority)
if err != nil {
return err
}
i.Priority = &priority
}
case "submitTime":
if v != nil {
var submitTime date.Time
err = json.Unmarshal(*v, &submitTime)
if err != nil {
return err
}
i.SubmitTime = &submitTime
}
case "startTime":
if v != nil {
var startTime date.Time
err = json.Unmarshal(*v, &startTime)
if err != nil {
return err
}
i.StartTime = &startTime
}
case "endTime":
if v != nil {
var endTime date.Time
err = json.Unmarshal(*v, &endTime)
if err != nil {
return err
}
i.EndTime = &endTime
}
case "state":
if v != nil {
var state State
err = json.Unmarshal(*v, &state)
if err != nil {
return err
}
i.State = state
}
case "result":
if v != nil {
var resultVar Result
err = json.Unmarshal(*v, &resultVar)
if err != nil {
return err
}
i.Result = resultVar
}
case "logFolder":
if v != nil {
var logFolder string
err = json.Unmarshal(*v, &logFolder)
if err != nil {
return err
}
i.LogFolder = &logFolder
}
case "logFilePatterns":
if v != nil {
var logFilePatterns []string
err = json.Unmarshal(*v, &logFilePatterns)
if err != nil {
return err
}
i.LogFilePatterns = &logFilePatterns
}
case "stateAuditRecords":
if v != nil {
var stateAuditRecords []StateAuditRecord
err = json.Unmarshal(*v, &stateAuditRecords)
if err != nil {
return err
}
i.StateAuditRecords = &stateAuditRecords
}
case "hierarchyQueueNode":
if v != nil {
var hierarchyQueueNode string
err = json.Unmarshal(*v, &hierarchyQueueNode)
if err != nil {
return err
}
i.HierarchyQueueNode = &hierarchyQueueNode
}
case "properties":
if v != nil {
properties, err := unmarshalBasicProperties(*v)
if err != nil {
return err
}
i.Properties = properties
}
}
}
return nil
}
// 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'
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"`
}
// MarshalJSON is the custom marshaler for InnerError.
func (ie InnerError) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// BasicProperties the common Data Lake Analytics job properties.
type BasicProperties interface {
AsUSQLJobProperties() (*USQLJobProperties, bool)
AsHiveJobProperties() (*HiveJobProperties, bool)
AsProperties() (*Properties, bool)
}
// Properties the common Data Lake Analytics job properties.
type Properties 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
Script *string `json:"script,omitempty"`
// Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive'
Type Type `json:"type,omitempty"`
}
func unmarshalBasicProperties(body []byte) (BasicProperties, error) {
var m map[string]interface{}
err := json.Unmarshal(body, &m)
if err != nil {
return nil, err
}
switch m["type"] {
case string(TypeUSQL):
var usjp USQLJobProperties
err := json.Unmarshal(body, &usjp)
return usjp, err
case string(TypeHive):
var hjp HiveJobProperties
err := json.Unmarshal(body, &hjp)
return hjp, err
default:
var p Properties
err := json.Unmarshal(body, &p)
return p, err
}
}
func unmarshalBasicPropertiesArray(body []byte) ([]BasicProperties, error) {
var rawMessages []*json.RawMessage
err := json.Unmarshal(body, &rawMessages)
if err != nil {
return nil, err
}
pArray := make([]BasicProperties, len(rawMessages))
for index, rawMessage := range rawMessages {
p, err := unmarshalBasicProperties(*rawMessage)
if err != nil {
return nil, err
}
pArray[index] = p
}
return pArray, nil
}
// MarshalJSON is the custom marshaler for Properties.
func (p Properties) MarshalJSON() ([]byte, error) {
p.Type = TypeJobProperties
objectMap := make(map[string]interface{})
if p.RuntimeVersion != nil {
objectMap["runtimeVersion"] = p.RuntimeVersion
}
if p.Script != nil {
objectMap["script"] = p.Script
}
if p.Type != "" {
objectMap["type"] = p.Type
}
return json.Marshal(objectMap)
}
// AsUSQLJobProperties is the BasicProperties implementation for Properties.
func (p Properties) AsUSQLJobProperties() (*USQLJobProperties, bool) {
return nil, false
}
// AsHiveJobProperties is the BasicProperties implementation for Properties.
func (p Properties) AsHiveJobProperties() (*HiveJobProperties, bool) {
return nil, false
}
// AsProperties is the BasicProperties implementation for Properties.
func (p Properties) AsProperties() (*Properties, bool) {
return &p, true
}
// AsBasicProperties is the BasicProperties implementation for Properties.
func (p Properties) AsBasicProperties() (BasicProperties, bool) {
return &p, true
}
// 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"`
}
// 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"`
}
// MarshalJSON is the custom marshaler for StateAuditRecord.
func (sar StateAuditRecord) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// 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"`
}
// MarshalJSON is the custom marshaler for Statistics.
func (s Statistics) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// 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"`
}
// MarshalJSON is the custom marshaler for StatisticsVertexStage.
func (svs StatisticsVertexStage) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// USQLJobProperties ...
type USQLJobProperties struct {
// Resources - 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 - 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 - the compile mode for the job. 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
Script *string `json:"script,omitempty"`
// Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive'
Type Type `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for USQLJobProperties.
func (usjp USQLJobProperties) MarshalJSON() ([]byte, error) {
usjp.Type = TypeUSQL
objectMap := make(map[string]interface{})
if usjp.Resources != nil {
objectMap["resources"] = usjp.Resources
}
if usjp.Statistics != nil {
objectMap["statistics"] = usjp.Statistics
}
if usjp.DebugData != nil {
objectMap["debugData"] = usjp.DebugData
}
if usjp.Diagnostics != nil {
objectMap["diagnostics"] = usjp.Diagnostics
}
if usjp.CompileMode != "" {
objectMap["compileMode"] = usjp.CompileMode
}
if usjp.RuntimeVersion != nil {
objectMap["runtimeVersion"] = usjp.RuntimeVersion
}
if usjp.Script != nil {
objectMap["script"] = usjp.Script
}
if usjp.Type != "" {
objectMap["type"] = usjp.Type
}
return json.Marshal(objectMap)
}
// AsUSQLJobProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsUSQLJobProperties() (*USQLJobProperties, bool) {
return &usjp, true
}
// AsHiveJobProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsHiveJobProperties() (*HiveJobProperties, bool) {
return nil, false
}
// AsProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsProperties() (*Properties, bool) {
return nil, false
}
// AsBasicProperties is the BasicProperties implementation for USQLJobProperties.
func (usjp USQLJobProperties) AsBasicProperties() (BasicProperties, bool) {
return &usjp, true
}
|