favoritesapis

package
v0.20231108.1171627 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2015-05-01/favoritesapis Documentation

The favoritesapis SDK allows for interaction with the Azure Resource Manager Service applicationinsights (API Version 2015-05-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/applicationinsights/2015-05-01/favoritesapis"

Client Initialization

client := favoritesapis.NewFavoritesAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FavoritesAPIsClient.FavoritesAdd

ctx := context.TODO()
id := favoritesapis.NewFavoriteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "favoriteIdValue")

payload := favoritesapis.ApplicationInsightsComponentFavorite{
	// ...
}


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

Example Usage: FavoritesAPIsClient.FavoritesDelete

ctx := context.TODO()
id := favoritesapis.NewFavoriteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "favoriteIdValue")

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

Example Usage: FavoritesAPIsClient.FavoritesGet

ctx := context.TODO()
id := favoritesapis.NewFavoriteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "favoriteIdValue")

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

Example Usage: FavoritesAPIsClient.FavoritesList

ctx := context.TODO()
id := favoritesapis.NewComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue")

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

Example Usage: FavoritesAPIsClient.FavoritesUpdate

ctx := context.TODO()
id := favoritesapis.NewFavoriteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "favoriteIdValue")

payload := favoritesapis.ApplicationInsightsComponentFavorite{
	// ...
}


read, err := client.FavoritesUpdate(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 PossibleValuesForFavoriteSourceType 

func PossibleValuesForFavoriteSourceType() []string

func PossibleValuesForFavoriteType 

func PossibleValuesForFavoriteType() []string

func ValidateComponentID 

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

ValidateComponentID checks that 'input' can be parsed as a Component ID

func ValidateFavoriteID 

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

ValidateFavoriteID checks that 'input' can be parsed as a Favorite ID

Types

type ApplicationInsightsComponentFavorite 

type ApplicationInsightsComponentFavorite struct {
	Category                *string       `json:"Category,omitempty"`
	Config                  *string       `json:"Config,omitempty"`
	FavoriteId              *string       `json:"FavoriteId,omitempty"`
	FavoriteType            *FavoriteType `json:"FavoriteType,omitempty"`
	IsGeneratedFromTemplate *bool         `json:"IsGeneratedFromTemplate,omitempty"`
	Name                    *string       `json:"Name,omitempty"`
	SourceType              *string       `json:"SourceType,omitempty"`
	Tags                    *[]string     `json:"Tags,omitempty"`
	TimeModified            *string       `json:"TimeModified,omitempty"`
	UserId                  *string       `json:"UserId,omitempty"`
	Version                 *string       `json:"Version,omitempty"`
}

type ComponentId 

type ComponentId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
}

ComponentId is a struct representing the Resource ID for a Component

func NewComponentID 

func NewComponentID(subscriptionId string, resourceGroupName string, componentName string) ComponentId

NewComponentID returns a new ComponentId struct

func ParseComponentID 

func ParseComponentID(input string) (*ComponentId, error)

ParseComponentID parses 'input' into a ComponentId

func ParseComponentIDInsensitively 

func ParseComponentIDInsensitively(input string) (*ComponentId, error)

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

func (ComponentId) ID 

func (id ComponentId) ID() string

ID returns the formatted Component ID

func (ComponentId) Segments 

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

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

func (ComponentId) String 

func (id ComponentId) String() string

String returns a human-readable description of this Component ID

type FavoriteId 

type FavoriteId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
	FavoriteId        string
}

FavoriteId is a struct representing the Resource ID for a Favorite

func NewFavoriteID 

func NewFavoriteID(subscriptionId string, resourceGroupName string, componentName string, favoriteId string) FavoriteId

NewFavoriteID returns a new FavoriteId struct

func ParseFavoriteID 

func ParseFavoriteID(input string) (*FavoriteId, error)

ParseFavoriteID parses 'input' into a FavoriteId

func ParseFavoriteIDInsensitively 

func ParseFavoriteIDInsensitively(input string) (*FavoriteId, error)

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

func (FavoriteId) ID 

func (id FavoriteId) ID() string

ID returns the formatted Favorite ID

func (FavoriteId) Segments 

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

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

func (FavoriteId) String 

func (id FavoriteId) String() string

String returns a human-readable description of this Favorite ID

type FavoriteSourceType 

type FavoriteSourceType string
const (
	FavoriteSourceTypeEvents       FavoriteSourceType = "events"
	FavoriteSourceTypeFunnel       FavoriteSourceType = "funnel"
	FavoriteSourceTypeImpact       FavoriteSourceType = "impact"
	FavoriteSourceTypeNotebook     FavoriteSourceType = "notebook"
	FavoriteSourceTypeRetention    FavoriteSourceType = "retention"
	FavoriteSourceTypeSegmentation FavoriteSourceType = "segmentation"
	FavoriteSourceTypeSessions     FavoriteSourceType = "sessions"
	FavoriteSourceTypeUserflows    FavoriteSourceType = "userflows"
)

func (*FavoriteSourceType) UnmarshalJSON 

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

type FavoriteType 

type FavoriteType string
const (
	FavoriteTypeShared FavoriteType = "shared"
	FavoriteTypeUser   FavoriteType = "user"
)

func (*FavoriteType) UnmarshalJSON 

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

type FavoritesAPIsClient 

type FavoritesAPIsClient struct {
	Client *resourcemanager.Client
}

func NewFavoritesAPIsClientWithBaseURI 

func NewFavoritesAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*FavoritesAPIsClient, error)

func (FavoritesAPIsClient) FavoritesAdd 

func (c FavoritesAPIsClient) FavoritesAdd(ctx context.Context, id FavoriteId, input ApplicationInsightsComponentFavorite) (result FavoritesAddOperationResponse, err error)

FavoritesAdd ...

func (FavoritesAPIsClient) FavoritesDelete 

func (c FavoritesAPIsClient) FavoritesDelete(ctx context.Context, id FavoriteId) (result FavoritesDeleteOperationResponse, err error)

FavoritesDelete ...

func (FavoritesAPIsClient) FavoritesGet 

func (c FavoritesAPIsClient) FavoritesGet(ctx context.Context, id FavoriteId) (result FavoritesGetOperationResponse, err error)

FavoritesGet ...

func (FavoritesAPIsClient) FavoritesList 

func (c FavoritesAPIsClient) FavoritesList(ctx context.Context, id ComponentId, options FavoritesListOperationOptions) (result FavoritesListOperationResponse, err error)

FavoritesList ...

func (FavoritesAPIsClient) FavoritesUpdate 

func (c FavoritesAPIsClient) FavoritesUpdate(ctx context.Context, id FavoriteId, input ApplicationInsightsComponentFavorite) (result FavoritesUpdateOperationResponse, err error)

FavoritesUpdate ...

type FavoritesAddOperationResponse 

type FavoritesAddOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentFavorite
}

type FavoritesDeleteOperationResponse 

type FavoritesDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type FavoritesGetOperationResponse 

type FavoritesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentFavorite
}

type FavoritesListOperationOptions 

type FavoritesListOperationOptions struct {
	CanFetchContent *bool
	FavoriteType    *FavoriteType
	SourceType      *FavoriteSourceType
	Tags            *string
}

func DefaultFavoritesListOperationOptions 

func DefaultFavoritesListOperationOptions() FavoritesListOperationOptions

func (FavoritesListOperationOptions) ToHeaders 

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

func (FavoritesListOperationOptions) ToOData 

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

func (FavoritesListOperationOptions) ToQuery 

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

type FavoritesListOperationResponse 

type FavoritesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationInsightsComponentFavorite
}

type FavoritesUpdateOperationResponse 

type FavoritesUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentFavorite
}

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.