scheduler

package
v5.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2016 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package scheduler implements the Azure ARM Scheduler service API version 2016-03-01.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Scheduler
	APIVersion = "2016-03-01"

	// DefaultBaseURI is the default URI used for the service Scheduler
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type BasicAuthentication 

type BasicAuthentication struct {
	Type     HTTPAuthenticationType `json:"type,omitempty"`
	Username *string                `json:"username,omitempty"`
	Password *string                `json:"password,omitempty"`
}

BasicAuthentication is

type ClientCertAuthentication 

type ClientCertAuthentication struct {
	Type                      HTTPAuthenticationType `json:"type,omitempty"`
	Password                  *string                `json:"password,omitempty"`
	Pfx                       *string                `json:"pfx,omitempty"`
	CertificateThumbprint     *string                `json:"certificateThumbprint,omitempty"`
	CertificateExpirationDate *date.Time             `json:"certificateExpirationDate,omitempty"`
	CertificateSubjectName    *string                `json:"certificateSubjectName,omitempty"`
}

ClientCertAuthentication is

type DayOfWeek 

type DayOfWeek string

DayOfWeek enumerates the values for day of week. 

const (
	// Friday specifies the friday state for day of week.
	Friday DayOfWeek = "Friday"
	// Monday specifies the monday state for day of week.
	Monday DayOfWeek = "Monday"
	// Saturday specifies the saturday state for day of week.
	Saturday DayOfWeek = "Saturday"
	// Sunday specifies the sunday state for day of week.
	Sunday DayOfWeek = "Sunday"
	// Thursday specifies the thursday state for day of week.
	Thursday DayOfWeek = "Thursday"
	// Tuesday specifies the tuesday state for day of week.
	Tuesday DayOfWeek = "Tuesday"
	// Wednesday specifies the wednesday state for day of week.
	Wednesday DayOfWeek = "Wednesday"
)

type HTTPAuthentication 

type HTTPAuthentication struct {
	Type HTTPAuthenticationType `json:"type,omitempty"`
}

HTTPAuthentication is

type HTTPAuthenticationType 

type HTTPAuthenticationType string

HTTPAuthenticationType enumerates the values for http authentication type. 

const (
	// ActiveDirectoryOAuth specifies the active directory o auth state for
	// http authentication type.
	ActiveDirectoryOAuth HTTPAuthenticationType = "ActiveDirectoryOAuth"
	// Basic specifies the basic state for http authentication type.
	Basic HTTPAuthenticationType = "Basic"
	// ClientCertificate specifies the client certificate state for http
	// authentication type.
	ClientCertificate HTTPAuthenticationType = "ClientCertificate"
	// NotSpecified specifies the not specified state for http authentication
	// type.
	NotSpecified HTTPAuthenticationType = "NotSpecified"
)

type HTTPRequest 

type HTTPRequest struct {
	Authentication *HTTPAuthentication `json:"authentication,omitempty"`
	URI            *string             `json:"uri,omitempty"`
	Method         *string             `json:"method,omitempty"`
	Body           *string             `json:"body,omitempty"`
	Headers        *map[string]*string `json:"headers,omitempty"`
}

HTTPRequest is

type JobAction 

type JobAction struct {
	Type                   JobActionType           `json:"type,omitempty"`
	Request                *HTTPRequest            `json:"request,omitempty"`
	QueueMessage           *StorageQueueMessage    `json:"queueMessage,omitempty"`
	ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
	ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
	RetryPolicy            *RetryPolicy            `json:"retryPolicy,omitempty"`
	ErrorAction            *JobErrorAction         `json:"errorAction,omitempty"`
}

JobAction is

type JobActionType 

type JobActionType string

JobActionType enumerates the values for job action type. 

const (
	// HTTP specifies the http state for job action type.
	HTTP JobActionType = "Http"
	// HTTPS specifies the https state for job action type.
	HTTPS JobActionType = "Https"
	// ServiceBusQueue specifies the service bus queue state for job action
	// type.
	ServiceBusQueue JobActionType = "ServiceBusQueue"
	// ServiceBusTopic specifies the service bus topic state for job action
	// type.
	ServiceBusTopic JobActionType = "ServiceBusTopic"
	// StorageQueue specifies the storage queue state for job action type.
	StorageQueue JobActionType = "StorageQueue"
)

type JobCollectionDefinition 

type JobCollectionDefinition struct {
	autorest.Response `json:"-"`
	ID                *string                  `json:"id,omitempty"`
	Type              *string                  `json:"type,omitempty"`
	Name              *string                  `json:"name,omitempty"`
	Location          *string                  `json:"location,omitempty"`
	Tags              *map[string]*string      `json:"tags,omitempty"`
	Properties        *JobCollectionProperties `json:"properties,omitempty"`
}

JobCollectionDefinition is

type JobCollectionListResult 

type JobCollectionListResult struct {
	autorest.Response `json:"-"`
	Value             *[]JobCollectionDefinition `json:"value,omitempty"`
	NextLink          *string                    `json:"nextLink,omitempty"`
}

JobCollectionListResult is

func (JobCollectionListResult) JobCollectionListResultPreparer 

func (client JobCollectionListResult) JobCollectionListResultPreparer() (*http.Request, error)

JobCollectionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type JobCollectionProperties 

type JobCollectionProperties struct {
	Sku   *Sku                `json:"sku,omitempty"`
	State JobCollectionState  `json:"state,omitempty"`
	Quota *JobCollectionQuota `json:"quota,omitempty"`
}

JobCollectionProperties is

type JobCollectionQuota 

type JobCollectionQuota struct {
	MaxJobCount      *int32            `json:"maxJobCount,omitempty"`
	MaxJobOccurrence *int32            `json:"maxJobOccurrence,omitempty"`
	MaxRecurrence    *JobMaxRecurrence `json:"maxRecurrence,omitempty"`
}

JobCollectionQuota is

type JobCollectionState 

type JobCollectionState string

JobCollectionState enumerates the values for job collection state. 

const (
	// Deleted specifies the deleted state for job collection state.
	Deleted JobCollectionState = "Deleted"
	// Disabled specifies the disabled state for job collection state.
	Disabled JobCollectionState = "Disabled"
	// Enabled specifies the enabled state for job collection state.
	Enabled JobCollectionState = "Enabled"
	// Suspended specifies the suspended state for job collection state.
	Suspended JobCollectionState = "Suspended"
)

type JobCollectionsClient 

type JobCollectionsClient struct {
	ManagementClient
}

JobCollectionsClient is the client for the JobCollections methods of the Scheduler service.

func NewJobCollectionsClient 

func NewJobCollectionsClient(subscriptionID string) JobCollectionsClient

NewJobCollectionsClient creates an instance of the JobCollectionsClient client.

func NewJobCollectionsClientWithBaseURI 

func NewJobCollectionsClientWithBaseURI(baseURI string, subscriptionID string) JobCollectionsClient

NewJobCollectionsClientWithBaseURI creates an instance of the JobCollectionsClient client.

func (JobCollectionsClient) CreateOrUpdate 

func (client JobCollectionsClient) CreateOrUpdate(resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

CreateOrUpdate provisions a new job collection or updates an existing job collection.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobCollection is the job collection definition.

func (JobCollectionsClient) CreateOrUpdatePreparer 

func (client JobCollectionsClient) CreateOrUpdatePreparer(resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobCollectionsClient) CreateOrUpdateResponder 

func (client JobCollectionsClient) CreateOrUpdateResponder(resp *http.Response) (result JobCollectionDefinition, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (JobCollectionsClient) CreateOrUpdateSender 

func (client JobCollectionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Delete 

func (client JobCollectionsClient) Delete(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (result autorest.Response, err error)

Delete deletes a job collection. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name. jobCollectionName is the job collection name.

func (JobCollectionsClient) DeletePreparer 

func (client JobCollectionsClient) DeletePreparer(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobCollectionsClient) DeleteResponder 

func (client JobCollectionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobCollectionsClient) DeleteSender 

func (client JobCollectionsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Disable 

func (client JobCollectionsClient) Disable(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (result autorest.Response, err error)

Disable disables all of the jobs in the job collection. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name. jobCollectionName is the job collection name.

func (JobCollectionsClient) DisablePreparer 

func (client JobCollectionsClient) DisablePreparer(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (*http.Request, error)

DisablePreparer prepares the Disable request.

func (JobCollectionsClient) DisableResponder 

func (client JobCollectionsClient) DisableResponder(resp *http.Response) (result autorest.Response, err error)

DisableResponder handles the response to the Disable request. The method always closes the http.Response Body.

func (JobCollectionsClient) DisableSender 

func (client JobCollectionsClient) DisableSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Enable 

func (client JobCollectionsClient) Enable(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (result autorest.Response, err error)

Enable enables all of the jobs in the job collection. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name. jobCollectionName is the job collection name.

func (JobCollectionsClient) EnablePreparer 

func (client JobCollectionsClient) EnablePreparer(resourceGroupName string, jobCollectionName string, cancel <-chan struct{}) (*http.Request, error)

EnablePreparer prepares the Enable request.

func (JobCollectionsClient) EnableResponder 

func (client JobCollectionsClient) EnableResponder(resp *http.Response) (result autorest.Response, err error)

EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.

func (JobCollectionsClient) EnableSender 

func (client JobCollectionsClient) EnableSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Get 

func (client JobCollectionsClient) Get(resourceGroupName string, jobCollectionName string) (result JobCollectionDefinition, err error)

Get gets a job collection.

resourceGroupName is the resource group name. jobCollectionName is the job collection name.

func (JobCollectionsClient) GetPreparer 

func (client JobCollectionsClient) GetPreparer(resourceGroupName string, jobCollectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobCollectionsClient) GetResponder 

func (client JobCollectionsClient) GetResponder(resp *http.Response) (result JobCollectionDefinition, err error)

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

func (JobCollectionsClient) GetSender 

func (client JobCollectionsClient) 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 (JobCollectionsClient) ListByResourceGroup 

func (client JobCollectionsClient) ListByResourceGroup(resourceGroupName string) (result JobCollectionListResult, err error)

ListByResourceGroup gets all job collections under specified resource group.

resourceGroupName is the resource group name.

func (JobCollectionsClient) ListByResourceGroupNextResults 

func (client JobCollectionsClient) ListByResourceGroupNextResults(lastResults JobCollectionListResult) (result JobCollectionListResult, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (JobCollectionsClient) ListByResourceGroupPreparer 

func (client JobCollectionsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobCollectionsClient) ListByResourceGroupResponder 

func (client JobCollectionsClient) ListByResourceGroupResponder(resp *http.Response) (result JobCollectionListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (JobCollectionsClient) ListByResourceGroupSender 

func (client JobCollectionsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) ListBySubscription 

func (client JobCollectionsClient) ListBySubscription() (result JobCollectionListResult, err error)

ListBySubscription gets all job collections under specified subscription.

func (JobCollectionsClient) ListBySubscriptionNextResults 

func (client JobCollectionsClient) ListBySubscriptionNextResults(lastResults JobCollectionListResult) (result JobCollectionListResult, err error)

ListBySubscriptionNextResults retrieves the next set of results, if any.

func (JobCollectionsClient) ListBySubscriptionPreparer 

func (client JobCollectionsClient) ListBySubscriptionPreparer() (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (JobCollectionsClient) ListBySubscriptionResponder 

func (client JobCollectionsClient) ListBySubscriptionResponder(resp *http.Response) (result JobCollectionListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (JobCollectionsClient) ListBySubscriptionSender 

func (client JobCollectionsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Patch 

func (client JobCollectionsClient) Patch(resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

Patch patches an existing job collection.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobCollection is the job collection definition.

func (JobCollectionsClient) PatchPreparer 

func (client JobCollectionsClient) PatchPreparer(resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobCollectionsClient) PatchResponder 

func (client JobCollectionsClient) PatchResponder(resp *http.Response) (result JobCollectionDefinition, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (JobCollectionsClient) PatchSender 

func (client JobCollectionsClient) PatchSender(req *http.Request) (*http.Response, error)

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

type JobDefinition 

type JobDefinition struct {
	autorest.Response `json:"-"`
	ID                *string        `json:"id,omitempty"`
	Type              *string        `json:"type,omitempty"`
	Name              *string        `json:"name,omitempty"`
	Properties        *JobProperties `json:"properties,omitempty"`
}

JobDefinition is

type JobErrorAction 

type JobErrorAction struct {
	Type                   JobActionType           `json:"type,omitempty"`
	Request                *HTTPRequest            `json:"request,omitempty"`
	QueueMessage           *StorageQueueMessage    `json:"queueMessage,omitempty"`
	ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
	ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
	RetryPolicy            *RetryPolicy            `json:"retryPolicy,omitempty"`
}

JobErrorAction is

type JobExecutionStatus 

type JobExecutionStatus string

JobExecutionStatus enumerates the values for job execution status. 

const (
	// Completed specifies the completed state for job execution status.
	Completed JobExecutionStatus = "Completed"
	// Failed specifies the failed state for job execution status.
	Failed JobExecutionStatus = "Failed"
	// Postponed specifies the postponed state for job execution status.
	Postponed JobExecutionStatus = "Postponed"
)

type JobHistoryActionName 

type JobHistoryActionName string

JobHistoryActionName enumerates the values for job history action name. 

const (
	// ErrorAction specifies the error action state for job history action
	// name.
	ErrorAction JobHistoryActionName = "ErrorAction"
	// MainAction specifies the main action state for job history action name.
	MainAction JobHistoryActionName = "MainAction"
)

type JobHistoryDefinition 

type JobHistoryDefinition struct {
	ID         *string                         `json:"id,omitempty"`
	Type       *string                         `json:"type,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *JobHistoryDefinitionProperties `json:"properties,omitempty"`
}

JobHistoryDefinition is

type JobHistoryDefinitionProperties 

type JobHistoryDefinitionProperties struct {
	StartTime             *date.Time           `json:"startTime,omitempty"`
	EndTime               *date.Time           `json:"endTime,omitempty"`
	ExpectedExecutionTime *date.Time           `json:"expectedExecutionTime,omitempty"`
	ActionName            JobHistoryActionName `json:"actionName,omitempty"`
	Status                JobExecutionStatus   `json:"status,omitempty"`
	Message               *string              `json:"message,omitempty"`
	RetryCount            *int32               `json:"retryCount,omitempty"`
	RepeatCount           *int32               `json:"repeatCount,omitempty"`
}

JobHistoryDefinitionProperties is

type JobHistoryFilter 

type JobHistoryFilter struct {
	Status JobExecutionStatus `json:"status,omitempty"`
}

JobHistoryFilter is

type JobHistoryListResult 

type JobHistoryListResult struct {
	autorest.Response `json:"-"`
	Value             *[]JobHistoryDefinition `json:"value,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

JobHistoryListResult is

func (JobHistoryListResult) JobHistoryListResultPreparer 

func (client JobHistoryListResult) JobHistoryListResultPreparer() (*http.Request, error)

JobHistoryListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type JobListResult 

type JobListResult struct {
	autorest.Response `json:"-"`
	Value             *[]JobDefinition `json:"value,omitempty"`
	NextLink          *string          `json:"nextLink,omitempty"`
}

JobListResult is

func (JobListResult) JobListResultPreparer 

func (client JobListResult) JobListResultPreparer() (*http.Request, error)

JobListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type JobMaxRecurrence 

type JobMaxRecurrence struct {
	Frequency RecurrenceFrequency `json:"frequency,omitempty"`
	Interval  *int32              `json:"interval,omitempty"`
}

JobMaxRecurrence is

type JobProperties 

type JobProperties struct {
	StartTime  *date.Time     `json:"startTime,omitempty"`
	Action     *JobAction     `json:"action,omitempty"`
	Recurrence *JobRecurrence `json:"recurrence,omitempty"`
	State      JobState       `json:"state,omitempty"`
	Status     *JobStatus     `json:"status,omitempty"`
}

JobProperties is

type JobRecurrence 

type JobRecurrence struct {
	Frequency RecurrenceFrequency    `json:"frequency,omitempty"`
	Interval  *int32                 `json:"interval,omitempty"`
	Count     *int32                 `json:"count,omitempty"`
	EndTime   *date.Time             `json:"endTime,omitempty"`
	Schedule  *JobRecurrenceSchedule `json:"schedule,omitempty"`
}

JobRecurrence is

type JobRecurrenceSchedule 

type JobRecurrenceSchedule struct {
	WeekDays           *[]DayOfWeek                              `json:"weekDays,omitempty"`
	Hours              *[]int32                                  `json:"hours,omitempty"`
	Minutes            *[]int32                                  `json:"minutes,omitempty"`
	MonthDays          *[]int32                                  `json:"monthDays,omitempty"`
	MonthlyOccurrences *[]JobRecurrenceScheduleMonthlyOccurrence `json:"monthlyOccurrences,omitempty"`
}

JobRecurrenceSchedule is

type JobRecurrenceScheduleMonthlyOccurrence 

type JobRecurrenceScheduleMonthlyOccurrence struct {
	Day        JobScheduleDay `json:"day,omitempty"`
	Occurrence *int32         `json:"Occurrence,omitempty"`
}

JobRecurrenceScheduleMonthlyOccurrence is

type JobScheduleDay 

type JobScheduleDay string

JobScheduleDay enumerates the values for job schedule day. 

const (
	// JobScheduleDayFriday specifies the job schedule day friday state for
	// job schedule day.
	JobScheduleDayFriday JobScheduleDay = "Friday"
	// JobScheduleDayMonday specifies the job schedule day monday state for
	// job schedule day.
	JobScheduleDayMonday JobScheduleDay = "Monday"
	// JobScheduleDaySaturday specifies the job schedule day saturday state
	// for job schedule day.
	JobScheduleDaySaturday JobScheduleDay = "Saturday"
	// JobScheduleDaySunday specifies the job schedule day sunday state for
	// job schedule day.
	JobScheduleDaySunday JobScheduleDay = "Sunday"
	// JobScheduleDayThursday specifies the job schedule day thursday state
	// for job schedule day.
	JobScheduleDayThursday JobScheduleDay = "Thursday"
	// JobScheduleDayTuesday specifies the job schedule day tuesday state for
	// job schedule day.
	JobScheduleDayTuesday JobScheduleDay = "Tuesday"
	// JobScheduleDayWednesday specifies the job schedule day wednesday state
	// for job schedule day.
	JobScheduleDayWednesday JobScheduleDay = "Wednesday"
)

type JobState 

type JobState string

JobState enumerates the values for job state. 

const (
	// JobStateCompleted specifies the job state completed state for job state.
	JobStateCompleted JobState = "Completed"
	// JobStateDisabled specifies the job state disabled state for job state.
	JobStateDisabled JobState = "Disabled"
	// JobStateEnabled specifies the job state enabled state for job state.
	JobStateEnabled JobState = "Enabled"
	// JobStateFaulted specifies the job state faulted state for job state.
	JobStateFaulted JobState = "Faulted"
)

type JobStateFilter 

type JobStateFilter struct {
	State JobState `json:"state,omitempty"`
}

JobStateFilter is

type JobStatus 

type JobStatus struct {
	ExecutionCount    *int32     `json:"executionCount,omitempty"`
	FailureCount      *int32     `json:"failureCount,omitempty"`
	FaultedCount      *int32     `json:"faultedCount,omitempty"`
	LastExecutionTime *date.Time `json:"lastExecutionTime,omitempty"`
	NextExecutionTime *date.Time `json:"nextExecutionTime,omitempty"`
}

JobStatus is

type JobsClient 

type JobsClient struct {
	ManagementClient
}

JobsClient is the client for the Jobs methods of the Scheduler service.

func NewJobsClient 

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI 

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) CreateOrUpdate 

func (client JobsClient) CreateOrUpdate(resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

CreateOrUpdate provisions a new job or updates an existing job.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name. job is the job definition.

func (JobsClient) CreateOrUpdatePreparer 

func (client JobsClient) CreateOrUpdatePreparer(resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobsClient) CreateOrUpdateResponder 

func (client JobsClient) CreateOrUpdateResponder(resp *http.Response) (result JobDefinition, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (JobsClient) CreateOrUpdateSender 

func (client JobsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Delete 

func (client JobsClient) Delete(resourceGroupName string, jobCollectionName string, jobName string) (result autorest.Response, err error)

Delete deletes a job.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name.

func (JobsClient) DeletePreparer 

func (client JobsClient) DeletePreparer(resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder 

func (client JobsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobsClient) DeleteSender 

func (client JobsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Get 

func (client JobsClient) Get(resourceGroupName string, jobCollectionName string, jobName string) (result JobDefinition, err error)

Get gets a job.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name.

func (JobsClient) GetPreparer 

func (client JobsClient) GetPreparer(resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder 

func (client JobsClient) GetResponder(resp *http.Response) (result JobDefinition, err error)

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

func (JobsClient) GetSender 

func (client JobsClient) 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 (JobsClient) List 

func (client JobsClient) List(resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (result JobListResult, err error)

List lists all jobs under the specified job collection.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. top is the number of jobs to request, in the of range [1..100]. skip is the (0-based) index of the job history list from which to begin requesting entries. filter is the filter to apply on the job state.

func (JobsClient) ListJobHistory 

func (client JobsClient) ListJobHistory(resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (result JobHistoryListResult, err error)

ListJobHistory lists job history.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name. top is the number of job history to request, in the of range [1..100]. skip is the (0-based) index of the job history list from which to begin requesting entries. filter is the filter to apply on the job state.

func (JobsClient) ListJobHistoryNextResults 

func (client JobsClient) ListJobHistoryNextResults(lastResults JobHistoryListResult) (result JobHistoryListResult, err error)

ListJobHistoryNextResults retrieves the next set of results, if any.

func (JobsClient) ListJobHistoryPreparer 

func (client JobsClient) ListJobHistoryPreparer(resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (*http.Request, error)

ListJobHistoryPreparer prepares the ListJobHistory request.

func (JobsClient) ListJobHistoryResponder 

func (client JobsClient) ListJobHistoryResponder(resp *http.Response) (result JobHistoryListResult, err error)

ListJobHistoryResponder handles the response to the ListJobHistory request. The method always closes the http.Response Body.

func (JobsClient) ListJobHistorySender 

func (client JobsClient) ListJobHistorySender(req *http.Request) (*http.Response, error)

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

func (JobsClient) ListNextResults 

func (client JobsClient) ListNextResults(lastResults JobListResult) (result JobListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (JobsClient) ListPreparer 

func (client JobsClient) ListPreparer(resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListResponder 

func (client JobsClient) ListResponder(resp *http.Response) (result JobListResult, err error)

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

func (JobsClient) ListSender 

func (client JobsClient) 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 (JobsClient) Patch 

func (client JobsClient) Patch(resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

Patch patches an existing job.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name. job is the job definition.

func (JobsClient) PatchPreparer 

func (client JobsClient) PatchPreparer(resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobsClient) PatchResponder 

func (client JobsClient) PatchResponder(resp *http.Response) (result JobDefinition, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (JobsClient) PatchSender 

func (client JobsClient) PatchSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Run 

func (client JobsClient) Run(resourceGroupName string, jobCollectionName string, jobName string) (result autorest.Response, err error)

Run runs a job.

resourceGroupName is the resource group name. jobCollectionName is the job collection name. jobName is the job name.

func (JobsClient) RunPreparer 

func (client JobsClient) RunPreparer(resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

RunPreparer prepares the Run request.

func (JobsClient) RunResponder 

func (client JobsClient) RunResponder(resp *http.Response) (result autorest.Response, err error)

RunResponder handles the response to the Run request. The method always closes the http.Response Body.

func (JobsClient) RunSender 

func (client JobsClient) RunSender(req *http.Request) (*http.Response, error)

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

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Scheduler.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type OAuthAuthentication 

type OAuthAuthentication struct {
	Type     HTTPAuthenticationType `json:"type,omitempty"`
	Secret   *string                `json:"secret,omitempty"`
	Tenant   *string                `json:"tenant,omitempty"`
	Audience *string                `json:"audience,omitempty"`
	ClientID *string                `json:"clientId,omitempty"`
}

OAuthAuthentication is

type RecurrenceFrequency 

type RecurrenceFrequency string

RecurrenceFrequency enumerates the values for recurrence frequency. 

const (
	// Day specifies the day state for recurrence frequency.
	Day RecurrenceFrequency = "Day"
	// Hour specifies the hour state for recurrence frequency.
	Hour RecurrenceFrequency = "Hour"
	// Minute specifies the minute state for recurrence frequency.
	Minute RecurrenceFrequency = "Minute"
	// Month specifies the month state for recurrence frequency.
	Month RecurrenceFrequency = "Month"
	// Week specifies the week state for recurrence frequency.
	Week RecurrenceFrequency = "Week"
)

type RetryPolicy 

type RetryPolicy struct {
	RetryType     RetryType `json:"retryType,omitempty"`
	RetryInterval *string   `json:"retryInterval,omitempty"`
	RetryCount    *int32    `json:"retryCount,omitempty"`
}

RetryPolicy is

type RetryType 

type RetryType string

RetryType enumerates the values for retry type. 

const (
	// Fixed specifies the fixed state for retry type.
	Fixed RetryType = "Fixed"
	// None specifies the none state for retry type.
	None RetryType = "None"
)

type ServiceBusAuthentication 

type ServiceBusAuthentication struct {
	SasKey     *string                      `json:"sasKey,omitempty"`
	SasKeyName *string                      `json:"sasKeyName,omitempty"`
	Type       ServiceBusAuthenticationType `json:"type,omitempty"`
}

ServiceBusAuthentication is

type ServiceBusAuthenticationType 

type ServiceBusAuthenticationType string

ServiceBusAuthenticationType enumerates the values for service bus authentication type. 

const (
	// ServiceBusAuthenticationTypeNotSpecified specifies the service bus
	// authentication type not specified state for service bus authentication
	// type.
	ServiceBusAuthenticationTypeNotSpecified ServiceBusAuthenticationType = "NotSpecified"
	// ServiceBusAuthenticationTypeSharedAccessKey specifies the service bus
	// authentication type shared access key state for service bus
	// authentication type.
	ServiceBusAuthenticationTypeSharedAccessKey ServiceBusAuthenticationType = "SharedAccessKey"
)

type ServiceBusBrokeredMessageProperties 

type ServiceBusBrokeredMessageProperties struct {
	ContentType             *string    `json:"contentType,omitempty"`
	CorrelationID           *string    `json:"correlationId,omitempty"`
	ForcePersistence        *bool      `json:"forcePersistence,omitempty"`
	Label                   *string    `json:"label,omitempty"`
	MessageID               *string    `json:"messageId,omitempty"`
	PartitionKey            *string    `json:"partitionKey,omitempty"`
	ReplyTo                 *string    `json:"replyTo,omitempty"`
	ReplyToSessionID        *string    `json:"replyToSessionId,omitempty"`
	ScheduledEnqueueTimeUtc *date.Time `json:"scheduledEnqueueTimeUtc,omitempty"`
	SessionID               *string    `json:"sessionId,omitempty"`
	TimeToLive              *date.Time `json:"timeToLive,omitempty"`
	To                      *string    `json:"to,omitempty"`
	ViaPartitionKey         *string    `json:"viaPartitionKey,omitempty"`
}

ServiceBusBrokeredMessageProperties is

type ServiceBusMessage 

type ServiceBusMessage struct {
	Authentication            *ServiceBusAuthentication            `json:"authentication,omitempty"`
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	CustomMessageProperties   *map[string]*string                  `json:"customMessageProperties,omitempty"`
	Message                   *string                              `json:"message,omitempty"`
	Namespace                 *string                              `json:"namespace,omitempty"`
	TransportType             ServiceBusTransportType              `json:"transportType,omitempty"`
}

ServiceBusMessage is

type ServiceBusQueueMessage 

type ServiceBusQueueMessage struct {
	Authentication            *ServiceBusAuthentication            `json:"authentication,omitempty"`
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	CustomMessageProperties   *map[string]*string                  `json:"customMessageProperties,omitempty"`
	Message                   *string                              `json:"message,omitempty"`
	Namespace                 *string                              `json:"namespace,omitempty"`
	TransportType             ServiceBusTransportType              `json:"transportType,omitempty"`
	QueueName                 *string                              `json:"queueName,omitempty"`
}

ServiceBusQueueMessage is

type ServiceBusTopicMessage 

type ServiceBusTopicMessage struct {
	Authentication            *ServiceBusAuthentication            `json:"authentication,omitempty"`
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	CustomMessageProperties   *map[string]*string                  `json:"customMessageProperties,omitempty"`
	Message                   *string                              `json:"message,omitempty"`
	Namespace                 *string                              `json:"namespace,omitempty"`
	TransportType             ServiceBusTransportType              `json:"transportType,omitempty"`
	TopicPath                 *string                              `json:"topicPath,omitempty"`
}

ServiceBusTopicMessage is

type ServiceBusTransportType 

type ServiceBusTransportType string

ServiceBusTransportType enumerates the values for service bus transport type. 

const (
	// ServiceBusTransportTypeAMQP specifies the service bus transport type
	// amqp state for service bus transport type.
	ServiceBusTransportTypeAMQP ServiceBusTransportType = "AMQP"
	// ServiceBusTransportTypeNetMessaging specifies the service bus transport
	// type net messaging state for service bus transport type.
	ServiceBusTransportTypeNetMessaging ServiceBusTransportType = "NetMessaging"
	// ServiceBusTransportTypeNotSpecified specifies the service bus transport
	// type not specified state for service bus transport type.
	ServiceBusTransportTypeNotSpecified ServiceBusTransportType = "NotSpecified"
)

type Sku 

type Sku struct {
	Name SkuDefinition `json:"name,omitempty"`
}

Sku is

type SkuDefinition 

type SkuDefinition string

SkuDefinition enumerates the values for sku definition. 

const (
	// Free specifies the free state for sku definition.
	Free SkuDefinition = "Free"
	// P10Premium specifies the p10 premium state for sku definition.
	P10Premium SkuDefinition = "P10Premium"
	// P20Premium specifies the p20 premium state for sku definition.
	P20Premium SkuDefinition = "P20Premium"
	// Standard specifies the standard state for sku definition.
	Standard SkuDefinition = "Standard"
)

type StorageQueueMessage 

type StorageQueueMessage struct {
	StorageAccount *string `json:"storageAccount,omitempty"`
	QueueName      *string `json:"queueName,omitempty"`
	SasToken       *string `json:"sasToken,omitempty"`
	Message        *string `json:"message,omitempty"`
}

StorageQueueMessage is

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.