sqlpoolsworkloadgroups

package
v0.20240826.1115152 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsworkloadgroups Documentation

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

Client Initialization

client := sqlpoolsworkloadgroups.NewSqlPoolsWorkloadGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsWorkloadGroupsClient.SqlPoolWorkloadGroupCreateOrUpdate

ctx := context.TODO()
id := sqlpoolsworkloadgroups.NewWorkloadGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "workloadGroupValue")

payload := sqlpoolsworkloadgroups.WorkloadGroup{
	// ...
}


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

Example Usage: SqlPoolsWorkloadGroupsClient.SqlPoolWorkloadGroupDelete

ctx := context.TODO()
id := sqlpoolsworkloadgroups.NewWorkloadGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "workloadGroupValue")

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

Example Usage: SqlPoolsWorkloadGroupsClient.SqlPoolWorkloadGroupGet

ctx := context.TODO()
id := sqlpoolsworkloadgroups.NewWorkloadGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "workloadGroupValue")

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

Example Usage: SqlPoolsWorkloadGroupsClient.SqlPoolWorkloadGroupList

ctx := context.TODO()
id := sqlpoolsworkloadgroups.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

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

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

ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID

func ValidateWorkloadGroupID 

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

ValidateWorkloadGroupID checks that 'input' can be parsed as a Workload Group ID

Types

type SqlPoolId 

type SqlPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
}

SqlPoolId is a struct representing the Resource ID for a Sql Pool

func NewSqlPoolID 

func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string) SqlPoolId

NewSqlPoolID returns a new SqlPoolId struct

func ParseSqlPoolID 

func ParseSqlPoolID(input string) (*SqlPoolId, error)

ParseSqlPoolID parses 'input' into a SqlPoolId

func ParseSqlPoolIDInsensitively 

func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)

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

func (*SqlPoolId) FromParseResult 

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

func (SqlPoolId) ID 

func (id SqlPoolId) ID() string

ID returns the formatted Sql Pool ID

func (SqlPoolId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sql Pool ID

func (SqlPoolId) String 

func (id SqlPoolId) String() string

String returns a human-readable description of this Sql Pool ID

type SqlPoolWorkloadGroupCreateOrUpdateOperationResponse 

type SqlPoolWorkloadGroupCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkloadGroup
}

type SqlPoolWorkloadGroupDeleteOperationResponse 

type SqlPoolWorkloadGroupDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type SqlPoolWorkloadGroupGetOperationResponse 

type SqlPoolWorkloadGroupGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkloadGroup
}

type SqlPoolWorkloadGroupListCompleteResult 

type SqlPoolWorkloadGroupListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkloadGroup
}

type SqlPoolWorkloadGroupListCustomPager added in v0.20240628.1153531 

type SqlPoolWorkloadGroupListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *SqlPoolWorkloadGroupListCustomPager) NextPageLink() *odata.Link

type SqlPoolWorkloadGroupListOperationResponse 

type SqlPoolWorkloadGroupListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkloadGroup
}

type SqlPoolsWorkloadGroupsClient 

type SqlPoolsWorkloadGroupsClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsWorkloadGroupsClientWithBaseURI 

func NewSqlPoolsWorkloadGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsWorkloadGroupsClient, error)

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupCreateOrUpdate 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupCreateOrUpdate(ctx context.Context, id WorkloadGroupId, input WorkloadGroup) (result SqlPoolWorkloadGroupCreateOrUpdateOperationResponse, err error)

SqlPoolWorkloadGroupCreateOrUpdate ...

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupCreateOrUpdateThenPoll 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupCreateOrUpdateThenPoll(ctx context.Context, id WorkloadGroupId, input WorkloadGroup) error

SqlPoolWorkloadGroupCreateOrUpdateThenPoll performs SqlPoolWorkloadGroupCreateOrUpdate then polls until it's completed

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupDelete 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupDelete(ctx context.Context, id WorkloadGroupId) (result SqlPoolWorkloadGroupDeleteOperationResponse, err error)

SqlPoolWorkloadGroupDelete ...

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupDeleteThenPoll 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupDeleteThenPoll(ctx context.Context, id WorkloadGroupId) error

SqlPoolWorkloadGroupDeleteThenPoll performs SqlPoolWorkloadGroupDelete then polls until it's completed

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupGet 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupGet(ctx context.Context, id WorkloadGroupId) (result SqlPoolWorkloadGroupGetOperationResponse, err error)

SqlPoolWorkloadGroupGet ...

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupList 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupList(ctx context.Context, id SqlPoolId) (result SqlPoolWorkloadGroupListOperationResponse, err error)

SqlPoolWorkloadGroupList ...

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupListComplete 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupListComplete(ctx context.Context, id SqlPoolId) (SqlPoolWorkloadGroupListCompleteResult, error)

SqlPoolWorkloadGroupListComplete retrieves all the results into a single object

func (SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupListCompleteMatchingPredicate 

func (c SqlPoolsWorkloadGroupsClient) SqlPoolWorkloadGroupListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate WorkloadGroupOperationPredicate) (result SqlPoolWorkloadGroupListCompleteResult, err error)

SqlPoolWorkloadGroupListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkloadGroup 

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

type WorkloadGroupId 

type WorkloadGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
	WorkloadGroupName string
}

WorkloadGroupId is a struct representing the Resource ID for a Workload Group

func NewWorkloadGroupID 

func NewWorkloadGroupID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string) WorkloadGroupId

NewWorkloadGroupID returns a new WorkloadGroupId struct

func ParseWorkloadGroupID 

func ParseWorkloadGroupID(input string) (*WorkloadGroupId, error)

ParseWorkloadGroupID parses 'input' into a WorkloadGroupId

func ParseWorkloadGroupIDInsensitively 

func ParseWorkloadGroupIDInsensitively(input string) (*WorkloadGroupId, error)

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

func (*WorkloadGroupId) FromParseResult 

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

func (WorkloadGroupId) ID 

func (id WorkloadGroupId) ID() string

ID returns the formatted Workload Group ID

func (WorkloadGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workload Group ID

func (WorkloadGroupId) String 

func (id WorkloadGroupId) String() string

String returns a human-readable description of this Workload Group ID

type WorkloadGroupOperationPredicate 

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

func (WorkloadGroupOperationPredicate) Matches 

func (p WorkloadGroupOperationPredicate) Matches(input WorkloadGroup) bool

type WorkloadGroupProperties 

type WorkloadGroupProperties struct {
	Importance                   *string  `json:"importance,omitempty"`
	MaxResourcePercent           int64    `json:"maxResourcePercent"`
	MaxResourcePercentPerRequest *float64 `json:"maxResourcePercentPerRequest,omitempty"`
	MinResourcePercent           int64    `json:"minResourcePercent"`
	MinResourcePercentPerRequest float64  `json:"minResourcePercentPerRequest"`
	QueryExecutionTimeout        *int64   `json:"queryExecutionTimeout,omitempty"`
}

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.