sourcecontrolsyncjob

package
v0.20230307.1120859 Latest Latest
Warning

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

Go to latest
Published: Mar 7, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/sourcecontrolsyncjob Documentation

The sourcecontrolsyncjob SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2022-08-08).

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

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/sourcecontrolsyncjob"

Client Initialization

client := sourcecontrolsyncjob.NewSourceControlSyncJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SourceControlSyncJobClient.Create

ctx := context.TODO()
id := sourcecontrolsyncjob.NewSourceControlSyncJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "sourceControlValue", "sourceControlSyncJobIdValue")

payload := sourcecontrolsyncjob.SourceControlSyncJobCreateParameters{
	// ...
}


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

Example Usage: SourceControlSyncJobClient.Get

ctx := context.TODO()
id := sourcecontrolsyncjob.NewSourceControlSyncJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "sourceControlValue", "sourceControlSyncJobIdValue")

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

Example Usage: SourceControlSyncJobClient.ListByAutomationAccount

ctx := context.TODO()
id := sourcecontrolsyncjob.NewSourceControlID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "sourceControlValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSyncType

func PossibleValuesForSyncType() []string

func ValidateSourceControlID

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

ValidateSourceControlID checks that 'input' can be parsed as a Source Control ID

func ValidateSourceControlSyncJobID

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

ValidateSourceControlSyncJobID checks that 'input' can be parsed as a Source Control Sync Job ID

Types

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControlSyncJob
}

type GetOperationResponse

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

type ListByAutomationAccountCompleteResult

type ListByAutomationAccountCompleteResult struct {
	Items []SourceControlSyncJob
}

type ListByAutomationAccountOperationOptions

type ListByAutomationAccountOperationOptions struct {
	Filter *string
}

func DefaultListByAutomationAccountOperationOptions

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

func (ListByAutomationAccountOperationOptions) ToHeaders added in v0.20230216.1112329

func (ListByAutomationAccountOperationOptions) ToOData added in v0.20230216.1112329

func (ListByAutomationAccountOperationOptions) ToQuery added in v0.20230216.1112329

type ListByAutomationAccountOperationResponse

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SourceControlSyncJob
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCompleted ProvisioningState = "Completed"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateRunning   ProvisioningState = "Running"
)

type SourceControlId

type SourceControlId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	SourceControlName     string
}

SourceControlId is a struct representing the Resource ID for a Source Control

func NewSourceControlID

func NewSourceControlID(subscriptionId string, resourceGroupName string, automationAccountName string, sourceControlName string) SourceControlId

NewSourceControlID returns a new SourceControlId struct

func ParseSourceControlID

func ParseSourceControlID(input string) (*SourceControlId, error)

ParseSourceControlID parses 'input' into a SourceControlId

func ParseSourceControlIDInsensitively

func ParseSourceControlIDInsensitively(input string) (*SourceControlId, error)

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

func (SourceControlId) ID

func (id SourceControlId) ID() string

ID returns the formatted Source Control ID

func (SourceControlId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Source Control ID

func (SourceControlId) String

func (id SourceControlId) String() string

String returns a human-readable description of this Source Control ID

type SourceControlSyncJob

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

type SourceControlSyncJobById

type SourceControlSyncJobById struct {
	Id         *string                             `json:"id,omitempty"`
	Properties *SourceControlSyncJobByIdProperties `json:"properties,omitempty"`
}

type SourceControlSyncJobByIdProperties

type SourceControlSyncJobByIdProperties struct {
	CreationTime           *string            `json:"creationTime,omitempty"`
	EndTime                *string            `json:"endTime,omitempty"`
	Exception              *string            `json:"exception,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
	SourceControlSyncJobId *string            `json:"sourceControlSyncJobId,omitempty"`
	StartTime              *string            `json:"startTime,omitempty"`
	SyncType               *SyncType          `json:"syncType,omitempty"`
}

func (*SourceControlSyncJobByIdProperties) GetCreationTimeAsTime

func (o *SourceControlSyncJobByIdProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*SourceControlSyncJobByIdProperties) GetEndTimeAsTime

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

func (*SourceControlSyncJobByIdProperties) GetStartTimeAsTime

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

func (*SourceControlSyncJobByIdProperties) SetCreationTimeAsTime

func (o *SourceControlSyncJobByIdProperties) SetCreationTimeAsTime(input time.Time)

func (*SourceControlSyncJobByIdProperties) SetEndTimeAsTime

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

func (*SourceControlSyncJobByIdProperties) SetStartTimeAsTime

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

type SourceControlSyncJobClient

type SourceControlSyncJobClient struct {
	Client *resourcemanager.Client
}

func NewSourceControlSyncJobClientWithBaseURI

func NewSourceControlSyncJobClientWithBaseURI(api environments.Api) (*SourceControlSyncJobClient, error)

func (SourceControlSyncJobClient) Create

Create ...

func (SourceControlSyncJobClient) Get

Get ...

func (SourceControlSyncJobClient) ListByAutomationAccount

ListByAutomationAccount ...

func (SourceControlSyncJobClient) ListByAutomationAccountComplete

ListByAutomationAccountComplete retrieves all the results into a single object

func (SourceControlSyncJobClient) ListByAutomationAccountCompleteMatchingPredicate

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SourceControlSyncJobCreateParameters

type SourceControlSyncJobCreateParameters struct {
	Properties SourceControlSyncJobCreateProperties `json:"properties"`
}

type SourceControlSyncJobCreateProperties

type SourceControlSyncJobCreateProperties struct {
	CommitId string `json:"commitId"`
}

type SourceControlSyncJobId

type SourceControlSyncJobId struct {
	SubscriptionId         string
	ResourceGroupName      string
	AutomationAccountName  string
	SourceControlName      string
	SourceControlSyncJobId string
}

SourceControlSyncJobId is a struct representing the Resource ID for a Source Control Sync Job

func NewSourceControlSyncJobID

func NewSourceControlSyncJobID(subscriptionId string, resourceGroupName string, automationAccountName string, sourceControlName string, sourceControlSyncJobId string) SourceControlSyncJobId

NewSourceControlSyncJobID returns a new SourceControlSyncJobId struct

func ParseSourceControlSyncJobID

func ParseSourceControlSyncJobID(input string) (*SourceControlSyncJobId, error)

ParseSourceControlSyncJobID parses 'input' into a SourceControlSyncJobId

func ParseSourceControlSyncJobIDInsensitively

func ParseSourceControlSyncJobIDInsensitively(input string) (*SourceControlSyncJobId, error)

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

func (SourceControlSyncJobId) ID

ID returns the formatted Source Control Sync Job ID

func (SourceControlSyncJobId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Source Control Sync Job ID

func (SourceControlSyncJobId) String

func (id SourceControlSyncJobId) String() string

String returns a human-readable description of this Source Control Sync Job ID

type SourceControlSyncJobOperationPredicate

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

func (SourceControlSyncJobOperationPredicate) Matches

type SourceControlSyncJobProperties

type SourceControlSyncJobProperties struct {
	CreationTime           *string            `json:"creationTime,omitempty"`
	EndTime                *string            `json:"endTime,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
	SourceControlSyncJobId *string            `json:"sourceControlSyncJobId,omitempty"`
	StartTime              *string            `json:"startTime,omitempty"`
	SyncType               *SyncType          `json:"syncType,omitempty"`
}

func (*SourceControlSyncJobProperties) GetCreationTimeAsTime

func (o *SourceControlSyncJobProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*SourceControlSyncJobProperties) GetEndTimeAsTime

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

func (*SourceControlSyncJobProperties) GetStartTimeAsTime

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

func (*SourceControlSyncJobProperties) SetCreationTimeAsTime

func (o *SourceControlSyncJobProperties) SetCreationTimeAsTime(input time.Time)

func (*SourceControlSyncJobProperties) SetEndTimeAsTime

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

func (*SourceControlSyncJobProperties) SetStartTimeAsTime

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

type SyncType

type SyncType string
const (
	SyncTypeFullSync    SyncType = "FullSync"
	SyncTypePartialSync SyncType = "PartialSync"
)

Jump to

Keyboard shortcuts

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