dataversion

package
v0.20231113.1151754 Latest Latest
Warning

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

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

README

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

The dataversion 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/dataversion"

Client Initialization

client := dataversion.NewDataVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataVersionClient.CreateOrUpdate

ctx := context.TODO()
id := dataversion.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "dataValue", "versionValue")

payload := dataversion.DataVersionBaseResource{
	// ...
}


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: DataVersionClient.Delete

ctx := context.TODO()
id := dataversion.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "dataValue", "versionValue")

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: DataVersionClient.Get

ctx := context.TODO()
id := dataversion.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "dataValue", "versionValue")

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

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

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

func PossibleValuesForDataType() []string

func PossibleValuesForListViewType

func PossibleValuesForListViewType() []string

func ValidateDataID

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

ValidateDataID checks that 'input' can be parsed as a Data ID

func ValidateVersionID

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

ValidateVersionID checks that 'input' can be parsed as a Version ID

Types

type CreateOrUpdateOperationResponse

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

type DataId

type DataId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	DataName          string
}

DataId is a struct representing the Resource ID for a Data

func NewDataID

func NewDataID(subscriptionId string, resourceGroupName string, workspaceName string, dataName string) DataId

NewDataID returns a new DataId struct

func ParseDataID

func ParseDataID(input string) (*DataId, error)

ParseDataID parses 'input' into a DataId

func ParseDataIDInsensitively

func ParseDataIDInsensitively(input string) (*DataId, error)

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

func (DataId) ID

func (id DataId) ID() string

ID returns the formatted Data ID

func (DataId) Segments

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

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

func (DataId) String

func (id DataId) String() string

String returns a human-readable description of this Data ID

type DataType

type DataType string
const (
	DataTypeMltable   DataType = "mltable"
	DataTypeUriFile   DataType = "uri_file"
	DataTypeUriFolder DataType = "uri_folder"
)

func (*DataType) UnmarshalJSON added in v0.20230713.1092427

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

type DataVersionBase

type DataVersionBase interface {
}

type DataVersionBaseResource

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

func (*DataVersionBaseResource) UnmarshalJSON

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

type DataVersionBaseResourceOperationPredicate

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

func (DataVersionBaseResourceOperationPredicate) Matches

type DataVersionClient

type DataVersionClient struct {
	Client *resourcemanager.Client
}

func NewDataVersionClientWithBaseURI

func NewDataVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*DataVersionClient, error)

func (DataVersionClient) CreateOrUpdate

CreateOrUpdate ...

func (DataVersionClient) Delete

func (c DataVersionClient) Delete(ctx context.Context, id VersionId) (result DeleteOperationResponse, err error)

Delete ...

func (DataVersionClient) Get

Get ...

func (DataVersionClient) List

List ...

func (DataVersionClient) ListComplete

ListComplete retrieves all the results into a single object

func (DataVersionClient) ListCompleteMatchingPredicate

func (c DataVersionClient) ListCompleteMatchingPredicate(ctx context.Context, id DataId, options ListOperationOptions, predicate DataVersionBaseResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []DataVersionBaseResource
}

type ListOperationOptions

type ListOperationOptions struct {
	ListViewType *ListViewType
	OrderBy      *string
	Skip         *string
	Tags         *string
	Top          *int64
}

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        *[]DataVersionBaseResource
}

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 MLTableData

type MLTableData struct {
	ReferencedUris *[]string `json:"referencedUris,omitempty"`

	// Fields inherited from DataVersionBase
	DataUri     string             `json:"dataUri"`
	Description *string            `json:"description,omitempty"`
	IsAnonymous *bool              `json:"isAnonymous,omitempty"`
	IsArchived  *bool              `json:"isArchived,omitempty"`
	Properties  *map[string]string `json:"properties,omitempty"`
	Tags        *map[string]string `json:"tags,omitempty"`
}

func (MLTableData) MarshalJSON

func (s MLTableData) MarshalJSON() ([]byte, error)

type RawDataVersionBaseImpl added in v0.20230807.1063129

type RawDataVersionBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawDataVersionBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type UriFileDataVersion

type UriFileDataVersion struct {

	// Fields inherited from DataVersionBase
	DataUri     string             `json:"dataUri"`
	Description *string            `json:"description,omitempty"`
	IsAnonymous *bool              `json:"isAnonymous,omitempty"`
	IsArchived  *bool              `json:"isArchived,omitempty"`
	Properties  *map[string]string `json:"properties,omitempty"`
	Tags        *map[string]string `json:"tags,omitempty"`
}

func (UriFileDataVersion) MarshalJSON

func (s UriFileDataVersion) MarshalJSON() ([]byte, error)

type UriFolderDataVersion

type UriFolderDataVersion struct {

	// Fields inherited from DataVersionBase
	DataUri     string             `json:"dataUri"`
	Description *string            `json:"description,omitempty"`
	IsAnonymous *bool              `json:"isAnonymous,omitempty"`
	IsArchived  *bool              `json:"isArchived,omitempty"`
	Properties  *map[string]string `json:"properties,omitempty"`
	Tags        *map[string]string `json:"tags,omitempty"`
}

func (UriFolderDataVersion) MarshalJSON

func (s UriFolderDataVersion) MarshalJSON() ([]byte, error)

type VersionId

type VersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	DataName          string
	VersionName       string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID

func NewVersionID(subscriptionId string, resourceGroupName string, workspaceName string, dataName string, versionName string) VersionId

NewVersionID returns a new VersionId struct

func ParseVersionID

func ParseVersionID(input string) (*VersionId, error)

ParseVersionID parses 'input' into a VersionId

func ParseVersionIDInsensitively

func ParseVersionIDInsensitively(input string) (*VersionId, error)

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

func (VersionId) ID

func (id VersionId) ID() string

ID returns the formatted Version ID

func (VersionId) Segments

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

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

func (VersionId) String

func (id VersionId) String() string

String returns a human-readable description of this Version ID

Jump to

Keyboard shortcuts

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