jobstepexecutions

package
v0.20230710.1102917 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/jobstepexecutions Documentation

The jobstepexecutions SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2022-11-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/jobstepexecutions"

Client Initialization

client := jobstepexecutions.NewJobStepExecutionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobStepExecutionsClient.Get

ctx := context.TODO()
id := jobstepexecutions.NewExecutionStepID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "jobValue", "jobExecutionIdValue", "stepValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: JobStepExecutionsClient.ListByJobExecution

ctx := context.TODO()
id := jobstepexecutions.NewExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "jobValue", "jobExecutionIdValue")

// alternatively `client.ListByJobExecution(ctx, id, jobstepexecutions.DefaultListByJobExecutionOperationOptions())` can be used to do batched pagination
items, err := client.ListByJobExecutionComplete(ctx, id, jobstepexecutions.DefaultListByJobExecutionOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForJobExecutionLifecycle

func PossibleValuesForJobExecutionLifecycle() []string

func PossibleValuesForJobTargetType

func PossibleValuesForJobTargetType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateExecutionID

func ValidateExecutionID(input interface{}, key string) (warnings []string, errors []error)

ValidateExecutionID checks that 'input' can be parsed as a Execution ID

func ValidateExecutionStepID

func ValidateExecutionStepID(input interface{}, key string) (warnings []string, errors []error)

ValidateExecutionStepID checks that 'input' can be parsed as a Execution Step ID

Types

type ExecutionId

type ExecutionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	JobAgentName      string
	JobName           string
	JobExecutionId    string
}

ExecutionId is a struct representing the Resource ID for a Execution

func NewExecutionID

func NewExecutionID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string, jobName string, jobExecutionId string) ExecutionId

NewExecutionID returns a new ExecutionId struct

func ParseExecutionID

func ParseExecutionID(input string) (*ExecutionId, error)

ParseExecutionID parses 'input' into a ExecutionId

func ParseExecutionIDInsensitively

func ParseExecutionIDInsensitively(input string) (*ExecutionId, error)

ParseExecutionIDInsensitively parses 'input' case-insensitively into a ExecutionId note: this method should only be used for API response data and not user input

func (ExecutionId) ID

func (id ExecutionId) ID() string

ID returns the formatted Execution ID

func (ExecutionId) Segments

func (id ExecutionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Execution ID

func (ExecutionId) String

func (id ExecutionId) String() string

String returns a human-readable description of this Execution ID

type ExecutionStepId

type ExecutionStepId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	JobAgentName      string
	JobName           string
	JobExecutionId    string
	StepName          string
}

ExecutionStepId is a struct representing the Resource ID for a Execution Step

func NewExecutionStepID

func NewExecutionStepID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string, jobName string, jobExecutionId string, stepName string) ExecutionStepId

NewExecutionStepID returns a new ExecutionStepId struct

func ParseExecutionStepID

func ParseExecutionStepID(input string) (*ExecutionStepId, error)

ParseExecutionStepID parses 'input' into a ExecutionStepId

func ParseExecutionStepIDInsensitively

func ParseExecutionStepIDInsensitively(input string) (*ExecutionStepId, error)

ParseExecutionStepIDInsensitively parses 'input' case-insensitively into a ExecutionStepId note: this method should only be used for API response data and not user input

func (ExecutionStepId) ID

func (id ExecutionStepId) ID() string

ID returns the formatted Execution Step ID

func (ExecutionStepId) Segments

func (id ExecutionStepId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Execution Step ID

func (ExecutionStepId) String

func (id ExecutionStepId) String() string

String returns a human-readable description of this Execution Step ID

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobExecution
}

type JobExecution

type JobExecution struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *JobExecutionProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type JobExecutionLifecycle

type JobExecutionLifecycle string
const (
	JobExecutionLifecycleCanceled                     JobExecutionLifecycle = "Canceled"
	JobExecutionLifecycleCreated                      JobExecutionLifecycle = "Created"
	JobExecutionLifecycleFailed                       JobExecutionLifecycle = "Failed"
	JobExecutionLifecycleInProgress                   JobExecutionLifecycle = "InProgress"
	JobExecutionLifecycleSkipped                      JobExecutionLifecycle = "Skipped"
	JobExecutionLifecycleSucceeded                    JobExecutionLifecycle = "Succeeded"
	JobExecutionLifecycleSucceededWithSkipped         JobExecutionLifecycle = "SucceededWithSkipped"
	JobExecutionLifecycleTimedOut                     JobExecutionLifecycle = "TimedOut"
	JobExecutionLifecycleWaitingForChildJobExecutions JobExecutionLifecycle = "WaitingForChildJobExecutions"
	JobExecutionLifecycleWaitingForRetry              JobExecutionLifecycle = "WaitingForRetry"
)

func (*JobExecutionLifecycle) UnmarshalJSON

func (s *JobExecutionLifecycle) UnmarshalJSON(bytes []byte) error

type JobExecutionOperationPredicate

type JobExecutionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (JobExecutionOperationPredicate) Matches

type JobExecutionProperties

type JobExecutionProperties struct {
	CreateTime              *string                `json:"createTime,omitempty"`
	CurrentAttemptStartTime *string                `json:"currentAttemptStartTime,omitempty"`
	CurrentAttempts         *int64                 `json:"currentAttempts,omitempty"`
	EndTime                 *string                `json:"endTime,omitempty"`
	JobExecutionId          *string                `json:"jobExecutionId,omitempty"`
	JobVersion              *int64                 `json:"jobVersion,omitempty"`
	LastMessage             *string                `json:"lastMessage,omitempty"`
	Lifecycle               *JobExecutionLifecycle `json:"lifecycle,omitempty"`
	ProvisioningState       *ProvisioningState     `json:"provisioningState,omitempty"`
	StartTime               *string                `json:"startTime,omitempty"`
	StepId                  *int64                 `json:"stepId,omitempty"`
	StepName                *string                `json:"stepName,omitempty"`
	Target                  *JobExecutionTarget    `json:"target,omitempty"`
}

func (*JobExecutionProperties) GetCreateTimeAsTime

func (o *JobExecutionProperties) GetCreateTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) GetCurrentAttemptStartTimeAsTime

func (o *JobExecutionProperties) GetCurrentAttemptStartTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) GetEndTimeAsTime

func (o *JobExecutionProperties) GetEndTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) GetStartTimeAsTime

func (o *JobExecutionProperties) GetStartTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) SetCreateTimeAsTime

func (o *JobExecutionProperties) SetCreateTimeAsTime(input time.Time)

func (*JobExecutionProperties) SetCurrentAttemptStartTimeAsTime

func (o *JobExecutionProperties) SetCurrentAttemptStartTimeAsTime(input time.Time)

func (*JobExecutionProperties) SetEndTimeAsTime

func (o *JobExecutionProperties) SetEndTimeAsTime(input time.Time)

func (*JobExecutionProperties) SetStartTimeAsTime

func (o *JobExecutionProperties) SetStartTimeAsTime(input time.Time)

type JobExecutionTarget

type JobExecutionTarget struct {
	DatabaseName *string        `json:"databaseName,omitempty"`
	ServerName   *string        `json:"serverName,omitempty"`
	Type         *JobTargetType `json:"type,omitempty"`
}

type JobStepExecutionsClient

type JobStepExecutionsClient struct {
	Client *resourcemanager.Client
}

func NewJobStepExecutionsClientWithBaseURI

func NewJobStepExecutionsClientWithBaseURI(api environments.Api) (*JobStepExecutionsClient, error)

func (JobStepExecutionsClient) Get

Get ...

func (JobStepExecutionsClient) ListByJobExecution

ListByJobExecution ...

func (JobStepExecutionsClient) ListByJobExecutionComplete

ListByJobExecutionComplete retrieves all the results into a single object

func (JobStepExecutionsClient) ListByJobExecutionCompleteMatchingPredicate

func (c JobStepExecutionsClient) ListByJobExecutionCompleteMatchingPredicate(ctx context.Context, id ExecutionId, options ListByJobExecutionOperationOptions, predicate JobExecutionOperationPredicate) (result ListByJobExecutionCompleteResult, err error)

ListByJobExecutionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type JobTargetType

type JobTargetType string
const (
	JobTargetTypeSqlDatabase    JobTargetType = "SqlDatabase"
	JobTargetTypeSqlElasticPool JobTargetType = "SqlElasticPool"
	JobTargetTypeSqlServer      JobTargetType = "SqlServer"
	JobTargetTypeSqlShardMap    JobTargetType = "SqlShardMap"
	JobTargetTypeTargetGroup    JobTargetType = "TargetGroup"
)

func (*JobTargetType) UnmarshalJSON

func (s *JobTargetType) UnmarshalJSON(bytes []byte) error

type ListByJobExecutionCompleteResult

type ListByJobExecutionCompleteResult struct {
	Items []JobExecution
}

type ListByJobExecutionOperationOptions

type ListByJobExecutionOperationOptions struct {
	CreateTimeMax *string
	CreateTimeMin *string
	EndTimeMax    *string
	EndTimeMin    *string
	IsActive      *bool
	Skip          *int64
	Top           *int64
}

func DefaultListByJobExecutionOperationOptions

func DefaultListByJobExecutionOperationOptions() ListByJobExecutionOperationOptions

func (ListByJobExecutionOperationOptions) ToHeaders

func (ListByJobExecutionOperationOptions) ToOData

func (ListByJobExecutionOperationOptions) ToQuery

type ListByJobExecutionOperationResponse

type ListByJobExecutionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobExecution
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateCreated    ProvisioningState = "Created"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL