azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/datalake/analytics/2017-09-01-preview/job Index | Files | Directories

package job

import "github.com/Azure/azure-sdk-for-go/services/preview/datalake/analytics/2017-09-01-preview/job"

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

Creates an Azure Data Lake Analytics job client.

Index

Package Files

client.go job.go models.go pipeline.go recurrence.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version Uses

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    AdlaJobDNSSuffix string
}

BaseClient is the base client for Job.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults Uses

func NewWithoutDefaults(adlaJobDNSSuffix string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BaseJobParameters Uses

type BaseJobParameters struct {
    // Type - The job type of the current job (Hive, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Properties - The job specific properties.
    Properties BasicCreateJobProperties `json:"properties,omitempty"`
}

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

func (*BaseJobParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for BaseJobParameters struct.

type BasicCreateJobProperties Uses

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

BasicCreateJobProperties the common Data Lake Analytics job properties for job submission.

type BasicProperties Uses

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

BasicProperties the common Data Lake Analytics job properties.

type BuildJobParameters Uses

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, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Properties - The job specific properties.
    Properties BasicCreateJobProperties `json:"properties,omitempty"`
}

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

func (*BuildJobParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for BuildJobParameters struct.

type CancelFuture Uses

type CancelFuture struct {
    azure.Future
}

CancelFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CancelFuture) Result Uses

func (future *CancelFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Client Uses

type Client struct {
    BaseClient
}

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

func NewClient Uses

func NewClient() Client

NewClient creates an instance of the Client client.

func (Client) Build Uses

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) BuildPreparer Uses

func (client Client) BuildPreparer(ctx context.Context, accountName string, parameters BuildJobParameters) (*http.Request, error)

BuildPreparer prepares the Build request.

func (Client) BuildResponder Uses

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

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

func (Client) BuildSender Uses

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) Cancel Uses

func (client Client) Cancel(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result CancelFuture, 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) CancelPreparer Uses

func (client Client) CancelPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (Client) CancelResponder Uses

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) CancelSender Uses

func (client Client) CancelSender(req *http.Request) (future CancelFuture, err error)

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

func (Client) Create Uses

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) CreatePreparer Uses

func (client Client) CreatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters CreateJobParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (Client) CreateResponder Uses

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

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

func (Client) CreateSender Uses

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) Get Uses

func (client Client) Get(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result Information, err error)

Get gets the job information for the specified job ID. Parameters: accountName - the Azure Data Lake Analytics account to execute job operations on. jobIdentity - jobInfo ID.

func (Client) GetDebugDataPath Uses

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) GetDebugDataPathPreparer Uses

func (client Client) GetDebugDataPathPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetDebugDataPathPreparer prepares the GetDebugDataPath request.

func (Client) GetDebugDataPathResponder Uses

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) GetDebugDataPathSender Uses

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) GetPreparer Uses

func (client Client) GetPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder Uses

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

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

func (Client) GetSender Uses

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) GetStatistics Uses

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) GetStatisticsPreparer Uses

func (client Client) GetStatisticsPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)

GetStatisticsPreparer prepares the GetStatistics request.

func (Client) GetStatisticsResponder Uses

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

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

func (Client) GetStatisticsSender Uses

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) List Uses

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) ListComplete Uses

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) ListPreparer Uses

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) ListResponder Uses

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) ListSender Uses

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.

func (Client) Update Uses

func (client Client) Update(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters *UpdateJobParameters) (result UpdateFuture, err error)

Update updates the job information for the specified job ID. (Only for use internally with Scope job type.) 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 update a job.

func (Client) UpdatePreparer Uses

func (client Client) UpdatePreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID, parameters *UpdateJobParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder Uses

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

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

func (Client) UpdateSender Uses

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

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

func (Client) Yield Uses

func (client Client) Yield(ctx context.Context, accountName string, jobIdentity uuid.UUID) (result YieldFuture, err error)

Yield pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.) 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) YieldPreparer Uses

func (client Client) YieldPreparer(ctx context.Context, accountName string, jobIdentity uuid.UUID) (*http.Request, error)

YieldPreparer prepares the Yield request.

func (Client) YieldResponder Uses

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

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

func (Client) YieldSender Uses

func (client Client) YieldSender(req *http.Request) (future YieldFuture, err error)

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

type CompileMode Uses

type CompileMode string

CompileMode enumerates the values for compile mode.

const (
    // Full ...
    Full CompileMode = "Full"
    // Semantic ...
    Semantic CompileMode = "Semantic"
    // SingleBox ...
    SingleBox CompileMode = "SingleBox"
)

func PossibleCompileModeValues Uses

func PossibleCompileModeValues() []CompileMode

PossibleCompileModeValues returns an array of possible values for the CompileMode const type.

type CreateJobParameters Uses

type CreateJobParameters struct {
    // Name - The friendly name of the job to submit.
    Name *string `json:"name,omitempty"`
    // DegreeOfParallelism - The degree of parallelism to use 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.
    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, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Properties - The job specific properties.
    Properties BasicCreateJobProperties `json:"properties,omitempty"`
}

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

func (*CreateJobParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for CreateJobParameters struct.

type CreateJobProperties Uses

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', 'TypeBasicCreateJobPropertiesTypeScope'
    Type TypeBasicCreateJobProperties `json:"type,omitempty"`
}

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

func (CreateJobProperties) AsBasicCreateJobProperties Uses

func (cjp CreateJobProperties) AsBasicCreateJobProperties() (BasicCreateJobProperties, bool)

AsBasicCreateJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.

func (CreateJobProperties) AsCreateJobProperties Uses

func (cjp CreateJobProperties) AsCreateJobProperties() (*CreateJobProperties, bool)

AsCreateJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.

func (CreateJobProperties) AsCreateScopeJobProperties Uses

func (cjp CreateJobProperties) AsCreateScopeJobProperties() (*CreateScopeJobProperties, bool)

AsCreateScopeJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.

func (CreateJobProperties) AsCreateUSQLJobProperties Uses

func (cjp CreateJobProperties) AsCreateUSQLJobProperties() (*CreateUSQLJobProperties, bool)

AsCreateUSQLJobProperties is the BasicCreateJobProperties implementation for CreateJobProperties.

func (CreateJobProperties) MarshalJSON Uses

func (cjp CreateJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateJobProperties.

type CreateScopeJobParameters Uses

type CreateScopeJobParameters struct {
    // Tags - The key-value pairs used to add additional metadata to the job information.
    Tags map[string]*string `json:"tags"`
    // Name - The friendly name of the job to submit.
    Name *string `json:"name,omitempty"`
    // DegreeOfParallelism - The degree of parallelism to use 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.
    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, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Properties - The job specific properties.
    Properties BasicCreateJobProperties `json:"properties,omitempty"`
}

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

func (CreateScopeJobParameters) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for CreateScopeJobParameters.

func (*CreateScopeJobParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for CreateScopeJobParameters struct.

type CreateScopeJobProperties Uses

type CreateScopeJobProperties struct {
    // Resources - The list of resources that are required by the job.
    Resources *[]ScopeJobResource `json:"resources,omitempty"`
    // Notifier - The list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state.
    Notifier *string `json:"notifier,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', 'TypeBasicCreateJobPropertiesTypeScope'
    Type TypeBasicCreateJobProperties `json:"type,omitempty"`
}

CreateScopeJobProperties scope job properties used when submitting Scope jobs. (Only for use internally with Scope job type.)

func (CreateScopeJobProperties) AsBasicCreateJobProperties Uses

func (csjp CreateScopeJobProperties) AsBasicCreateJobProperties() (BasicCreateJobProperties, bool)

AsBasicCreateJobProperties is the BasicCreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) AsCreateJobProperties Uses

func (csjp CreateScopeJobProperties) AsCreateJobProperties() (*CreateJobProperties, bool)

AsCreateJobProperties is the BasicCreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) AsCreateScopeJobProperties Uses

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

AsCreateScopeJobProperties is the BasicCreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) AsCreateUSQLJobProperties Uses

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

AsCreateUSQLJobProperties is the BasicCreateJobProperties implementation for CreateScopeJobProperties.

func (CreateScopeJobProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for CreateScopeJobProperties.

type CreateUSQLJobProperties Uses

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', 'TypeBasicCreateJobPropertiesTypeScope'
    Type TypeBasicCreateJobProperties `json:"type,omitempty"`
}

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

func (CreateUSQLJobProperties) AsBasicCreateJobProperties Uses

func (cusjp CreateUSQLJobProperties) AsBasicCreateJobProperties() (BasicCreateJobProperties, bool)

AsBasicCreateJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) AsCreateJobProperties Uses

func (cusjp CreateUSQLJobProperties) AsCreateJobProperties() (*CreateJobProperties, bool)

AsCreateJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) AsCreateScopeJobProperties Uses

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

AsCreateScopeJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) AsCreateUSQLJobProperties Uses

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

AsCreateUSQLJobProperties is the BasicCreateJobProperties implementation for CreateUSQLJobProperties.

func (CreateUSQLJobProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for CreateUSQLJobProperties.

type DataPath Uses

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"`
}

DataPath a Data Lake Analytics job data path item.

type Diagnostics Uses

type Diagnostics struct {
    // 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"`
    // LineNumber - READ-ONLY; The line number the error occurred on.
    LineNumber *int32 `json:"lineNumber,omitempty"`
    // ColumnNumber - READ-ONLY; The column where the error occurred.
    ColumnNumber *int32 `json:"columnNumber,omitempty"`
    // Start - READ-ONLY; The starting index of the error.
    Start *int32 `json:"start,omitempty"`
    // End - READ-ONLY; The ending index of the error.
    End *int32 `json:"end,omitempty"`
}

Diagnostics error diagnostic information for failed jobs.

type ErrorDetails Uses

type ErrorDetails struct {
    // ErrorID - READ-ONLY; The specific identifier for the type of error encountered in the job.
    ErrorID *string `json:"errorId,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"`
    // Message - READ-ONLY; The user friendly error message for the failure.
    Message *string `json:"message,omitempty"`
    // 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"`
    // LineNumber - READ-ONLY; The specific line number in the job where the error occurred.
    LineNumber *int32 `json:"lineNumber,omitempty"`
    // StartOffset - READ-ONLY; The start offset in the job where the error was found
    StartOffset *int32 `json:"startOffset,omitempty"`
    // EndOffset - READ-ONLY; The end offset in the job where the error was found.
    EndOffset *int32 `json:"endOffset,omitempty"`
    // Resolution - READ-ONLY; The recommended resolution for the failure, if any.
    Resolution *string `json:"resolution,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"`
    // InnerError - READ-ONLY; The inner error of this specific job error message, if any.
    InnerError *InnerError `json:"innerError,omitempty"`
}

ErrorDetails the Data Lake Analytics job error details.

type HiveJobProperties Uses

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. Please note that the maximum script size is 3 MB.
    Script *string `json:"script,omitempty"`
    // Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive', 'TypeScope'
    Type Type `json:"type,omitempty"`
}

HiveJobProperties hive job properties used when retrieving Hive jobs.

func (HiveJobProperties) AsBasicProperties Uses

func (hjp HiveJobProperties) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for HiveJobProperties.

func (HiveJobProperties) AsHiveJobProperties Uses

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

AsHiveJobProperties is the BasicProperties implementation for HiveJobProperties.

func (HiveJobProperties) AsProperties Uses

func (hjp HiveJobProperties) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for HiveJobProperties.

func (HiveJobProperties) AsScopeJobProperties Uses

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

AsScopeJobProperties is the BasicProperties implementation for HiveJobProperties.

func (HiveJobProperties) AsUSQLJobProperties Uses

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

AsUSQLJobProperties is the BasicProperties implementation for HiveJobProperties.

func (HiveJobProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for HiveJobProperties.

type InfoListResult Uses

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"`
}

InfoListResult list of JobInfo items.

func (InfoListResult) IsEmpty Uses

func (ilr InfoListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type InfoListResultIterator Uses

type InfoListResultIterator struct {
    // contains filtered or unexported fields
}

InfoListResultIterator provides access to a complete listing of InformationBasic values.

func NewInfoListResultIterator Uses

func NewInfoListResultIterator(page InfoListResultPage) InfoListResultIterator

Creates a new instance of the InfoListResultIterator type.

func (*InfoListResultIterator) Next Uses

func (iter *InfoListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*InfoListResultIterator) NextWithContext Uses

func (iter *InfoListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (InfoListResultIterator) NotDone Uses

func (iter InfoListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (InfoListResultIterator) Response Uses

func (iter InfoListResultIterator) Response() InfoListResult

Response returns the raw server response from the last page request.

func (InfoListResultIterator) Value Uses

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.

type InfoListResultPage Uses

type InfoListResultPage struct {
    // contains filtered or unexported fields
}

InfoListResultPage contains a page of InformationBasic values.

func NewInfoListResultPage Uses

func NewInfoListResultPage(getNextPage func(context.Context, InfoListResult) (InfoListResult, error)) InfoListResultPage

Creates a new instance of the InfoListResultPage type.

func (*InfoListResultPage) Next Uses

func (page *InfoListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*InfoListResultPage) NextWithContext Uses

func (page *InfoListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (InfoListResultPage) NotDone Uses

func (page InfoListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (InfoListResultPage) Response Uses

func (page InfoListResultPage) Response() InfoListResult

Response returns the raw server response from the last page request.

func (InfoListResultPage) Values Uses

func (page InfoListResultPage) Values() []InformationBasic

Values returns the slice of values for the current page or nil if there are no values.

type Information Uses

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, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Submitter - READ-ONLY; The user or account that submitted the job.
    Submitter *string `json:"submitter,omitempty"`
    // DegreeOfParallelism - 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 - 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', 'StateYielded', 'StateFinalizing'
    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"`
    // Related - The recurring job relationship information properties.
    Related *RelationshipProperties `json:"related,omitempty"`
    // Tags - The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)
    Tags map[string]*string `json:"tags"`
    // 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"`
}

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

func (Information) MarshalJSON Uses

func (i Information) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Information.

func (*Information) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Information struct.

type InformationBasic Uses

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, USql, or Scope (for internal use only)). Possible values include: 'USQL', 'Hive', 'Scope'
    Type TypeEnum `json:"type,omitempty"`
    // Submitter - READ-ONLY; The user or account that submitted the job.
    Submitter *string `json:"submitter,omitempty"`
    // DegreeOfParallelism - 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 - 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', 'StateYielded', 'StateFinalizing'
    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"`
    // Related - The recurring job relationship information properties.
    Related *RelationshipProperties `json:"related,omitempty"`
    // Tags - The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)
    Tags map[string]*string `json:"tags"`
    // 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"`
}

InformationBasic the common Data Lake Analytics job information properties.

func (InformationBasic) MarshalJSON Uses

func (ib InformationBasic) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for InformationBasic.

type InnerError Uses

type InnerError struct {
    // ErrorID - READ-ONLY; The specific identifier for the type of error encountered in the job.
    ErrorID *string `json:"errorId,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"`
    // Message - READ-ONLY; The user friendly error message for the failure.
    Message *string `json:"message,omitempty"`
    // 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"`
    // DiagnosticCode - READ-ONLY; The diagnostic error code.
    DiagnosticCode *int32 `json:"diagnosticCode,omitempty"`
    // Component - READ-ONLY; The component that failed.
    Component *string `json:"component,omitempty"`
    // Resolution - READ-ONLY; The recommended resolution for the failure, if any.
    Resolution *string `json:"resolution,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"`
    // InnerError - READ-ONLY; The inner error of this specific job error message, if any.
    InnerError *InnerError `json:"innerError,omitempty"`
}

InnerError the Data Lake Analytics job error details.

type PipelineClient Uses

type PipelineClient struct {
    BaseClient
}

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

func NewPipelineClient Uses

func NewPipelineClient() PipelineClient

NewPipelineClient creates an instance of the PipelineClient client.

func (PipelineClient) Get Uses

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 (PipelineClient) GetPreparer Uses

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 (PipelineClient) GetResponder Uses

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

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

func (PipelineClient) GetSender Uses

func (client PipelineClient) GetSender(req *http.Request) (*http.Response, error)

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

func (PipelineClient) List Uses

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 (PipelineClient) ListComplete Uses

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 (PipelineClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (PipelineClient) ListResponder Uses

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

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

func (PipelineClient) ListSender Uses

func (client PipelineClient) ListSender(req *http.Request) (*http.Response, error)

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

type PipelineInformation Uses

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 recurrence identifiers representing each run of this pipeline.
    Runs *[]PipelineRunInformation `json:"runs,omitempty"`
    // Recurrences - READ-ONLY; The list of recurrence identifiers representing each run of this pipeline.
    Recurrences *[]uuid.UUID `json:"recurrences,omitempty"`
}

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

type PipelineInformationListResult Uses

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"`
}

PipelineInformationListResult list of job pipeline information items.

func (PipelineInformationListResult) IsEmpty Uses

func (pilr PipelineInformationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PipelineInformationListResultIterator Uses

type PipelineInformationListResultIterator struct {
    // contains filtered or unexported fields
}

PipelineInformationListResultIterator provides access to a complete listing of PipelineInformation values.

func NewPipelineInformationListResultIterator Uses

func NewPipelineInformationListResultIterator(page PipelineInformationListResultPage) PipelineInformationListResultIterator

Creates a new instance of the PipelineInformationListResultIterator type.

func (*PipelineInformationListResultIterator) Next Uses

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 (*PipelineInformationListResultIterator) NextWithContext Uses

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 (PipelineInformationListResultIterator) NotDone Uses

func (iter PipelineInformationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PipelineInformationListResultIterator) Response Uses

func (iter PipelineInformationListResultIterator) Response() PipelineInformationListResult

Response returns the raw server response from the last page request.

func (PipelineInformationListResultIterator) Value Uses

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.

type PipelineInformationListResultPage Uses

type PipelineInformationListResultPage struct {
    // contains filtered or unexported fields
}

PipelineInformationListResultPage contains a page of PipelineInformation values.

func NewPipelineInformationListResultPage Uses

func NewPipelineInformationListResultPage(getNextPage func(context.Context, PipelineInformationListResult) (PipelineInformationListResult, error)) PipelineInformationListResultPage

Creates a new instance of the PipelineInformationListResultPage type.

func (*PipelineInformationListResultPage) Next Uses

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 (*PipelineInformationListResultPage) NextWithContext Uses

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 (PipelineInformationListResultPage) NotDone Uses

func (page PipelineInformationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PipelineInformationListResultPage) Response Uses

func (page PipelineInformationListResultPage) Response() PipelineInformationListResult

Response returns the raw server response from the last page request.

func (PipelineInformationListResultPage) Values Uses

func (page PipelineInformationListResultPage) Values() []PipelineInformation

Values returns the slice of values for the current page or nil if there are no values.

type PipelineRunInformation Uses

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"`
}

PipelineRunInformation run info for a specific job pipeline.

type Properties Uses

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. Please note that the maximum script size is 3 MB.
    Script *string `json:"script,omitempty"`
    // Type - Possible values include: 'TypeJobProperties', 'TypeUSQL', 'TypeHive', 'TypeScope'
    Type Type `json:"type,omitempty"`
}

Properties the common Data Lake Analytics job properties.

func (Properties) AsBasicProperties Uses

func (p Properties) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for Properties.

func (Properties) AsHiveJobProperties Uses

func (p Properties) AsHiveJobProperties() (*HiveJobProperties, bool)

AsHiveJobProperties is the BasicProperties implementation for Properties.

func (Properties) AsProperties Uses

func (p Properties) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for Properties.

func (Properties) AsScopeJobProperties Uses

func (p Properties) AsScopeJobProperties() (*ScopeJobProperties, bool)

AsScopeJobProperties is the BasicProperties implementation for Properties.

func (Properties) AsUSQLJobProperties Uses

func (p Properties) AsUSQLJobProperties() (*USQLJobProperties, bool)

AsUSQLJobProperties is the BasicProperties implementation for Properties.

func (Properties) MarshalJSON Uses

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type RecurrenceClient Uses

type RecurrenceClient struct {
    BaseClient
}

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

func NewRecurrenceClient Uses

func NewRecurrenceClient() RecurrenceClient

NewRecurrenceClient creates an instance of the RecurrenceClient client.

func (RecurrenceClient) Get Uses

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 (RecurrenceClient) GetPreparer Uses

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 (RecurrenceClient) GetResponder Uses

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

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

func (RecurrenceClient) GetSender Uses

func (client RecurrenceClient) GetSender(req *http.Request) (*http.Response, error)

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

func (RecurrenceClient) List Uses

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 (RecurrenceClient) ListComplete Uses

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 (RecurrenceClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (RecurrenceClient) ListResponder Uses

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

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

func (RecurrenceClient) ListSender Uses

func (client RecurrenceClient) ListSender(req *http.Request) (*http.Response, error)

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

type RecurrenceInformation Uses

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"`
}

RecurrenceInformation recurrence job information for a specific recurrence.

type RecurrenceInformationListResult Uses

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"`
}

RecurrenceInformationListResult list of job recurrence information items.

func (RecurrenceInformationListResult) IsEmpty Uses

func (rilr RecurrenceInformationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RecurrenceInformationListResultIterator Uses

type RecurrenceInformationListResultIterator struct {
    // contains filtered or unexported fields
}

RecurrenceInformationListResultIterator provides access to a complete listing of RecurrenceInformation values.

func NewRecurrenceInformationListResultIterator Uses

func NewRecurrenceInformationListResultIterator(page RecurrenceInformationListResultPage) RecurrenceInformationListResultIterator

Creates a new instance of the RecurrenceInformationListResultIterator type.

func (*RecurrenceInformationListResultIterator) Next Uses

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 (*RecurrenceInformationListResultIterator) NextWithContext Uses

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 (RecurrenceInformationListResultIterator) NotDone Uses

func (iter RecurrenceInformationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RecurrenceInformationListResultIterator) Response Uses

func (iter RecurrenceInformationListResultIterator) Response() RecurrenceInformationListResult

Response returns the raw server response from the last page request.

func (RecurrenceInformationListResultIterator) Value Uses

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.

type RecurrenceInformationListResultPage Uses

type RecurrenceInformationListResultPage struct {
    // contains filtered or unexported fields
}

RecurrenceInformationListResultPage contains a page of RecurrenceInformation values.

func NewRecurrenceInformationListResultPage Uses

func NewRecurrenceInformationListResultPage(getNextPage func(context.Context, RecurrenceInformationListResult) (RecurrenceInformationListResult, error)) RecurrenceInformationListResultPage

Creates a new instance of the RecurrenceInformationListResultPage type.

func (*RecurrenceInformationListResultPage) Next Uses

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 (*RecurrenceInformationListResultPage) NextWithContext Uses

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 (RecurrenceInformationListResultPage) NotDone Uses

func (page RecurrenceInformationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RecurrenceInformationListResultPage) Response Uses

func (page RecurrenceInformationListResultPage) Response() RecurrenceInformationListResult

Response returns the raw server response from the last page request.

func (RecurrenceInformationListResultPage) Values Uses

func (page RecurrenceInformationListResultPage) Values() []RecurrenceInformation

Values returns the slice of values for the current page or nil if there are no values.

type RelationshipProperties Uses

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"`
}

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

type Resource Uses

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"`
}

Resource the Data Lake Analytics job resources.

type ResourceType Uses

type ResourceType string

ResourceType enumerates the values for resource type.

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 Uses

func PossibleResourceTypeValues() []ResourceType

PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.

type ResourceUsageStatistics Uses

type ResourceUsageStatistics struct {
    // Average - READ-ONLY; The average value.
    Average *float64 `json:"average,omitempty"`
    // Minimum - READ-ONLY; The minimum value.
    Minimum *int64 `json:"minimum,omitempty"`
    // Maximum - READ-ONLY; The maximum value.
    Maximum *int64 `json:"maximum,omitempty"`
}

ResourceUsageStatistics the statistics information for resource usage.

type Result Uses

type Result string

Result enumerates the values for result.

const (
    // Cancelled ...
    Cancelled Result = "Cancelled"
    // Failed ...
    Failed Result = "Failed"
    // None ...
    None Result = "None"
    // Succeeded ...
    Succeeded Result = "Succeeded"
)

func PossibleResultValues Uses

func PossibleResultValues() []Result

PossibleResultValues returns an array of possible values for the Result const type.

type ScopeJobProperties Uses

type ScopeJobProperties struct {
    // Resources - READ-ONLY; The list of resources that are required by the job.
    Resources *[]ScopeJobResource `json:"resources,omitempty"`
    // UserAlgebraPath - READ-ONLY; The algebra file path after the job has completed.
    UserAlgebraPath *string `json:"userAlgebraPath,omitempty"`
    // Notifier - The list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state.
    Notifier *string `json:"notifier,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"`
    // 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"`
    // TotalPausedTime - 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.
    TotalPausedTime *string `json:"totalPausedTime,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"`
    // 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: 'TypeJobProperties', 'TypeUSQL', 'TypeHive', 'TypeScope'
    Type Type `json:"type,omitempty"`
}

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

func (ScopeJobProperties) AsBasicProperties Uses

func (sjp ScopeJobProperties) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsHiveJobProperties Uses

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

AsHiveJobProperties is the BasicProperties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsProperties Uses

func (sjp ScopeJobProperties) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsScopeJobProperties Uses

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

AsScopeJobProperties is the BasicProperties implementation for ScopeJobProperties.

func (ScopeJobProperties) AsUSQLJobProperties Uses

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

AsUSQLJobProperties is the BasicProperties implementation for ScopeJobProperties.

func (ScopeJobProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ScopeJobProperties.

type ScopeJobResource Uses

type ScopeJobResource struct {
    // Name - The name of the resource.
    Name *string `json:"name,omitempty"`
    // Path - The path to the resource.
    Path *string `json:"path,omitempty"`
}

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

type SeverityTypes Uses

type SeverityTypes string

SeverityTypes enumerates the values for severity types.

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 Uses

func PossibleSeverityTypesValues() []SeverityTypes

PossibleSeverityTypesValues returns an array of possible values for the SeverityTypes const type.

type State Uses

type State string

State enumerates the values for state.

const (
    // StateAccepted ...
    StateAccepted State = "Accepted"
    // StateCompiling ...
    StateCompiling State = "Compiling"
    // StateEnded ...
    StateEnded State = "Ended"
    // StateFinalizing ...
    StateFinalizing State = "Finalizing"
    // 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"
    // StateYielded ...
    StateYielded State = "Yielded"
)

func PossibleStateValues Uses

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type StateAuditRecord Uses

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"`
}

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

type Statistics Uses

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"`
}

Statistics the Data Lake Analytics job execution statistics.

type StatisticsVertex Uses

type StatisticsVertex struct {
    // Name - READ-ONLY; The name of the vertex.
    Name *string `json:"name,omitempty"`
    // VertexID - READ-ONLY; The id of the vertex.
    VertexID *uuid.UUID `json:"vertexId,omitempty"`
    // ExecutionTime - READ-ONLY; The amount of execution time of the vertex.
    ExecutionTime *string `json:"executionTime,omitempty"`
    // DataRead - READ-ONLY; The amount of data read of the vertex, in bytes.
    DataRead *int64 `json:"dataRead,omitempty"`
    // PeakMemUsage - READ-ONLY; The amount of peak memory usage of the vertex, in bytes.
    PeakMemUsage *int64 `json:"peakMemUsage,omitempty"`
}

StatisticsVertex the detailed information for a vertex.

type StatisticsVertexStage Uses

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"`
    // TotalPeakMemUsage - READ-ONLY; The sum of the peak memory usage of all the vertices in the stage, in bytes.
    TotalPeakMemUsage *int64 `json:"totalPeakMemUsage,omitempty"`
    // TotalExecutionTime - READ-ONLY; The sum of the total execution time of all the vertices in the stage.
    TotalExecutionTime *string `json:"totalExecutionTime,omitempty"`
    // MaxDataReadVertex - the vertex with the maximum amount of data read.
    MaxDataReadVertex *StatisticsVertex `json:"maxDataReadVertex,omitempty"`
    // MaxExecutionTimeVertex - the vertex with the maximum execution time.
    MaxExecutionTimeVertex *StatisticsVertex `json:"maxExecutionTimeVertex,omitempty"`
    // MaxPeakMemUsageVertex - the vertex with the maximum peak memory usage.
    MaxPeakMemUsageVertex *StatisticsVertex `json:"maxPeakMemUsageVertex,omitempty"`
    // EstimatedVertexCPUCoreCount - READ-ONLY; The estimated vertex CPU core count.
    EstimatedVertexCPUCoreCount *int32 `json:"estimatedVertexCpuCoreCount,omitempty"`
    // EstimatedVertexPeakCPUCoreCount - READ-ONLY; The estimated vertex peak CPU core count.
    EstimatedVertexPeakCPUCoreCount *int32 `json:"estimatedVertexPeakCpuCoreCount,omitempty"`
    // EstimatedVertexMemSize - READ-ONLY; The estimated vertex memory size, in bytes.
    EstimatedVertexMemSize *int64 `json:"estimatedVertexMemSize,omitempty"`
    // AllocatedContainerCPUCoreCount - The statistics information for the allocated container CPU core count.
    AllocatedContainerCPUCoreCount *ResourceUsageStatistics `json:"allocatedContainerCpuCoreCount,omitempty"`
    // AllocatedContainerMemSize - The statistics information for the allocated container memory size.
    AllocatedContainerMemSize *ResourceUsageStatistics `json:"allocatedContainerMemSize,omitempty"`
    // UsedVertexCPUCoreCount - The statistics information for the used vertex CPU core count.
    UsedVertexCPUCoreCount *ResourceUsageStatistics `json:"usedVertexCpuCoreCount,omitempty"`
    // UsedVertexPeakMemSize - The statistics information for the used vertex peak memory size.
    UsedVertexPeakMemSize *ResourceUsageStatistics `json:"usedVertexPeakMemSize,omitempty"`
}

StatisticsVertexStage the Data Lake Analytics job statistics vertex stage information.

type Type Uses

type Type string

Type enumerates the values for type.

const (
    // TypeHive ...
    TypeHive Type = "Hive"
    // TypeJobProperties ...
    TypeJobProperties Type = "JobProperties"
    // TypeScope ...
    TypeScope Type = "Scope"
    // TypeUSQL ...
    TypeUSQL Type = "USql"
)

func PossibleTypeValues Uses

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type TypeBasicCreateJobProperties Uses

type TypeBasicCreateJobProperties string

TypeBasicCreateJobProperties enumerates the values for type basic create job properties.

const (
    // TypeBasicCreateJobPropertiesTypeCreateJobProperties ...
    TypeBasicCreateJobPropertiesTypeCreateJobProperties TypeBasicCreateJobProperties = "CreateJobProperties"
    // TypeBasicCreateJobPropertiesTypeScope ...
    TypeBasicCreateJobPropertiesTypeScope TypeBasicCreateJobProperties = "Scope"
    // TypeBasicCreateJobPropertiesTypeUSQL ...
    TypeBasicCreateJobPropertiesTypeUSQL TypeBasicCreateJobProperties = "USql"
)

func PossibleTypeBasicCreateJobPropertiesValues Uses

func PossibleTypeBasicCreateJobPropertiesValues() []TypeBasicCreateJobProperties

PossibleTypeBasicCreateJobPropertiesValues returns an array of possible values for the TypeBasicCreateJobProperties const type.

type TypeEnum Uses

type TypeEnum string

TypeEnum enumerates the values for type enum.

const (
    // Hive ...
    Hive TypeEnum = "Hive"
    // Scope ...
    Scope TypeEnum = "Scope"
    // USQL ...
    USQL TypeEnum = "USql"
)

func PossibleTypeEnumValues Uses

func PossibleTypeEnumValues() []TypeEnum

PossibleTypeEnumValues returns an array of possible values for the TypeEnum const type.

type USQLJobProperties Uses

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"`
    // 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"`
    // TotalPausedTime - 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.
    TotalPausedTime *string `json:"totalPausedTime,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 - 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', 'TypeScope'
    Type Type `json:"type,omitempty"`
}

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

func (USQLJobProperties) AsBasicProperties Uses

func (usjp USQLJobProperties) AsBasicProperties() (BasicProperties, bool)

AsBasicProperties is the BasicProperties implementation for USQLJobProperties.

func (USQLJobProperties) AsHiveJobProperties Uses

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

AsHiveJobProperties is the BasicProperties implementation for USQLJobProperties.

func (USQLJobProperties) AsProperties Uses

func (usjp USQLJobProperties) AsProperties() (*Properties, bool)

AsProperties is the BasicProperties implementation for USQLJobProperties.

func (USQLJobProperties) AsScopeJobProperties Uses

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

AsScopeJobProperties is the BasicProperties implementation for USQLJobProperties.

func (USQLJobProperties) AsUSQLJobProperties Uses

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

AsUSQLJobProperties is the BasicProperties implementation for USQLJobProperties.

func (USQLJobProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for USQLJobProperties.

type UpdateFuture Uses

type UpdateFuture struct {
    azure.Future
}

UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*UpdateFuture) Result Uses

func (future *UpdateFuture) Result(client Client) (i Information, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type UpdateJobParameters Uses

type UpdateJobParameters struct {
    // DegreeOfParallelism - The degree of parallelism used for this job.
    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"`
    // Tags - The key-value pairs used to add additional metadata to the job information.
    Tags map[string]*string `json:"tags"`
}

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

func (UpdateJobParameters) MarshalJSON Uses

func (ujp UpdateJobParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateJobParameters.

type YieldFuture Uses

type YieldFuture struct {
    azure.Future
}

YieldFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*YieldFuture) Result Uses

func (future *YieldFuture) Result(client Client) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

Directories

PathSynopsis
jobapi

Package job imports 11 packages (graph) and is imported by 4 packages. Updated 2019-08-05. Refresh now. Tools for package owners.