databaserecommendedactions

package
v0.20230811.1084201 Latest Latest
Warning

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

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

README

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

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

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

Import Path

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

Client Initialization

client := databaserecommendedactions.NewDatabaseRecommendedActionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseRecommendedActionsClient.Get

ctx := context.TODO()
id := databaserecommendedactions.NewRecommendedActionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "advisorValue", "recommendedActionValue")

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: DatabaseRecommendedActionsClient.ListByDatabaseAdvisor

ctx := context.TODO()
id := databaserecommendedactions.NewDatabaseAdvisorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "advisorValue")

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

Example Usage: DatabaseRecommendedActionsClient.Update

ctx := context.TODO()
id := databaserecommendedactions.NewRecommendedActionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "advisorValue", "recommendedActionValue")

payload := databaserecommendedactions.RecommendedAction{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForImplementationMethod

func PossibleValuesForImplementationMethod() []string

func PossibleValuesForIsRetryable

func PossibleValuesForIsRetryable() []string

func PossibleValuesForRecommendedActionCurrentState

func PossibleValuesForRecommendedActionCurrentState() []string

func PossibleValuesForRecommendedActionInitiatedBy

func PossibleValuesForRecommendedActionInitiatedBy() []string

func ValidateDatabaseAdvisorID

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

ValidateDatabaseAdvisorID checks that 'input' can be parsed as a Database Advisor ID

func ValidateRecommendedActionID

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

ValidateRecommendedActionID checks that 'input' can be parsed as a Recommended Action ID

Types

type DatabaseAdvisorId

type DatabaseAdvisorId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	AdvisorName       string
}

DatabaseAdvisorId is a struct representing the Resource ID for a Database Advisor

func NewDatabaseAdvisorID

func NewDatabaseAdvisorID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, advisorName string) DatabaseAdvisorId

NewDatabaseAdvisorID returns a new DatabaseAdvisorId struct

func ParseDatabaseAdvisorID

func ParseDatabaseAdvisorID(input string) (*DatabaseAdvisorId, error)

ParseDatabaseAdvisorID parses 'input' into a DatabaseAdvisorId

func ParseDatabaseAdvisorIDInsensitively

func ParseDatabaseAdvisorIDInsensitively(input string) (*DatabaseAdvisorId, error)

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

func (DatabaseAdvisorId) ID

func (id DatabaseAdvisorId) ID() string

ID returns the formatted Database Advisor ID

func (DatabaseAdvisorId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Database Advisor ID

func (DatabaseAdvisorId) String

func (id DatabaseAdvisorId) String() string

String returns a human-readable description of this Database Advisor ID

type DatabaseRecommendedActionsClient

type DatabaseRecommendedActionsClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseRecommendedActionsClientWithBaseURI

func NewDatabaseRecommendedActionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseRecommendedActionsClient, error)

func (DatabaseRecommendedActionsClient) Get

Get ...

func (DatabaseRecommendedActionsClient) ListByDatabaseAdvisor

ListByDatabaseAdvisor ...

func (DatabaseRecommendedActionsClient) Update

Update ...

type GetOperationResponse

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

type ImplementationMethod

type ImplementationMethod string
const (
	ImplementationMethodAzurePowerShell ImplementationMethod = "AzurePowerShell"
	ImplementationMethodTSql            ImplementationMethod = "TSql"
)

func (*ImplementationMethod) UnmarshalJSON

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

type IsRetryable

type IsRetryable string
const (
	IsRetryableNo  IsRetryable = "No"
	IsRetryableYes IsRetryable = "Yes"
)

func (*IsRetryable) UnmarshalJSON

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

type ListByDatabaseAdvisorOperationResponse

type ListByDatabaseAdvisorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecommendedAction
}

type RecommendedAction

type RecommendedAction struct {
	Id         *string                      `json:"id,omitempty"`
	Kind       *string                      `json:"kind,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *RecommendedActionProperties `json:"properties,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type RecommendedActionCurrentState

type RecommendedActionCurrentState string
const (
	RecommendedActionCurrentStateActive          RecommendedActionCurrentState = "Active"
	RecommendedActionCurrentStateError           RecommendedActionCurrentState = "Error"
	RecommendedActionCurrentStateExecuting       RecommendedActionCurrentState = "Executing"
	RecommendedActionCurrentStateExpired         RecommendedActionCurrentState = "Expired"
	RecommendedActionCurrentStateIgnored         RecommendedActionCurrentState = "Ignored"
	RecommendedActionCurrentStateMonitoring      RecommendedActionCurrentState = "Monitoring"
	RecommendedActionCurrentStatePending         RecommendedActionCurrentState = "Pending"
	RecommendedActionCurrentStatePendingRevert   RecommendedActionCurrentState = "PendingRevert"
	RecommendedActionCurrentStateResolved        RecommendedActionCurrentState = "Resolved"
	RecommendedActionCurrentStateRevertCancelled RecommendedActionCurrentState = "RevertCancelled"
	RecommendedActionCurrentStateReverted        RecommendedActionCurrentState = "Reverted"
	RecommendedActionCurrentStateReverting       RecommendedActionCurrentState = "Reverting"
	RecommendedActionCurrentStateSuccess         RecommendedActionCurrentState = "Success"
	RecommendedActionCurrentStateVerifying       RecommendedActionCurrentState = "Verifying"
)

func (*RecommendedActionCurrentState) UnmarshalJSON

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

type RecommendedActionErrorInfo

type RecommendedActionErrorInfo struct {
	ErrorCode   *string      `json:"errorCode,omitempty"`
	IsRetryable *IsRetryable `json:"isRetryable,omitempty"`
}

type RecommendedActionId

type RecommendedActionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	ServerName            string
	DatabaseName          string
	AdvisorName           string
	RecommendedActionName string
}

RecommendedActionId is a struct representing the Resource ID for a Recommended Action

func NewRecommendedActionID

func NewRecommendedActionID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, advisorName string, recommendedActionName string) RecommendedActionId

NewRecommendedActionID returns a new RecommendedActionId struct

func ParseRecommendedActionID

func ParseRecommendedActionID(input string) (*RecommendedActionId, error)

ParseRecommendedActionID parses 'input' into a RecommendedActionId

func ParseRecommendedActionIDInsensitively

func ParseRecommendedActionIDInsensitively(input string) (*RecommendedActionId, error)

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

func (RecommendedActionId) ID

func (id RecommendedActionId) ID() string

ID returns the formatted Recommended Action ID

func (RecommendedActionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Recommended Action ID

func (RecommendedActionId) String

func (id RecommendedActionId) String() string

String returns a human-readable description of this Recommended Action ID

type RecommendedActionImpactRecord

type RecommendedActionImpactRecord struct {
	AbsoluteValue       *float64 `json:"absoluteValue,omitempty"`
	ChangeValueAbsolute *float64 `json:"changeValueAbsolute,omitempty"`
	ChangeValueRelative *float64 `json:"changeValueRelative,omitempty"`
	DimensionName       *string  `json:"dimensionName,omitempty"`
	Unit                *string  `json:"unit,omitempty"`
}

type RecommendedActionImplementationInfo

type RecommendedActionImplementationInfo struct {
	Method *ImplementationMethod `json:"method,omitempty"`
	Script *string               `json:"script,omitempty"`
}

type RecommendedActionInitiatedBy

type RecommendedActionInitiatedBy string
const (
	RecommendedActionInitiatedBySystem RecommendedActionInitiatedBy = "System"
	RecommendedActionInitiatedByUser   RecommendedActionInitiatedBy = "User"
)

func (*RecommendedActionInitiatedBy) UnmarshalJSON

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

type RecommendedActionMetricInfo

type RecommendedActionMetricInfo struct {
	MetricName *string  `json:"metricName,omitempty"`
	StartTime  *string  `json:"startTime,omitempty"`
	TimeGrain  *string  `json:"timeGrain,omitempty"`
	Unit       *string  `json:"unit,omitempty"`
	Value      *float64 `json:"value,omitempty"`
}

func (*RecommendedActionMetricInfo) GetStartTimeAsTime

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

func (*RecommendedActionMetricInfo) SetStartTimeAsTime

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

type RecommendedActionProperties

type RecommendedActionProperties struct {
	Details                    *map[string]interface{}              `json:"details,omitempty"`
	ErrorDetails               *RecommendedActionErrorInfo          `json:"errorDetails,omitempty"`
	EstimatedImpact            *[]RecommendedActionImpactRecord     `json:"estimatedImpact,omitempty"`
	ExecuteActionDuration      *string                              `json:"executeActionDuration,omitempty"`
	ExecuteActionInitiatedBy   *RecommendedActionInitiatedBy        `json:"executeActionInitiatedBy,omitempty"`
	ExecuteActionInitiatedTime *string                              `json:"executeActionInitiatedTime,omitempty"`
	ExecuteActionStartTime     *string                              `json:"executeActionStartTime,omitempty"`
	ImplementationDetails      *RecommendedActionImplementationInfo `json:"implementationDetails,omitempty"`
	IsArchivedAction           *bool                                `json:"isArchivedAction,omitempty"`
	IsExecutableAction         *bool                                `json:"isExecutableAction,omitempty"`
	IsRevertableAction         *bool                                `json:"isRevertableAction,omitempty"`
	LastRefresh                *string                              `json:"lastRefresh,omitempty"`
	LinkedObjects              *[]string                            `json:"linkedObjects,omitempty"`
	ObservedImpact             *[]RecommendedActionImpactRecord     `json:"observedImpact,omitempty"`
	RecommendationReason       *string                              `json:"recommendationReason,omitempty"`
	RevertActionDuration       *string                              `json:"revertActionDuration,omitempty"`
	RevertActionInitiatedBy    *RecommendedActionInitiatedBy        `json:"revertActionInitiatedBy,omitempty"`
	RevertActionInitiatedTime  *string                              `json:"revertActionInitiatedTime,omitempty"`
	RevertActionStartTime      *string                              `json:"revertActionStartTime,omitempty"`
	Score                      *int64                               `json:"score,omitempty"`
	State                      RecommendedActionStateInfo           `json:"state"`
	TimeSeries                 *[]RecommendedActionMetricInfo       `json:"timeSeries,omitempty"`
	ValidSince                 *string                              `json:"validSince,omitempty"`
}

func (*RecommendedActionProperties) GetExecuteActionInitiatedTimeAsTime

func (o *RecommendedActionProperties) GetExecuteActionInitiatedTimeAsTime() (*time.Time, error)

func (*RecommendedActionProperties) GetExecuteActionStartTimeAsTime

func (o *RecommendedActionProperties) GetExecuteActionStartTimeAsTime() (*time.Time, error)

func (*RecommendedActionProperties) GetLastRefreshAsTime

func (o *RecommendedActionProperties) GetLastRefreshAsTime() (*time.Time, error)

func (*RecommendedActionProperties) GetRevertActionInitiatedTimeAsTime

func (o *RecommendedActionProperties) GetRevertActionInitiatedTimeAsTime() (*time.Time, error)

func (*RecommendedActionProperties) GetRevertActionStartTimeAsTime

func (o *RecommendedActionProperties) GetRevertActionStartTimeAsTime() (*time.Time, error)

func (*RecommendedActionProperties) GetValidSinceAsTime

func (o *RecommendedActionProperties) GetValidSinceAsTime() (*time.Time, error)

func (*RecommendedActionProperties) SetExecuteActionInitiatedTimeAsTime

func (o *RecommendedActionProperties) SetExecuteActionInitiatedTimeAsTime(input time.Time)

func (*RecommendedActionProperties) SetExecuteActionStartTimeAsTime

func (o *RecommendedActionProperties) SetExecuteActionStartTimeAsTime(input time.Time)

func (*RecommendedActionProperties) SetLastRefreshAsTime

func (o *RecommendedActionProperties) SetLastRefreshAsTime(input time.Time)

func (*RecommendedActionProperties) SetRevertActionInitiatedTimeAsTime

func (o *RecommendedActionProperties) SetRevertActionInitiatedTimeAsTime(input time.Time)

func (*RecommendedActionProperties) SetRevertActionStartTimeAsTime

func (o *RecommendedActionProperties) SetRevertActionStartTimeAsTime(input time.Time)

func (*RecommendedActionProperties) SetValidSinceAsTime

func (o *RecommendedActionProperties) SetValidSinceAsTime(input time.Time)

type RecommendedActionStateInfo

type RecommendedActionStateInfo struct {
	ActionInitiatedBy *RecommendedActionInitiatedBy `json:"actionInitiatedBy,omitempty"`
	CurrentValue      RecommendedActionCurrentState `json:"currentValue"`
	LastModified      *string                       `json:"lastModified,omitempty"`
}

func (*RecommendedActionStateInfo) GetLastModifiedAsTime

func (o *RecommendedActionStateInfo) GetLastModifiedAsTime() (*time.Time, error)

func (*RecommendedActionStateInfo) SetLastModifiedAsTime

func (o *RecommendedActionStateInfo) SetLastModifiedAsTime(input time.Time)

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecommendedAction
}

Jump to

Keyboard shortcuts

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