synchronizationsetting

package
v0.20240223.1130721 Latest Latest
Warning

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

 Go to latest Published: Feb 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/synchronizationsetting Documentation

The synchronizationsetting SDK allows for interaction with the Azure Resource Manager Service datashare (API Version 2021-08-01).

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/datashare/2021-08-01/synchronizationsetting"

Client Initialization

client := synchronizationsetting.NewSynchronizationSettingClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SynchronizationSettingClient.Create

ctx := context.TODO()
id := synchronizationsetting.NewSynchronizationSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "synchronizationSettingValue")

payload := synchronizationsetting.SynchronizationSetting{
	// ...
}


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: SynchronizationSettingClient.Delete

ctx := context.TODO()
id := synchronizationsetting.NewSynchronizationSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "synchronizationSettingValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: SynchronizationSettingClient.Get

ctx := context.TODO()
id := synchronizationsetting.NewSynchronizationSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "synchronizationSettingValue")

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: SynchronizationSettingClient.ListByShare

ctx := context.TODO()
id := synchronizationsetting.NewShareID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue")

// alternatively `client.ListByShare(ctx, id)` can be used to do batched pagination
items, err := client.ListByShareComplete(ctx, id)
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 PossibleValuesForRecurrenceInterval 

func PossibleValuesForRecurrenceInterval() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForSynchronizationSettingKind 

func PossibleValuesForSynchronizationSettingKind() []string

func ValidateShareID 

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

ValidateShareID checks that 'input' can be parsed as a Share ID

func ValidateSynchronizationSettingID 

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

ValidateSynchronizationSettingID checks that 'input' can be parsed as a Synchronization Setting ID

Types

type CreateOperationResponse 

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

type DataShareErrorInfo 

type DataShareErrorInfo struct {
	Code    string                `json:"code"`
	Details *[]DataShareErrorInfo `json:"details,omitempty"`
	Message string                `json:"message"`
	Target  *string               `json:"target,omitempty"`
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationResponse
}

type GetOperationResponse 

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

type ListByShareCompleteResult 

type ListByShareCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SynchronizationSetting
}

type ListByShareOperationResponse 

type ListByShareOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SynchronizationSetting
}

type OperationResponse 

type OperationResponse struct {
	EndTime   *string             `json:"endTime,omitempty"`
	Error     *DataShareErrorInfo `json:"error,omitempty"`
	StartTime *string             `json:"startTime,omitempty"`
	Status    Status              `json:"status"`
}

func (*OperationResponse) GetEndTimeAsTime 

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

func (*OperationResponse) GetStartTimeAsTime 

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

func (*OperationResponse) SetEndTimeAsTime 

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

func (*OperationResponse) SetStartTimeAsTime 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RawSynchronizationSettingImpl 

type RawSynchronizationSettingImpl struct {
	Type   string
	Values map[string]interface{}
}

RawSynchronizationSettingImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RecurrenceInterval 

type RecurrenceInterval string
const (
	RecurrenceIntervalDay  RecurrenceInterval = "Day"
	RecurrenceIntervalHour RecurrenceInterval = "Hour"
)

func (*RecurrenceInterval) UnmarshalJSON 

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

type ScheduledSynchronizationSetting 

type ScheduledSynchronizationSetting struct {
	Properties ScheduledSynchronizationSettingProperties `json:"properties"`

	// Fields inherited from SynchronizationSetting
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ScheduledSynchronizationSetting) MarshalJSON 

func (s ScheduledSynchronizationSetting) MarshalJSON() ([]byte, error)

type ScheduledSynchronizationSettingProperties 

type ScheduledSynchronizationSettingProperties struct {
	CreatedAt           *string            `json:"createdAt,omitempty"`
	ProvisioningState   *ProvisioningState `json:"provisioningState,omitempty"`
	RecurrenceInterval  RecurrenceInterval `json:"recurrenceInterval"`
	SynchronizationTime string             `json:"synchronizationTime"`
	UserName            *string            `json:"userName,omitempty"`
}

func (*ScheduledSynchronizationSettingProperties) GetCreatedAtAsTime 

func (o *ScheduledSynchronizationSettingProperties) GetCreatedAtAsTime() (*time.Time, error)

func (*ScheduledSynchronizationSettingProperties) GetSynchronizationTimeAsTime 

func (o *ScheduledSynchronizationSettingProperties) GetSynchronizationTimeAsTime() (*time.Time, error)

func (*ScheduledSynchronizationSettingProperties) SetCreatedAtAsTime 

func (o *ScheduledSynchronizationSettingProperties) SetCreatedAtAsTime(input time.Time)

func (*ScheduledSynchronizationSettingProperties) SetSynchronizationTimeAsTime 

func (o *ScheduledSynchronizationSettingProperties) SetSynchronizationTimeAsTime(input time.Time)

type ShareId 

type ShareId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	ShareName         string
}

ShareId is a struct representing the Resource ID for a Share

func NewShareID 

func NewShareID(subscriptionId string, resourceGroupName string, accountName string, shareName string) ShareId

NewShareID returns a new ShareId struct

func ParseShareID 

func ParseShareID(input string) (*ShareId, error)

ParseShareID parses 'input' into a ShareId

func ParseShareIDInsensitively 

func ParseShareIDInsensitively(input string) (*ShareId, error)

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

func (*ShareId) FromParseResult 

func (id *ShareId) FromParseResult(input resourceids.ParseResult) error

func (ShareId) ID 

func (id ShareId) ID() string

ID returns the formatted Share ID

func (ShareId) Segments 

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

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

func (ShareId) String 

func (id ShareId) String() string

String returns a human-readable description of this Share ID

type Status 

type Status string
const (
	StatusAccepted         Status = "Accepted"
	StatusCanceled         Status = "Canceled"
	StatusFailed           Status = "Failed"
	StatusInProgress       Status = "InProgress"
	StatusSucceeded        Status = "Succeeded"
	StatusTransientFailure Status = "TransientFailure"
)

func (*Status) UnmarshalJSON 

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

type SynchronizationSetting 

type SynchronizationSetting interface {
}

type SynchronizationSettingClient 

type SynchronizationSettingClient struct {
	Client *resourcemanager.Client
}

func NewSynchronizationSettingClientWithBaseURI 

func NewSynchronizationSettingClientWithBaseURI(sdkApi sdkEnv.Api) (*SynchronizationSettingClient, error)

func (SynchronizationSettingClient) Create 

func (c SynchronizationSettingClient) Create(ctx context.Context, id SynchronizationSettingId, input SynchronizationSetting) (result CreateOperationResponse, err error)

Create ...

func (SynchronizationSettingClient) Delete 

func (c SynchronizationSettingClient) Delete(ctx context.Context, id SynchronizationSettingId) (result DeleteOperationResponse, err error)

Delete ...

func (SynchronizationSettingClient) DeleteThenPoll 

func (c SynchronizationSettingClient) DeleteThenPoll(ctx context.Context, id SynchronizationSettingId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SynchronizationSettingClient) Get 

func (c SynchronizationSettingClient) Get(ctx context.Context, id SynchronizationSettingId) (result GetOperationResponse, err error)

Get ...

func (SynchronizationSettingClient) ListByShare 

func (c SynchronizationSettingClient) ListByShare(ctx context.Context, id ShareId) (result ListByShareOperationResponse, err error)

ListByShare ...

func (SynchronizationSettingClient) ListByShareComplete 

func (c SynchronizationSettingClient) ListByShareComplete(ctx context.Context, id ShareId) (ListByShareCompleteResult, error)

ListByShareComplete retrieves all the results into a single object

func (SynchronizationSettingClient) ListByShareCompleteMatchingPredicate 

func (c SynchronizationSettingClient) ListByShareCompleteMatchingPredicate(ctx context.Context, id ShareId, predicate SynchronizationSettingOperationPredicate) (result ListByShareCompleteResult, err error)

ListByShareCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SynchronizationSettingId 

type SynchronizationSettingId struct {
	SubscriptionId             string
	ResourceGroupName          string
	AccountName                string
	ShareName                  string
	SynchronizationSettingName string
}

SynchronizationSettingId is a struct representing the Resource ID for a Synchronization Setting

func NewSynchronizationSettingID 

func NewSynchronizationSettingID(subscriptionId string, resourceGroupName string, accountName string, shareName string, synchronizationSettingName string) SynchronizationSettingId

NewSynchronizationSettingID returns a new SynchronizationSettingId struct

func ParseSynchronizationSettingID 

func ParseSynchronizationSettingID(input string) (*SynchronizationSettingId, error)

ParseSynchronizationSettingID parses 'input' into a SynchronizationSettingId

func ParseSynchronizationSettingIDInsensitively 

func ParseSynchronizationSettingIDInsensitively(input string) (*SynchronizationSettingId, error)

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

func (*SynchronizationSettingId) FromParseResult 

func (id *SynchronizationSettingId) FromParseResult(input resourceids.ParseResult) error

func (SynchronizationSettingId) ID 

func (id SynchronizationSettingId) ID() string

ID returns the formatted Synchronization Setting ID

func (SynchronizationSettingId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Synchronization Setting ID

func (SynchronizationSettingId) String 

func (id SynchronizationSettingId) String() string

String returns a human-readable description of this Synchronization Setting ID

type SynchronizationSettingKind 

type SynchronizationSettingKind string
const (
	SynchronizationSettingKindScheduleBased SynchronizationSettingKind = "ScheduleBased"
)

func (*SynchronizationSettingKind) UnmarshalJSON 

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

type SynchronizationSettingOperationPredicate 

type SynchronizationSettingOperationPredicate struct {
}

func (SynchronizationSettingOperationPredicate) Matches 

func (p SynchronizationSettingOperationPredicate) Matches(input SynchronizationSetting) bool

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.