dataversionregistry

package
v0.20240529.1155048 Latest Latest
Warning

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

Go to latest
Published: May 29, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/dataversionregistry Documentation

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

Client Initialization

client := dataversionregistry.NewDataVersionRegistryClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataVersionRegistryClient.RegistryDataVersionsCreateOrGetStartPendingUpload

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

payload := dataversionregistry.PendingUploadRequestDto{
	// ...
}


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

Example Usage: DataVersionRegistryClient.RegistryDataVersionsCreateOrUpdate

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

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


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

Example Usage: DataVersionRegistryClient.RegistryDataVersionsDelete

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

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

Example Usage: DataVersionRegistryClient.RegistryDataVersionsGet

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

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

Example Usage: DataVersionRegistryClient.RegistryDataVersionsList

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

// alternatively `client.RegistryDataVersionsList(ctx, id, dataversionregistry.DefaultRegistryDataVersionsListOperationOptions())` can be used to do batched pagination
items, err := client.RegistryDataVersionsListComplete(ctx, id, dataversionregistry.DefaultRegistryDataVersionsListOperationOptions())
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 PossibleValuesForPendingUploadCredentialType

func PossibleValuesForPendingUploadCredentialType() []string

func PossibleValuesForPendingUploadType

func PossibleValuesForPendingUploadType() []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 BlobReferenceForConsumptionDto

type BlobReferenceForConsumptionDto struct {
	BlobUri             *string                    `json:"blobUri,omitempty"`
	Credential          PendingUploadCredentialDto `json:"credential"`
	StorageAccountArmId *string                    `json:"storageAccountArmId,omitempty"`
}

func (*BlobReferenceForConsumptionDto) UnmarshalJSON

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

type DataId

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

DataId is a struct representing the Resource ID for a Data

func NewDataID

func NewDataID(subscriptionId string, resourceGroupName string, registryName 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) FromParseResult

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

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

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 DataVersionRegistryClient

type DataVersionRegistryClient struct {
	Client *resourcemanager.Client
}

func NewDataVersionRegistryClientWithBaseURI

func NewDataVersionRegistryClientWithBaseURI(sdkApi sdkEnv.Api) (*DataVersionRegistryClient, error)

func (DataVersionRegistryClient) RegistryDataVersionsCreateOrGetStartPendingUpload

func (c DataVersionRegistryClient) RegistryDataVersionsCreateOrGetStartPendingUpload(ctx context.Context, id VersionId, input PendingUploadRequestDto) (result RegistryDataVersionsCreateOrGetStartPendingUploadOperationResponse, err error)

RegistryDataVersionsCreateOrGetStartPendingUpload ...

func (DataVersionRegistryClient) RegistryDataVersionsCreateOrUpdate

RegistryDataVersionsCreateOrUpdate ...

func (DataVersionRegistryClient) RegistryDataVersionsCreateOrUpdateThenPoll

func (c DataVersionRegistryClient) RegistryDataVersionsCreateOrUpdateThenPoll(ctx context.Context, id VersionId, input DataVersionBaseResource) error

RegistryDataVersionsCreateOrUpdateThenPoll performs RegistryDataVersionsCreateOrUpdate then polls until it's completed

func (DataVersionRegistryClient) RegistryDataVersionsDelete

func (c DataVersionRegistryClient) RegistryDataVersionsDelete(ctx context.Context, id VersionId) (result RegistryDataVersionsDeleteOperationResponse, err error)

RegistryDataVersionsDelete ...

func (DataVersionRegistryClient) RegistryDataVersionsDeleteThenPoll

func (c DataVersionRegistryClient) RegistryDataVersionsDeleteThenPoll(ctx context.Context, id VersionId) error

RegistryDataVersionsDeleteThenPoll performs RegistryDataVersionsDelete then polls until it's completed

func (DataVersionRegistryClient) RegistryDataVersionsGet

func (c DataVersionRegistryClient) RegistryDataVersionsGet(ctx context.Context, id VersionId) (result RegistryDataVersionsGetOperationResponse, err error)

RegistryDataVersionsGet ...

func (DataVersionRegistryClient) RegistryDataVersionsList

RegistryDataVersionsList ...

func (DataVersionRegistryClient) RegistryDataVersionsListComplete

RegistryDataVersionsListComplete retrieves all the results into a single object

func (DataVersionRegistryClient) RegistryDataVersionsListCompleteMatchingPredicate

RegistryDataVersionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListViewType

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

func (*ListViewType) UnmarshalJSON

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 PendingUploadCredentialDto

type PendingUploadCredentialDto interface {
}

type PendingUploadCredentialType

type PendingUploadCredentialType string
const (
	PendingUploadCredentialTypeSAS PendingUploadCredentialType = "SAS"
)

func (*PendingUploadCredentialType) UnmarshalJSON

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

type PendingUploadRequestDto

type PendingUploadRequestDto struct {
	PendingUploadId   *string            `json:"pendingUploadId,omitempty"`
	PendingUploadType *PendingUploadType `json:"pendingUploadType,omitempty"`
}

type PendingUploadResponseDto

type PendingUploadResponseDto struct {
	BlobReferenceForConsumption *BlobReferenceForConsumptionDto `json:"blobReferenceForConsumption,omitempty"`
	PendingUploadId             *string                         `json:"pendingUploadId,omitempty"`
	PendingUploadType           *PendingUploadType              `json:"pendingUploadType,omitempty"`
}

type PendingUploadType

type PendingUploadType string
const (
	PendingUploadTypeNone                   PendingUploadType = "None"
	PendingUploadTypeTemporaryBlobReference PendingUploadType = "TemporaryBlobReference"
)

func (*PendingUploadType) UnmarshalJSON

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

type RawDataVersionBaseImpl

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 RawPendingUploadCredentialDtoImpl

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

RawPendingUploadCredentialDtoImpl 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 RegistryDataVersionsCreateOrGetStartPendingUploadOperationResponse

type RegistryDataVersionsCreateOrGetStartPendingUploadOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PendingUploadResponseDto
}

type RegistryDataVersionsCreateOrUpdateOperationResponse

type RegistryDataVersionsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataVersionBaseResource
}

type RegistryDataVersionsDeleteOperationResponse

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

type RegistryDataVersionsGetOperationResponse

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

type RegistryDataVersionsListCompleteResult

type RegistryDataVersionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataVersionBaseResource
}

type RegistryDataVersionsListOperationOptions

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

func DefaultRegistryDataVersionsListOperationOptions

func DefaultRegistryDataVersionsListOperationOptions() RegistryDataVersionsListOperationOptions

func (RegistryDataVersionsListOperationOptions) ToHeaders

func (RegistryDataVersionsListOperationOptions) ToOData

func (RegistryDataVersionsListOperationOptions) ToQuery

type RegistryDataVersionsListOperationResponse

type RegistryDataVersionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataVersionBaseResource
}

type SASCredentialDto

type SASCredentialDto struct {
	SasUri *string `json:"sasUri,omitempty"`
}

func (SASCredentialDto) MarshalJSON

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

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
	RegistryName      string
	DataName          string
	VersionName       string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID

func NewVersionID(subscriptionId string, resourceGroupName string, registryName 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) FromParseResult

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

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