azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/scheduler/mgmt/2016-01-01/scheduler Index | Files | Directories

package scheduler

import "github.com/Azure/azure-sdk-for-go/services/scheduler/mgmt/2016-01-01/scheduler"

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

Index

Package Files

client.go enums.go jobcollections.go jobs.go models.go version.go

Constants

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

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
    BaseURI        string
    SubscriptionID string
}

BaseClient is the base client for Scheduler.

func New Uses

❖
func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

❖
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicAuthentication Uses

❖
type BasicAuthentication struct {
    // Username - Gets or sets the username.
    Username *string `json:"username,omitempty"`
    // Password - Gets or sets the password.
    Password *string `json:"password,omitempty"`
    // Type - Gets or sets the http authentication type. Possible values include: 'NotSpecified', 'ClientCertificate', 'ActiveDirectoryOAuth', 'Basic'
    Type HTTPAuthenticationType `json:"type,omitempty"`
}

BasicAuthentication ...

type ClientCertAuthentication Uses

❖
type ClientCertAuthentication struct {
    // Password - Gets or sets the password.
    Password *string `json:"password,omitempty"`
    // Pfx - Gets or sets the pfx.
    Pfx *string `json:"pfx,omitempty"`
    // CertificateThumbprint - Gets or sets the certificate thumbprint.
    CertificateThumbprint *string `json:"certificateThumbprint,omitempty"`
    // CertificateExpirationDate - Gets or sets the certificate expiration date.
    CertificateExpirationDate *date.Time `json:"certificateExpirationDate,omitempty"`
    // CertificateSubjectName - Gets or sets the certificate subject name.
    CertificateSubjectName *string `json:"certificateSubjectName,omitempty"`
    // Type - Gets or sets the http authentication type. Possible values include: 'NotSpecified', 'ClientCertificate', 'ActiveDirectoryOAuth', 'Basic'
    Type HTTPAuthenticationType `json:"type,omitempty"`
}

ClientCertAuthentication ...

type DayOfWeek Uses

❖
type DayOfWeek string

DayOfWeek enumerates the values for day of week.

❖
const (
    // Friday ...
    Friday DayOfWeek = "Friday"
    // Monday ...
    Monday DayOfWeek = "Monday"
    // Saturday ...
    Saturday DayOfWeek = "Saturday"
    // Sunday ...
    Sunday DayOfWeek = "Sunday"
    // Thursday ...
    Thursday DayOfWeek = "Thursday"
    // Tuesday ...
    Tuesday DayOfWeek = "Tuesday"
    // Wednesday ...
    Wednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues Uses

❖
func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.

type HTTPAuthentication Uses

❖
type HTTPAuthentication struct {
    // Type - Gets or sets the http authentication type. Possible values include: 'NotSpecified', 'ClientCertificate', 'ActiveDirectoryOAuth', 'Basic'
    Type HTTPAuthenticationType `json:"type,omitempty"`
}

HTTPAuthentication ...

type HTTPAuthenticationType Uses

❖
type HTTPAuthenticationType string

HTTPAuthenticationType enumerates the values for http authentication type.

❖
const (
    // ActiveDirectoryOAuth ...
    ActiveDirectoryOAuth HTTPAuthenticationType = "ActiveDirectoryOAuth"
    // Basic ...
    Basic HTTPAuthenticationType = "Basic"
    // ClientCertificate ...
    ClientCertificate HTTPAuthenticationType = "ClientCertificate"
    // NotSpecified ...
    NotSpecified HTTPAuthenticationType = "NotSpecified"
)

func PossibleHTTPAuthenticationTypeValues Uses

❖
func PossibleHTTPAuthenticationTypeValues() []HTTPAuthenticationType

PossibleHTTPAuthenticationTypeValues returns an array of possible values for the HTTPAuthenticationType const type.

type HTTPRequest Uses

❖
type HTTPRequest struct {
    // Authentication - Gets or sets the http authentication.
    Authentication *HTTPAuthentication `json:"authentication,omitempty"`
    // URI - Gets or sets the Uri.
    URI *string `json:"uri,omitempty"`
    // Method - Gets or sets the method of the request.
    Method *string `json:"method,omitempty"`
    // Body - Gets or sets the request body.
    Body *string `json:"body,omitempty"`
    // Headers - Gets or sets the headers.
    Headers map[string]*string `json:"headers"`
}

HTTPRequest ...

func (HTTPRequest) MarshalJSON Uses

❖
func (hr HTTPRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HTTPRequest.

type JobAction Uses

❖
type JobAction struct {
    // Type - Gets or sets the job action type. Possible values include: 'HTTP', 'HTTPS', 'StorageQueue', 'ServiceBusQueue', 'ServiceBusTopic'
    Type JobActionType `json:"type,omitempty"`
    // Request - Gets or sets the http requests.
    Request *HTTPRequest `json:"request,omitempty"`
    // QueueMessage - Gets or sets the storage queue message.
    QueueMessage *StorageQueueMessage `json:"queueMessage,omitempty"`
    // ServiceBusQueueMessage - Gets or sets the service bus queue message.
    ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
    // ServiceBusTopicMessage - Gets or sets the service bus topic message.
    ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
    // RetryPolicy - Gets or sets the retry policy.
    RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
    // ErrorAction - Gets or sets the error action.
    ErrorAction *JobErrorAction `json:"errorAction,omitempty"`
}

JobAction ...

type JobActionType Uses

❖
type JobActionType string

JobActionType enumerates the values for job action type.

❖
const (
    // HTTP ...
    HTTP JobActionType = "Http"
    // HTTPS ...
    HTTPS JobActionType = "Https"
    // ServiceBusQueue ...
    ServiceBusQueue JobActionType = "ServiceBusQueue"
    // ServiceBusTopic ...
    ServiceBusTopic JobActionType = "ServiceBusTopic"
    // StorageQueue ...
    StorageQueue JobActionType = "StorageQueue"
)

func PossibleJobActionTypeValues Uses

❖
func PossibleJobActionTypeValues() []JobActionType

PossibleJobActionTypeValues returns an array of possible values for the JobActionType const type.

type JobCollectionDefinition Uses

❖
type JobCollectionDefinition struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Gets the job collection resource identifier.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Gets the job collection resource type.
    Type *string `json:"type,omitempty"`
    // Name - Gets or sets the job collection resource name.
    Name *string `json:"name,omitempty"`
    // Location - Gets or sets the storage account location.
    Location *string `json:"location,omitempty"`
    // Tags - Gets or sets the tags.
    Tags map[string]*string `json:"tags"`
    // Properties - Gets or sets the job collection properties.
    Properties *JobCollectionProperties `json:"properties,omitempty"`
}

JobCollectionDefinition ...

func (JobCollectionDefinition) MarshalJSON Uses

❖
func (jcd JobCollectionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobCollectionDefinition.

type JobCollectionListResult Uses

❖
type JobCollectionListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; Gets the job collections.
    Value *[]JobCollectionDefinition `json:"value,omitempty"`
    // NextLink - Gets or sets the URL to get the next set of job collections.
    NextLink *string `json:"nextLink,omitempty"`
}

JobCollectionListResult ...

func (JobCollectionListResult) IsEmpty Uses

❖
func (jclr JobCollectionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (JobCollectionListResult) MarshalJSON Uses

❖
func (jclr JobCollectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobCollectionListResult.

type JobCollectionListResultIterator Uses

❖
type JobCollectionListResultIterator struct {
    // contains filtered or unexported fields
}

JobCollectionListResultIterator provides access to a complete listing of JobCollectionDefinition values.

func NewJobCollectionListResultIterator Uses

❖
func NewJobCollectionListResultIterator(page JobCollectionListResultPage) JobCollectionListResultIterator

Creates a new instance of the JobCollectionListResultIterator type.

func (*JobCollectionListResultIterator) Next Uses

❖
func (iter *JobCollectionListResultIterator) 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 (*JobCollectionListResultIterator) NextWithContext Uses

❖
func (iter *JobCollectionListResultIterator) 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 (JobCollectionListResultIterator) NotDone Uses

❖
func (iter JobCollectionListResultIterator) NotDone() bool

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

func (JobCollectionListResultIterator) Response Uses

❖
func (iter JobCollectionListResultIterator) Response() JobCollectionListResult

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

func (JobCollectionListResultIterator) Value Uses

❖
func (iter JobCollectionListResultIterator) Value() JobCollectionDefinition

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobCollectionListResultPage Uses

❖
type JobCollectionListResultPage struct {
    // contains filtered or unexported fields
}

JobCollectionListResultPage contains a page of JobCollectionDefinition values.

func NewJobCollectionListResultPage Uses

❖
func NewJobCollectionListResultPage(cur JobCollectionListResult, getNextPage func(context.Context, JobCollectionListResult) (JobCollectionListResult, error)) JobCollectionListResultPage

Creates a new instance of the JobCollectionListResultPage type.

func (*JobCollectionListResultPage) Next Uses

❖
func (page *JobCollectionListResultPage) 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 (*JobCollectionListResultPage) NextWithContext Uses

❖
func (page *JobCollectionListResultPage) 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 (JobCollectionListResultPage) NotDone Uses

❖
func (page JobCollectionListResultPage) NotDone() bool

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

func (JobCollectionListResultPage) Response Uses

❖
func (page JobCollectionListResultPage) Response() JobCollectionListResult

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

func (JobCollectionListResultPage) Values Uses

❖
func (page JobCollectionListResultPage) Values() []JobCollectionDefinition

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

type JobCollectionProperties Uses

❖
type JobCollectionProperties struct {
    // Sku - Gets or sets the SKU.
    Sku *Sku `json:"sku,omitempty"`
    // State - Gets or sets the state. Possible values include: 'Enabled', 'Disabled', 'Suspended', 'Deleted'
    State JobCollectionState `json:"state,omitempty"`
    // Quota - Gets or sets the job collection quota.
    Quota *JobCollectionQuota `json:"quota,omitempty"`
}

JobCollectionProperties ...

type JobCollectionQuota Uses

❖
type JobCollectionQuota struct {
    // MaxJobCount - Gets or set the maximum job count.
    MaxJobCount *int32 `json:"maxJobCount,omitempty"`
    // MaxJobOccurrence - Gets or sets the maximum job occurrence.
    MaxJobOccurrence *int32 `json:"maxJobOccurrence,omitempty"`
    // MaxRecurrence - Gets or set the maximum recurrence.
    MaxRecurrence *JobMaxRecurrence `json:"maxRecurrence,omitempty"`
}

JobCollectionQuota ...

type JobCollectionState Uses

❖
type JobCollectionState string

JobCollectionState enumerates the values for job collection state.

❖
const (
    // Deleted ...
    Deleted JobCollectionState = "Deleted"
    // Disabled ...
    Disabled JobCollectionState = "Disabled"
    // Enabled ...
    Enabled JobCollectionState = "Enabled"
    // Suspended ...
    Suspended JobCollectionState = "Suspended"
)

func PossibleJobCollectionStateValues Uses

❖
func PossibleJobCollectionStateValues() []JobCollectionState

PossibleJobCollectionStateValues returns an array of possible values for the JobCollectionState const type.

type JobCollectionsClient Uses

❖
type JobCollectionsClient struct {
    BaseClient
}

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

func NewJobCollectionsClient Uses

❖
func NewJobCollectionsClient(subscriptionID string) JobCollectionsClient

NewJobCollectionsClient creates an instance of the JobCollectionsClient client.

func NewJobCollectionsClientWithBaseURI Uses

❖
func NewJobCollectionsClientWithBaseURI(baseURI string, subscriptionID string) JobCollectionsClient

NewJobCollectionsClientWithBaseURI creates an instance of the JobCollectionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (JobCollectionsClient) CreateOrUpdate Uses

❖
func (client JobCollectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

CreateOrUpdate provisions a new job collection or updates an existing job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobCollection - the job collection definition.

func (JobCollectionsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobCollectionsClient) CreateOrUpdateResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) Delete(ctx context.Context, resourceGroupName string, jobCollectionName string) (result autorest.Response, err error)

Delete deletes a job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) DeletePreparer Uses

❖
func (client JobCollectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobCollectionsClient) DeleteResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) Disable(ctx context.Context, resourceGroupName string, jobCollectionName string) (result autorest.Response, err error)

Disable disables all of the jobs in the job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) DisablePreparer Uses

❖
func (client JobCollectionsClient) DisablePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

DisablePreparer prepares the Disable request.

func (JobCollectionsClient) DisableResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) Enable(ctx context.Context, resourceGroupName string, jobCollectionName string) (result autorest.Response, err error)

Enable enables all of the jobs in the job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) EnablePreparer Uses

❖
func (client JobCollectionsClient) EnablePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

EnablePreparer prepares the Enable request.

func (JobCollectionsClient) EnableResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string) (result JobCollectionDefinition, err error)

Get gets a job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) GetPreparer Uses

❖
func (client JobCollectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobCollectionsClient) GetResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result JobCollectionListResultPage, err error)

ListByResourceGroup gets all job collections under specified resource group. Parameters: resourceGroupName - the resource group name.

func (JobCollectionsClient) ListByResourceGroupComplete Uses

❖
func (client JobCollectionsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result JobCollectionListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (JobCollectionsClient) ListByResourceGroupPreparer Uses

❖
func (client JobCollectionsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobCollectionsClient) ListByResourceGroupResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) ListBySubscription(ctx context.Context) (result JobCollectionListResultPage, err error)

ListBySubscription gets all job collections under specified subscription.

func (JobCollectionsClient) ListBySubscriptionComplete Uses

❖
func (client JobCollectionsClient) ListBySubscriptionComplete(ctx context.Context) (result JobCollectionListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (JobCollectionsClient) ListBySubscriptionPreparer Uses

❖
func (client JobCollectionsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (JobCollectionsClient) ListBySubscriptionResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobCollectionsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

Patch patches an existing job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobCollection - the job collection definition.

func (JobCollectionsClient) PatchPreparer Uses

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

PatchPreparer prepares the Patch request.

func (JobCollectionsClient) PatchResponder Uses

❖
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 Uses

❖
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 Uses

❖
type JobDefinition struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Gets the job resource identifier.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Gets the job resource type.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Gets the job resource name.
    Name *string `json:"name,omitempty"`
    // Properties - Gets or sets the job properties.
    Properties *JobProperties `json:"properties,omitempty"`
}

JobDefinition ...

func (JobDefinition) MarshalJSON Uses

❖
func (jd JobDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDefinition.

type JobErrorAction Uses

❖
type JobErrorAction struct {
    // Type - Gets or sets the job error action type. Possible values include: 'HTTP', 'HTTPS', 'StorageQueue', 'ServiceBusQueue', 'ServiceBusTopic'
    Type JobActionType `json:"type,omitempty"`
    // Request - Gets or sets the http requests.
    Request *HTTPRequest `json:"request,omitempty"`
    // QueueMessage - Gets or sets the storage queue message.
    QueueMessage *StorageQueueMessage `json:"queueMessage,omitempty"`
    // ServiceBusQueueMessage - Gets or sets the service bus queue message.
    ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
    // ServiceBusTopicMessage - Gets or sets the service bus topic message.
    ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
    // RetryPolicy - Gets or sets the retry policy.
    RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
}

JobErrorAction ...

type JobExecutionStatus Uses

❖
type JobExecutionStatus string

JobExecutionStatus enumerates the values for job execution status.

❖
const (
    // Completed ...
    Completed JobExecutionStatus = "Completed"
    // Failed ...
    Failed JobExecutionStatus = "Failed"
    // Postponed ...
    Postponed JobExecutionStatus = "Postponed"
)

func PossibleJobExecutionStatusValues Uses

❖
func PossibleJobExecutionStatusValues() []JobExecutionStatus

PossibleJobExecutionStatusValues returns an array of possible values for the JobExecutionStatus const type.

type JobHistoryActionName Uses

❖
type JobHistoryActionName string

JobHistoryActionName enumerates the values for job history action name.

❖
const (
    // ErrorAction ...
    ErrorAction JobHistoryActionName = "ErrorAction"
    // MainAction ...
    MainAction JobHistoryActionName = "MainAction"
)

func PossibleJobHistoryActionNameValues Uses

❖
func PossibleJobHistoryActionNameValues() []JobHistoryActionName

PossibleJobHistoryActionNameValues returns an array of possible values for the JobHistoryActionName const type.

type JobHistoryDefinition Uses

❖
type JobHistoryDefinition struct {
    // ID - READ-ONLY; Gets the job history identifier.
    ID  *string `json:"id,omitempty"`
    // Type - READ-ONLY; Gets the job history resource type.
    Type *string `json:"type,omitempty"`
    // Name - READ-ONLY; Gets the job history name.
    Name *string `json:"name,omitempty"`
    // Properties - READ-ONLY; Gets or sets the job history properties.
    Properties *JobHistoryDefinitionProperties `json:"properties,omitempty"`
}

JobHistoryDefinition ...

type JobHistoryDefinitionProperties Uses

❖
type JobHistoryDefinitionProperties struct {
    // StartTime - READ-ONLY; Gets the start time for this job.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - READ-ONLY; Gets the end time for this job.
    EndTime *date.Time `json:"endTime,omitempty"`
    // ExpectedExecutionTime - READ-ONLY; Gets the expected execution time for this job.
    ExpectedExecutionTime *date.Time `json:"expectedExecutionTime,omitempty"`
    // ActionName - READ-ONLY; Gets the job history action name. Possible values include: 'MainAction', 'ErrorAction'
    ActionName JobHistoryActionName `json:"actionName,omitempty"`
    // Status - READ-ONLY; Gets the job history status. Possible values include: 'Completed', 'Failed', 'Postponed'
    Status JobExecutionStatus `json:"status,omitempty"`
    // Message - READ-ONLY; Gets the message for the job history.
    Message *string `json:"message,omitempty"`
    // RetryCount - READ-ONLY; Gets the retry count for job.
    RetryCount *int32 `json:"retryCount,omitempty"`
    // RepeatCount - READ-ONLY; Gets the repeat count for the job.
    RepeatCount *int32 `json:"repeatCount,omitempty"`
}

JobHistoryDefinitionProperties ...

type JobHistoryFilter Uses

❖
type JobHistoryFilter struct {
    // Status - Gets or sets the job execution status. Possible values include: 'Completed', 'Failed', 'Postponed'
    Status JobExecutionStatus `json:"status,omitempty"`
}

JobHistoryFilter ...

type JobHistoryListResult Uses

❖
type JobHistoryListResult struct {
    autorest.Response `json:"-"`
    // Value - Gets or sets the job histories under job.
    Value *[]JobHistoryDefinition `json:"value,omitempty"`
    // NextLink - Gets or sets the URL to get the next set of job histories.
    NextLink *string `json:"nextLink,omitempty"`
}

JobHistoryListResult ...

func (JobHistoryListResult) IsEmpty Uses

❖
func (jhlr JobHistoryListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobHistoryListResultIterator Uses

❖
type JobHistoryListResultIterator struct {
    // contains filtered or unexported fields
}

JobHistoryListResultIterator provides access to a complete listing of JobHistoryDefinition values.

func NewJobHistoryListResultIterator Uses

❖
func NewJobHistoryListResultIterator(page JobHistoryListResultPage) JobHistoryListResultIterator

Creates a new instance of the JobHistoryListResultIterator type.

func (*JobHistoryListResultIterator) Next Uses

❖
func (iter *JobHistoryListResultIterator) 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 (*JobHistoryListResultIterator) NextWithContext Uses

❖
func (iter *JobHistoryListResultIterator) 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 (JobHistoryListResultIterator) NotDone Uses

❖
func (iter JobHistoryListResultIterator) NotDone() bool

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

func (JobHistoryListResultIterator) Response Uses

❖
func (iter JobHistoryListResultIterator) Response() JobHistoryListResult

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

func (JobHistoryListResultIterator) Value Uses

❖
func (iter JobHistoryListResultIterator) Value() JobHistoryDefinition

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobHistoryListResultPage Uses

❖
type JobHistoryListResultPage struct {
    // contains filtered or unexported fields
}

JobHistoryListResultPage contains a page of JobHistoryDefinition values.

func NewJobHistoryListResultPage Uses

❖
func NewJobHistoryListResultPage(cur JobHistoryListResult, getNextPage func(context.Context, JobHistoryListResult) (JobHistoryListResult, error)) JobHistoryListResultPage

Creates a new instance of the JobHistoryListResultPage type.

func (*JobHistoryListResultPage) Next Uses

❖
func (page *JobHistoryListResultPage) 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 (*JobHistoryListResultPage) NextWithContext Uses

❖
func (page *JobHistoryListResultPage) 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 (JobHistoryListResultPage) NotDone Uses

❖
func (page JobHistoryListResultPage) NotDone() bool

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

func (JobHistoryListResultPage) Response Uses

❖
func (page JobHistoryListResultPage) Response() JobHistoryListResult

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

func (JobHistoryListResultPage) Values Uses

❖
func (page JobHistoryListResultPage) Values() []JobHistoryDefinition

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

type JobListResult Uses

❖
type JobListResult struct {
    autorest.Response `json:"-"`
    // Value - Gets or sets all jobs under job collection.
    Value *[]JobDefinition `json:"value,omitempty"`
    // NextLink - Gets or sets the URL to get the next set of jobs.
    NextLink *string `json:"nextLink,omitempty"`
}

JobListResult ...

func (JobListResult) IsEmpty Uses

❖
func (jlr JobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobListResultIterator Uses

❖
type JobListResultIterator struct {
    // contains filtered or unexported fields
}

JobListResultIterator provides access to a complete listing of JobDefinition values.

func NewJobListResultIterator Uses

❖
func NewJobListResultIterator(page JobListResultPage) JobListResultIterator

Creates a new instance of the JobListResultIterator type.

func (*JobListResultIterator) Next Uses

❖
func (iter *JobListResultIterator) 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 (*JobListResultIterator) NextWithContext Uses

❖
func (iter *JobListResultIterator) 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 (JobListResultIterator) NotDone Uses

❖
func (iter JobListResultIterator) NotDone() bool

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

func (JobListResultIterator) Response Uses

❖
func (iter JobListResultIterator) Response() JobListResult

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

func (JobListResultIterator) Value Uses

❖
func (iter JobListResultIterator) Value() JobDefinition

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobListResultPage Uses

❖
type JobListResultPage struct {
    // contains filtered or unexported fields
}

JobListResultPage contains a page of JobDefinition values.

func NewJobListResultPage Uses

❖
func NewJobListResultPage(cur JobListResult, getNextPage func(context.Context, JobListResult) (JobListResult, error)) JobListResultPage

Creates a new instance of the JobListResultPage type.

func (*JobListResultPage) Next Uses

❖
func (page *JobListResultPage) 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 (*JobListResultPage) NextWithContext Uses

❖
func (page *JobListResultPage) 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 (JobListResultPage) NotDone Uses

❖
func (page JobListResultPage) NotDone() bool

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

func (JobListResultPage) Response Uses

❖
func (page JobListResultPage) Response() JobListResult

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

func (JobListResultPage) Values Uses

❖
func (page JobListResultPage) Values() []JobDefinition

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

type JobMaxRecurrence Uses

❖
type JobMaxRecurrence struct {
    // Frequency - Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'
    Frequency RecurrenceFrequency `json:"frequency,omitempty"`
    // Interval - Gets or sets the interval between retries.
    Interval *int32 `json:"interval,omitempty"`
}

JobMaxRecurrence ...

type JobProperties Uses

❖
type JobProperties struct {
    // StartTime - Gets or sets the job start time.
    StartTime *date.Time `json:"startTime,omitempty"`
    // Action - Gets or sets the job action.
    Action *JobAction `json:"action,omitempty"`
    // Recurrence - Gets or sets the job recurrence.
    Recurrence *JobRecurrence `json:"recurrence,omitempty"`
    // State - Gets or set the job state. Possible values include: 'JobStateEnabled', 'JobStateDisabled', 'JobStateFaulted', 'JobStateCompleted'
    State JobState `json:"state,omitempty"`
    // Status - READ-ONLY; Gets the job status.
    Status *JobStatus `json:"status,omitempty"`
}

JobProperties ...

func (JobProperties) MarshalJSON Uses

❖
func (jp JobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobProperties.

type JobRecurrence Uses

❖
type JobRecurrence struct {
    // Frequency - Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'
    Frequency RecurrenceFrequency `json:"frequency,omitempty"`
    // Interval - Gets or sets the interval between retries.
    Interval *int32 `json:"interval,omitempty"`
    // Count - Gets or sets the maximum number of times that the job should run.
    Count *int32 `json:"count,omitempty"`
    // EndTime - Gets or sets the time at which the job will complete.
    EndTime  *date.Time             `json:"endTime,omitempty"`
    Schedule *JobRecurrenceSchedule `json:"schedule,omitempty"`
}

JobRecurrence ...

type JobRecurrenceSchedule Uses

❖
type JobRecurrenceSchedule struct {
    // WeekDays - Gets or sets the days of the week that the job should execute on.
    WeekDays *[]DayOfWeek `json:"weekDays,omitempty"`
    // Hours - Gets or sets the hours of the day that the job should execute at.
    Hours *[]int32 `json:"hours,omitempty"`
    // Minutes - Gets or sets the minutes of the hour that the job should execute at.
    Minutes *[]int32 `json:"minutes,omitempty"`
    // MonthDays - Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.
    MonthDays *[]int32 `json:"monthDays,omitempty"`
    // MonthlyOccurrences - Gets or sets the occurrences of days within a month.
    MonthlyOccurrences *[]JobRecurrenceScheduleMonthlyOccurrence `json:"monthlyOccurrences,omitempty"`
}

JobRecurrenceSchedule ...

type JobRecurrenceScheduleMonthlyOccurrence Uses

❖
type JobRecurrenceScheduleMonthlyOccurrence struct {
    // Day - Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. Possible values include: 'JobScheduleDayMonday', 'JobScheduleDayTuesday', 'JobScheduleDayWednesday', 'JobScheduleDayThursday', 'JobScheduleDayFriday', 'JobScheduleDaySaturday', 'JobScheduleDaySunday'
    Day JobScheduleDay `json:"day,omitempty"`
    // Occurrence - Gets or sets the occurrence. Must be between -5 and 5.
    Occurrence *int32 `json:"Occurrence,omitempty"`
}

JobRecurrenceScheduleMonthlyOccurrence ...

type JobScheduleDay Uses

❖
type JobScheduleDay string

JobScheduleDay enumerates the values for job schedule day.

❖
const (
    // JobScheduleDayFriday ...
    JobScheduleDayFriday JobScheduleDay = "Friday"
    // JobScheduleDayMonday ...
    JobScheduleDayMonday JobScheduleDay = "Monday"
    // JobScheduleDaySaturday ...
    JobScheduleDaySaturday JobScheduleDay = "Saturday"
    // JobScheduleDaySunday ...
    JobScheduleDaySunday JobScheduleDay = "Sunday"
    // JobScheduleDayThursday ...
    JobScheduleDayThursday JobScheduleDay = "Thursday"
    // JobScheduleDayTuesday ...
    JobScheduleDayTuesday JobScheduleDay = "Tuesday"
    // JobScheduleDayWednesday ...
    JobScheduleDayWednesday JobScheduleDay = "Wednesday"
)

func PossibleJobScheduleDayValues Uses

❖
func PossibleJobScheduleDayValues() []JobScheduleDay

PossibleJobScheduleDayValues returns an array of possible values for the JobScheduleDay const type.

type JobState Uses

❖
type JobState string

JobState enumerates the values for job state.

❖
const (
    // JobStateCompleted ...
    JobStateCompleted JobState = "Completed"
    // JobStateDisabled ...
    JobStateDisabled JobState = "Disabled"
    // JobStateEnabled ...
    JobStateEnabled JobState = "Enabled"
    // JobStateFaulted ...
    JobStateFaulted JobState = "Faulted"
)

func PossibleJobStateValues Uses

❖
func PossibleJobStateValues() []JobState

PossibleJobStateValues returns an array of possible values for the JobState const type.

type JobStateFilter Uses

❖
type JobStateFilter struct {
    // State - Gets or sets the job state. Possible values include: 'JobStateEnabled', 'JobStateDisabled', 'JobStateFaulted', 'JobStateCompleted'
    State JobState `json:"state,omitempty"`
}

JobStateFilter ...

type JobStatus Uses

❖
type JobStatus struct {
    // ExecutionCount - READ-ONLY; Gets the number of times this job has executed.
    ExecutionCount *int32 `json:"executionCount,omitempty"`
    // FailureCount - READ-ONLY; Gets the number of times this job has failed.
    FailureCount *int32 `json:"failureCount,omitempty"`
    // FaultedCount - READ-ONLY; Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states).
    FaultedCount *int32 `json:"faultedCount,omitempty"`
    // LastExecutionTime - READ-ONLY; Gets the time the last occurrence executed in ISO-8601 format.  Could be empty if job has not run yet.
    LastExecutionTime *date.Time `json:"lastExecutionTime,omitempty"`
    // NextExecutionTime - READ-ONLY; Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed.
    NextExecutionTime *date.Time `json:"nextExecutionTime,omitempty"`
}

JobStatus ...

type JobsClient Uses

❖
type JobsClient struct {
    BaseClient
}

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

func NewJobsClient Uses

❖
func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI Uses

❖
func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (JobsClient) CreateOrUpdate Uses

❖
func (client JobsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

CreateOrUpdate provisions a new job or updates an existing job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name. job - the job definition.

func (JobsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobsClient) CreateOrUpdateResponder Uses

❖
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 Uses

❖
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 Uses

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

Delete deletes a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (result JobDefinition, err error)

Get gets a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobsClient) List(ctx context.Context, resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (result JobListResultPage, err error)

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

func (JobsClient) ListComplete Uses

❖
func (client JobsClient) ListComplete(ctx context.Context, resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (result JobListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListJobHistory Uses

❖
func (client JobsClient) ListJobHistory(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (result JobHistoryListResultPage, err error)

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

func (JobsClient) ListJobHistoryComplete Uses

❖
func (client JobsClient) ListJobHistoryComplete(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (result JobHistoryListResultIterator, err error)

ListJobHistoryComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListJobHistoryPreparer Uses

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

ListJobHistoryPreparer prepares the ListJobHistory request.

func (JobsClient) ListJobHistoryResponder Uses

❖
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 Uses

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

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

ListPreparer prepares the List request.

func (JobsClient) ListResponder Uses

❖
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 Uses

❖
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 Uses

❖
func (client JobsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

Patch patches an existing job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name. job - the job definition.

func (JobsClient) PatchPreparer Uses

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

PatchPreparer prepares the Patch request.

func (JobsClient) PatchResponder Uses

❖
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 Uses

❖
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 Uses

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

Run runs a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) RunPreparer Uses

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

RunPreparer prepares the Run request.

func (JobsClient) RunResponder Uses

❖
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 Uses

❖
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 OAuthAuthentication Uses

❖
type OAuthAuthentication struct {
    // Secret - Gets or sets the secret.
    Secret *string `json:"secret,omitempty"`
    // Tenant - Gets or sets the tenant.
    Tenant *string `json:"tenant,omitempty"`
    // Audience - Gets or sets the audience.
    Audience *string `json:"audience,omitempty"`
    // ClientID - Gets or sets the client identifier.
    ClientID *string `json:"clientId,omitempty"`
    // Type - Gets or sets the http authentication type. Possible values include: 'NotSpecified', 'ClientCertificate', 'ActiveDirectoryOAuth', 'Basic'
    Type HTTPAuthenticationType `json:"type,omitempty"`
}

OAuthAuthentication ...

type RecurrenceFrequency Uses

❖
type RecurrenceFrequency string

RecurrenceFrequency enumerates the values for recurrence frequency.

❖
const (
    // Day ...
    Day RecurrenceFrequency = "Day"
    // Hour ...
    Hour RecurrenceFrequency = "Hour"
    // Minute ...
    Minute RecurrenceFrequency = "Minute"
    // Month ...
    Month RecurrenceFrequency = "Month"
    // Week ...
    Week RecurrenceFrequency = "Week"
)

func PossibleRecurrenceFrequencyValues Uses

❖
func PossibleRecurrenceFrequencyValues() []RecurrenceFrequency

PossibleRecurrenceFrequencyValues returns an array of possible values for the RecurrenceFrequency const type.

type RetryPolicy Uses

❖
type RetryPolicy struct {
    // RetryType - Gets or sets the retry strategy to be used. Possible values include: 'None', 'Fixed'
    RetryType RetryType `json:"retryType,omitempty"`
    // RetryInterval - Gets or sets the retry interval between retries.
    RetryInterval *string `json:"retryInterval,omitempty"`
    // RetryCount - Gets or sets the number of times a retry should be attempted.
    RetryCount *int32 `json:"retryCount,omitempty"`
}

RetryPolicy ...

type RetryType Uses

❖
type RetryType string

RetryType enumerates the values for retry type.

❖
const (
    // Fixed ...
    Fixed RetryType = "Fixed"
    // None ...
    None RetryType = "None"
)

func PossibleRetryTypeValues Uses

❖
func PossibleRetryTypeValues() []RetryType

PossibleRetryTypeValues returns an array of possible values for the RetryType const type.

type ServiceBusAuthentication Uses

❖
type ServiceBusAuthentication struct {
    // SasKey - Gets or sets the SAS key.
    SasKey *string `json:"sasKey,omitempty"`
    // SasKeyName - Gets or sets the SAS key name.
    SasKeyName *string `json:"sasKeyName,omitempty"`
    // Type - Gets or sets the authentication type. Possible values include: 'ServiceBusAuthenticationTypeNotSpecified', 'ServiceBusAuthenticationTypeSharedAccessKey'
    Type ServiceBusAuthenticationType `json:"type,omitempty"`
}

ServiceBusAuthentication ...

type ServiceBusAuthenticationType Uses

❖
type ServiceBusAuthenticationType string

ServiceBusAuthenticationType enumerates the values for service bus authentication type.

❖
const (
    // ServiceBusAuthenticationTypeNotSpecified ...
    ServiceBusAuthenticationTypeNotSpecified ServiceBusAuthenticationType = "NotSpecified"
    // ServiceBusAuthenticationTypeSharedAccessKey ...
    ServiceBusAuthenticationTypeSharedAccessKey ServiceBusAuthenticationType = "SharedAccessKey"
)

func PossibleServiceBusAuthenticationTypeValues Uses

❖
func PossibleServiceBusAuthenticationTypeValues() []ServiceBusAuthenticationType

PossibleServiceBusAuthenticationTypeValues returns an array of possible values for the ServiceBusAuthenticationType const type.

type ServiceBusBrokeredMessageProperties Uses

❖
type ServiceBusBrokeredMessageProperties struct {
    // ContentType - Gets or sets the content type.
    ContentType *string `json:"contentType,omitempty"`
    // CorrelationID - Gets or sets the correlation id.
    CorrelationID *string `json:"correlationId,omitempty"`
    // ForcePersistence - Gets or sets the force persistence.
    ForcePersistence *bool `json:"forcePersistence,omitempty"`
    // Label - Gets or sets the label.
    Label *string `json:"label,omitempty"`
    // MessageID - Gets or sets the message id.
    MessageID *string `json:"messageId,omitempty"`
    // PartitionKey - Gets or sets the partition key.
    PartitionKey *string `json:"partitionKey,omitempty"`
    // ReplyTo - Gets or sets the reply to.
    ReplyTo *string `json:"replyTo,omitempty"`
    // ReplyToSessionID - Gets or sets the reply to session id.
    ReplyToSessionID *string `json:"replyToSessionId,omitempty"`
    // ScheduledEnqueueTimeUtc - Gets or sets the scheduled enqueue time UTC.
    ScheduledEnqueueTimeUtc *date.Time `json:"scheduledEnqueueTimeUtc,omitempty"`
    // SessionID - Gets or sets the session id.
    SessionID *string `json:"sessionId,omitempty"`
    // TimeToLive - Gets or sets the time to live.
    TimeToLive *date.Time `json:"timeToLive,omitempty"`
    // To - Gets or sets the to.
    To  *string `json:"to,omitempty"`
    // ViaPartitionKey - Gets or sets the via partition key.
    ViaPartitionKey *string `json:"viaPartitionKey,omitempty"`
}

ServiceBusBrokeredMessageProperties ...

type ServiceBusMessage Uses

❖
type ServiceBusMessage struct {
    // Authentication - Gets or sets the authentication.
    Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
    // BrokeredMessageProperties - Gets or sets the brokered message properties.
    BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
    // CustomMessageProperties - Gets or sets the custom message properties.
    CustomMessageProperties map[string]*string `json:"customMessageProperties"`
    // Message - Gets or sets the message.
    Message *string `json:"message,omitempty"`
    // Namespace - Gets or sets the namespace.
    Namespace *string `json:"namespace,omitempty"`
    // TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
    TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusMessage ...

func (ServiceBusMessage) MarshalJSON Uses

❖
func (sbm ServiceBusMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusMessage.

type ServiceBusQueueMessage Uses

❖
type ServiceBusQueueMessage struct {
    // QueueName - Gets or sets the queue name.
    QueueName *string `json:"queueName,omitempty"`
    // Authentication - Gets or sets the authentication.
    Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
    // BrokeredMessageProperties - Gets or sets the brokered message properties.
    BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
    // CustomMessageProperties - Gets or sets the custom message properties.
    CustomMessageProperties map[string]*string `json:"customMessageProperties"`
    // Message - Gets or sets the message.
    Message *string `json:"message,omitempty"`
    // Namespace - Gets or sets the namespace.
    Namespace *string `json:"namespace,omitempty"`
    // TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
    TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusQueueMessage ...

func (ServiceBusQueueMessage) MarshalJSON Uses

❖
func (sbqm ServiceBusQueueMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusQueueMessage.

type ServiceBusTopicMessage Uses

❖
type ServiceBusTopicMessage struct {
    // TopicPath - Gets or sets the topic path.
    TopicPath *string `json:"topicPath,omitempty"`
    // Authentication - Gets or sets the authentication.
    Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
    // BrokeredMessageProperties - Gets or sets the brokered message properties.
    BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
    // CustomMessageProperties - Gets or sets the custom message properties.
    CustomMessageProperties map[string]*string `json:"customMessageProperties"`
    // Message - Gets or sets the message.
    Message *string `json:"message,omitempty"`
    // Namespace - Gets or sets the namespace.
    Namespace *string `json:"namespace,omitempty"`
    // TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
    TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusTopicMessage ...

func (ServiceBusTopicMessage) MarshalJSON Uses

❖
func (sbtm ServiceBusTopicMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusTopicMessage.

type ServiceBusTransportType Uses

❖
type ServiceBusTransportType string

ServiceBusTransportType enumerates the values for service bus transport type.

❖
const (
    // ServiceBusTransportTypeAMQP ...
    ServiceBusTransportTypeAMQP ServiceBusTransportType = "AMQP"
    // ServiceBusTransportTypeNetMessaging ...
    ServiceBusTransportTypeNetMessaging ServiceBusTransportType = "NetMessaging"
    // ServiceBusTransportTypeNotSpecified ...
    ServiceBusTransportTypeNotSpecified ServiceBusTransportType = "NotSpecified"
)

func PossibleServiceBusTransportTypeValues Uses

❖
func PossibleServiceBusTransportTypeValues() []ServiceBusTransportType

PossibleServiceBusTransportTypeValues returns an array of possible values for the ServiceBusTransportType const type.

type Sku Uses

❖
type Sku struct {
    // Name - Gets or set the SKU. Possible values include: 'Standard', 'Free', 'Premium'
    Name SkuDefinition `json:"name,omitempty"`
}

Sku ...

type SkuDefinition Uses

❖
type SkuDefinition string

SkuDefinition enumerates the values for sku definition.

❖
const (
    // Free ...
    Free SkuDefinition = "Free"
    // Premium ...
    Premium SkuDefinition = "Premium"
    // Standard ...
    Standard SkuDefinition = "Standard"
)

func PossibleSkuDefinitionValues Uses

❖
func PossibleSkuDefinitionValues() []SkuDefinition

PossibleSkuDefinitionValues returns an array of possible values for the SkuDefinition const type.

type StorageQueueMessage Uses

❖
type StorageQueueMessage struct {
    // StorageAccount - Gets or sets the storage account name.
    StorageAccount *string `json:"storageAccount,omitempty"`
    // QueueName - Gets or sets the queue name.
    QueueName *string `json:"queueName,omitempty"`
    // SasToken - Gets or sets the SAS key.
    SasToken *string `json:"sasToken,omitempty"`
    // Message - Gets or sets the message.
    Message *string `json:"message,omitempty"`
}

StorageQueueMessage ...

Directories

PathSynopsis
schedulerapi

Package scheduler imports 9 packages (graph) and is imported by 4 packages. Updated 2021-01-28. Refresh now. Tools for package owners.