modelcapacities

package
v0.20241025.1143247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/modelcapacities Documentation

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

Client Initialization

client := modelcapacities.NewModelCapacitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ModelCapacitiesClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.List(ctx, id, modelcapacities.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, modelcapacities.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ModelCapacitiesClient.LocationBasedModelCapacitiesList

ctx := context.TODO()
id := modelcapacities.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

// alternatively `client.LocationBasedModelCapacitiesList(ctx, id, modelcapacities.DefaultLocationBasedModelCapacitiesListOperationOptions())` can be used to do batched pagination
items, err := client.LocationBasedModelCapacitiesListComplete(ctx, id, modelcapacities.DefaultLocationBasedModelCapacitiesListOperationOptions())
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 ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type CallRateLimit 

type CallRateLimit struct {
	Count         *float64          `json:"count,omitempty"`
	RenewalPeriod *float64          `json:"renewalPeriod,omitempty"`
	Rules         *[]ThrottlingRule `json:"rules,omitempty"`
}

type DeploymentModel 

type DeploymentModel struct {
	CallRateLimit *CallRateLimit `json:"callRateLimit,omitempty"`
	Format        *string        `json:"format,omitempty"`
	Name          *string        `json:"name,omitempty"`
	Publisher     *string        `json:"publisher,omitempty"`
	Source        *string        `json:"source,omitempty"`
	SourceAccount *string        `json:"sourceAccount,omitempty"`
	Version       *string        `json:"version,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ModelCapacityListResultValueInlined
}

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	ModelFormat  *string
	ModelName    *string
	ModelVersion *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ModelCapacityListResultValueInlined
}

type LocationBasedModelCapacitiesListCompleteResult 

type LocationBasedModelCapacitiesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ModelCapacityListResultValueInlined
}

type LocationBasedModelCapacitiesListCustomPager 

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

type LocationBasedModelCapacitiesListOperationOptions 

type LocationBasedModelCapacitiesListOperationOptions struct {
	ModelFormat  *string
	ModelName    *string
	ModelVersion *string
}

func DefaultLocationBasedModelCapacitiesListOperationOptions 

func DefaultLocationBasedModelCapacitiesListOperationOptions() LocationBasedModelCapacitiesListOperationOptions

func (LocationBasedModelCapacitiesListOperationOptions) ToHeaders 

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

func (LocationBasedModelCapacitiesListOperationOptions) ToOData 

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

func (LocationBasedModelCapacitiesListOperationOptions) ToQuery 

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

type LocationBasedModelCapacitiesListOperationResponse 

type LocationBasedModelCapacitiesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ModelCapacityListResultValueInlined
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ModelCapacitiesClient 

type ModelCapacitiesClient struct {
	Client *resourcemanager.Client
}

func NewModelCapacitiesClientWithBaseURI 

func NewModelCapacitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*ModelCapacitiesClient, error)

func (ModelCapacitiesClient) List 

func (c ModelCapacitiesClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ModelCapacitiesClient) ListComplete 

func (c ModelCapacitiesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ModelCapacitiesClient) ListCompleteMatchingPredicate 

func (c ModelCapacitiesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate ModelCapacityListResultValueInlinedOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ModelCapacitiesClient) LocationBasedModelCapacitiesList 

func (c ModelCapacitiesClient) LocationBasedModelCapacitiesList(ctx context.Context, id LocationId, options LocationBasedModelCapacitiesListOperationOptions) (result LocationBasedModelCapacitiesListOperationResponse, err error)

LocationBasedModelCapacitiesList ...

func (ModelCapacitiesClient) LocationBasedModelCapacitiesListComplete 

func (c ModelCapacitiesClient) LocationBasedModelCapacitiesListComplete(ctx context.Context, id LocationId, options LocationBasedModelCapacitiesListOperationOptions) (LocationBasedModelCapacitiesListCompleteResult, error)

LocationBasedModelCapacitiesListComplete retrieves all the results into a single object

func (ModelCapacitiesClient) LocationBasedModelCapacitiesListCompleteMatchingPredicate 

func (c ModelCapacitiesClient) LocationBasedModelCapacitiesListCompleteMatchingPredicate(ctx context.Context, id LocationId, options LocationBasedModelCapacitiesListOperationOptions, predicate ModelCapacityListResultValueInlinedOperationPredicate) (result LocationBasedModelCapacitiesListCompleteResult, err error)

LocationBasedModelCapacitiesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ModelCapacityListResultValueInlined 

type ModelCapacityListResultValueInlined struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *ModelSkuCapacityProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ModelCapacityListResultValueInlinedOperationPredicate 

type ModelCapacityListResultValueInlinedOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ModelCapacityListResultValueInlinedOperationPredicate) Matches 

func (p ModelCapacityListResultValueInlinedOperationPredicate) Matches(input ModelCapacityListResultValueInlined) bool

type ModelSkuCapacityProperties 

type ModelSkuCapacityProperties struct {
	AvailableCapacity         *float64         `json:"availableCapacity,omitempty"`
	AvailableFinetuneCapacity *float64         `json:"availableFinetuneCapacity,omitempty"`
	Model                     *DeploymentModel `json:"model,omitempty"`
	SkuName                   *string          `json:"skuName,omitempty"`
}

type RequestMatchPattern 

type RequestMatchPattern struct {
	Method *string `json:"method,omitempty"`
	Path   *string `json:"path,omitempty"`
}

type ThrottlingRule 

type ThrottlingRule struct {
	Count                    *float64               `json:"count,omitempty"`
	DynamicThrottlingEnabled *bool                  `json:"dynamicThrottlingEnabled,omitempty"`
	Key                      *string                `json:"key,omitempty"`
	MatchPatterns            *[]RequestMatchPattern `json:"matchPatterns,omitempty"`
	MinCount                 *float64               `json:"minCount,omitempty"`
	RenewalPeriod            *float64               `json:"renewalPeriod,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.