modelcontainer

package
v0.20230728.1130002 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2022-05-01/modelcontainer Documentation

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

Client Initialization

client := modelcontainer.NewModelContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ModelContainerClient.CreateOrUpdate

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

payload := modelcontainer.ModelContainerResource{
	// ...
}


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

Example Usage: ModelContainerClient.Delete

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

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

Example Usage: ModelContainerClient.Get

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

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: ModelContainerClient.List

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

// alternatively `client.List(ctx, id, modelcontainer.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, modelcontainer.DefaultListOperationOptions())
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 PossibleValuesForListViewType

func PossibleValuesForListViewType() []string

func ValidateModelID

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

ValidateModelID checks that 'input' can be parsed as a Model ID

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AssetContainer

type AssetContainer struct {
	Description   *string            `json:"description,omitempty"`
	IsArchived    *bool              `json:"isArchived,omitempty"`
	LatestVersion *string            `json:"latestVersion,omitempty"`
	NextVersion   *string            `json:"nextVersion,omitempty"`
	Properties    *map[string]string `json:"properties,omitempty"`
	Tags          *map[string]string `json:"tags,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ModelContainerResource
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []ModelContainerResource
}

type ListOperationOptions

type ListOperationOptions struct {
	Count        *int64
	ListViewType *ListViewType
	Skip         *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230713.1092427

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

func (ListOperationOptions) ToOData added in v0.20230713.1092427

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

func (ListOperationOptions) ToQuery added in v0.20230713.1092427

type ListOperationResponse

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

type ListViewType

type ListViewType string
const (
	ListViewTypeActiveOnly   ListViewType = "ActiveOnly"
	ListViewTypeAll          ListViewType = "All"
	ListViewTypeArchivedOnly ListViewType = "ArchivedOnly"
)

func (*ListViewType) UnmarshalJSON added in v0.20230713.1092427

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

type ModelContainerClient

type ModelContainerClient struct {
	Client *resourcemanager.Client
}

func NewModelContainerClientWithBaseURI

func NewModelContainerClientWithBaseURI(api environments.Api) (*ModelContainerClient, error)

func (ModelContainerClient) CreateOrUpdate

CreateOrUpdate ...

func (ModelContainerClient) Delete

func (c ModelContainerClient) Delete(ctx context.Context, id ModelId) (result DeleteOperationResponse, err error)

Delete ...

func (ModelContainerClient) Get

Get ...

func (ModelContainerClient) List

List ...

func (ModelContainerClient) ListComplete

ListComplete retrieves all the results into a single object

func (ModelContainerClient) ListCompleteMatchingPredicate

func (c ModelContainerClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate ModelContainerResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ModelContainerResource

type ModelContainerResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties AssetContainer         `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ModelContainerResourceOperationPredicate

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

func (ModelContainerResourceOperationPredicate) Matches

type ModelId

type ModelId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ModelName         string
}

ModelId is a struct representing the Resource ID for a Model

func NewModelID

func NewModelID(subscriptionId string, resourceGroupName string, workspaceName string, modelName string) ModelId

NewModelID returns a new ModelId struct

func ParseModelID

func ParseModelID(input string) (*ModelId, error)

ParseModelID parses 'input' into a ModelId

func ParseModelIDInsensitively

func ParseModelIDInsensitively(input string) (*ModelId, error)

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

func (ModelId) ID

func (id ModelId) ID() string

ID returns the formatted Model ID

func (ModelId) Segments

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

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

func (ModelId) String

func (id ModelId) String() string

String returns a human-readable description of this Model ID

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

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

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL