recommendedactions

package
v0.20231109.1085442 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2018-06-01/recommendedactions Documentation

The recommendedactions SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2018-06-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/postgresql/2018-06-01/recommendedactions"

Client Initialization

client := recommendedactions.NewRecommendedActionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecommendedActionsClient.Get

ctx := context.TODO()
id := recommendedactions.NewRecommendedActionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "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: RecommendedActionsClient.ListByServer

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

// alternatively `client.ListByServer(ctx, id, recommendedactions.DefaultListByServerOperationOptions())` can be used to do batched pagination
items, err := client.ListByServerComplete(ctx, id, recommendedactions.DefaultListByServerOperationOptions())
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 ValidateAdvisorID 

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

ValidateAdvisorID checks that 'input' can be parsed as a 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 AdvisorId 

type AdvisorId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	AdvisorName       string
}

AdvisorId is a struct representing the Resource ID for a Advisor

func NewAdvisorID 

func NewAdvisorID(subscriptionId string, resourceGroupName string, serverName string, advisorName string) AdvisorId

NewAdvisorID returns a new AdvisorId struct

func ParseAdvisorID 

func ParseAdvisorID(input string) (*AdvisorId, error)

ParseAdvisorID parses 'input' into a AdvisorId

func ParseAdvisorIDInsensitively 

func ParseAdvisorIDInsensitively(input string) (*AdvisorId, error)

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

func (AdvisorId) ID 

func (id AdvisorId) ID() string

ID returns the formatted Advisor ID

func (AdvisorId) Segments 

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

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

func (AdvisorId) String 

func (id AdvisorId) String() string

String returns a human-readable description of this Advisor ID

type GetOperationResponse 

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

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	Items []RecommendationAction
}

type ListByServerOperationOptions 

type ListByServerOperationOptions struct {
	SessionId *string
}

func DefaultListByServerOperationOptions 

func DefaultListByServerOperationOptions() ListByServerOperationOptions

func (ListByServerOperationOptions) ToHeaders added in v0.20230809.1081239 

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

func (ListByServerOperationOptions) ToOData added in v0.20230809.1081239 

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

func (ListByServerOperationOptions) ToQuery added in v0.20230809.1081239 

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

type ListByServerOperationResponse 

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecommendationAction
}

type RecommendationAction 

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

type RecommendationActionOperationPredicate 

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

func (RecommendationActionOperationPredicate) Matches 

func (p RecommendationActionOperationPredicate) Matches(input RecommendationAction) bool

type RecommendationActionProperties 

type RecommendationActionProperties struct {
	ActionId           *int64             `json:"actionId,omitempty"`
	AdvisorName        *string            `json:"advisorName,omitempty"`
	CreatedTime        *string            `json:"createdTime,omitempty"`
	Details            *map[string]string `json:"details,omitempty"`
	ExpirationTime     *string            `json:"expirationTime,omitempty"`
	Reason             *string            `json:"reason,omitempty"`
	RecommendationType *string            `json:"recommendationType,omitempty"`
	SessionId          *string            `json:"sessionId,omitempty"`
}

func (*RecommendationActionProperties) GetCreatedTimeAsTime 

func (o *RecommendationActionProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*RecommendationActionProperties) GetExpirationTimeAsTime 

func (o *RecommendationActionProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*RecommendationActionProperties) SetCreatedTimeAsTime 

func (o *RecommendationActionProperties) SetCreatedTimeAsTime(input time.Time)

func (*RecommendationActionProperties) SetExpirationTimeAsTime 

func (o *RecommendationActionProperties) SetExpirationTimeAsTime(input time.Time)

type RecommendedActionId 

type RecommendedActionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	ServerName            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, 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 RecommendedActionsClient 

type RecommendedActionsClient struct {
	Client *resourcemanager.Client
}

func NewRecommendedActionsClientWithBaseURI 

func NewRecommendedActionsClientWithBaseURI(sdkApi sdkEnv.Api) (*RecommendedActionsClient, error)

func (RecommendedActionsClient) Get 

func (c RecommendedActionsClient) Get(ctx context.Context, id RecommendedActionId) (result GetOperationResponse, err error)

Get ...

func (RecommendedActionsClient) ListByServer 

func (c RecommendedActionsClient) ListByServer(ctx context.Context, id AdvisorId, options ListByServerOperationOptions) (result ListByServerOperationResponse, err error)

ListByServer ...

func (RecommendedActionsClient) ListByServerComplete 

func (c RecommendedActionsClient) ListByServerComplete(ctx context.Context, id AdvisorId, options ListByServerOperationOptions) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (RecommendedActionsClient) ListByServerCompleteMatchingPredicate 

func (c RecommendedActionsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id AdvisorId, options ListByServerOperationOptions, predicate RecommendationActionOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.