databaseadvisors

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/databaseadvisors Documentation

The databaseadvisors SDK allows for interaction with Azure Resource Manager sql (API Version 2023-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/databaseadvisors"

Client Initialization

client := databaseadvisors.NewDatabaseAdvisorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseAdvisorsClient.Get

ctx := context.TODO()
id := databaseadvisors.NewDatabaseAdvisorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName", "advisorName")

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: DatabaseAdvisorsClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName")

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

Example Usage: DatabaseAdvisorsClient.Update

ctx := context.TODO()
id := databaseadvisors.NewDatabaseAdvisorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName", "advisorName")

payload := databaseadvisors.Advisor{
	// ...
}


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 PossibleValuesForAdvisorStatus 

func PossibleValuesForAdvisorStatus() []string

func PossibleValuesForAutoExecuteStatus 

func PossibleValuesForAutoExecuteStatus() []string

func PossibleValuesForAutoExecuteStatusInheritedFrom 

func PossibleValuesForAutoExecuteStatusInheritedFrom() []string

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

Types

type Advisor 

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

type AdvisorProperties 

type AdvisorProperties struct {
	AdvisorStatus                  *AdvisorStatus                  `json:"advisorStatus,omitempty"`
	AutoExecuteStatus              AutoExecuteStatus               `json:"autoExecuteStatus"`
	AutoExecuteStatusInheritedFrom *AutoExecuteStatusInheritedFrom `json:"autoExecuteStatusInheritedFrom,omitempty"`
	LastChecked                    *string                         `json:"lastChecked,omitempty"`
	RecommendationsStatus          *string                         `json:"recommendationsStatus,omitempty"`
	RecommendedActions             *[]RecommendedAction            `json:"recommendedActions,omitempty"`
}

func (*AdvisorProperties) GetLastCheckedAsTime 

func (o *AdvisorProperties) GetLastCheckedAsTime() (*time.Time, error)

func (*AdvisorProperties) SetLastCheckedAsTime 

func (o *AdvisorProperties) SetLastCheckedAsTime(input time.Time)

type AdvisorStatus 

type AdvisorStatus string
const (
	AdvisorStatusGA                   AdvisorStatus = "GA"
	AdvisorStatusLimitedPublicPreview AdvisorStatus = "LimitedPublicPreview"
	AdvisorStatusPrivatePreview       AdvisorStatus = "PrivatePreview"
	AdvisorStatusPublicPreview        AdvisorStatus = "PublicPreview"
)

func (*AdvisorStatus) UnmarshalJSON 

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

type AutoExecuteStatus 

type AutoExecuteStatus string
const (
	AutoExecuteStatusDefault  AutoExecuteStatus = "Default"
	AutoExecuteStatusDisabled AutoExecuteStatus = "Disabled"
	AutoExecuteStatusEnabled  AutoExecuteStatus = "Enabled"
)

func (*AutoExecuteStatus) UnmarshalJSON 

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

type AutoExecuteStatusInheritedFrom 

type AutoExecuteStatusInheritedFrom string
const (
	AutoExecuteStatusInheritedFromDatabase     AutoExecuteStatusInheritedFrom = "Database"
	AutoExecuteStatusInheritedFromDefault      AutoExecuteStatusInheritedFrom = "Default"
	AutoExecuteStatusInheritedFromElasticPool  AutoExecuteStatusInheritedFrom = "ElasticPool"
	AutoExecuteStatusInheritedFromServer       AutoExecuteStatusInheritedFrom = "Server"
	AutoExecuteStatusInheritedFromSubscription AutoExecuteStatusInheritedFrom = "Subscription"
)

func (*AutoExecuteStatusInheritedFrom) UnmarshalJSON 

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

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) FromParseResult 

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

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 DatabaseAdvisorsClient 

type DatabaseAdvisorsClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseAdvisorsClientWithBaseURI 

func NewDatabaseAdvisorsClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseAdvisorsClient, error)

func (DatabaseAdvisorsClient) Get 

func (c DatabaseAdvisorsClient) Get(ctx context.Context, id DatabaseAdvisorId) (result GetOperationResponse, err error)

Get ...

func (DatabaseAdvisorsClient) ListByDatabase 

func (c DatabaseAdvisorsClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId, options ListByDatabaseOperationOptions) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (DatabaseAdvisorsClient) Update 

func (c DatabaseAdvisorsClient) Update(ctx context.Context, id DatabaseAdvisorId, input Advisor) (result UpdateOperationResponse, err error)

Update ...

type GetOperationResponse 

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

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 ListByDatabaseOperationOptions 

type ListByDatabaseOperationOptions struct {
	Expand *string
}

func DefaultListByDatabaseOperationOptions 

func DefaultListByDatabaseOperationOptions() ListByDatabaseOperationOptions

func (ListByDatabaseOperationOptions) ToHeaders 

func (o ListByDatabaseOperationOptions) ToHeaders() *client.Headers

func (ListByDatabaseOperationOptions) ToOData 

func (o ListByDatabaseOperationOptions) ToOData() *odata.Query

func (ListByDatabaseOperationOptions) ToQuery 

func (o ListByDatabaseOperationOptions) ToQuery() *client.QueryParams

type ListByDatabaseOperationResponse 

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Advisor
}

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 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        *Advisor
}

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.