dataversionregistry

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2023-10-01/dataversionregistry Documentation

The dataversionregistry SDK allows for interaction with Azure Resource Manager machinelearningservices (API Version 2023-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-sdk/resource-manager/machinelearningservices/2023-10-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", "registryName", "name", "version")

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", "registryName", "name", "version")

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", "registryName", "name", "version")

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", "registryName", "name", "version")

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", "registryName", "name")

// 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 BaseDataVersionBaseImpl added in v0.20240920.1135249 

type BaseDataVersionBaseImpl struct {
	DataType    DataType           `json:"dataType"`
	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 (BaseDataVersionBaseImpl) DataVersionBase added in v0.20240920.1135249 

func (s BaseDataVersionBaseImpl) DataVersionBase() BaseDataVersionBaseImpl

type BasePendingUploadCredentialDtoImpl added in v0.20240920.1135249 

type BasePendingUploadCredentialDtoImpl struct {
	CredentialType PendingUploadCredentialType `json:"credentialType"`
}

func (BasePendingUploadCredentialDtoImpl) PendingUploadCredentialDto added in v0.20240920.1135249 

func (s BasePendingUploadCredentialDtoImpl) PendingUploadCredentialDto() BasePendingUploadCredentialDtoImpl

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 {
	DataVersionBase() BaseDataVersionBaseImpl
}

func UnmarshalDataVersionBaseImplementation added in v0.20240920.1135249 

func UnmarshalDataVersionBaseImplementation(input []byte) (DataVersionBase, error)

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 

func (p DataVersionBaseResourceOperationPredicate) Matches(input DataVersionBaseResource) bool

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 

func (c DataVersionRegistryClient) RegistryDataVersionsCreateOrUpdate(ctx context.Context, id VersionId, input DataVersionBaseResource) (result RegistryDataVersionsCreateOrUpdateOperationResponse, err error)

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 

func (c DataVersionRegistryClient) RegistryDataVersionsList(ctx context.Context, id DataId, options RegistryDataVersionsListOperationOptions) (result RegistryDataVersionsListOperationResponse, err error)

RegistryDataVersionsList ...

func (DataVersionRegistryClient) RegistryDataVersionsListComplete 

func (c DataVersionRegistryClient) RegistryDataVersionsListComplete(ctx context.Context, id DataId, options RegistryDataVersionsListOperationOptions) (RegistryDataVersionsListCompleteResult, error)

RegistryDataVersionsListComplete retrieves all the results into a single object

func (DataVersionRegistryClient) RegistryDataVersionsListCompleteMatchingPredicate 

func (c DataVersionRegistryClient) RegistryDataVersionsListCompleteMatchingPredicate(ctx context.Context, id DataId, options RegistryDataVersionsListOperationOptions, predicate DataVersionBaseResourceOperationPredicate) (result RegistryDataVersionsListCompleteResult, err error)

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"`

	DataType    DataType           `json:"dataType"`
	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) DataVersionBase added in v0.20240920.1135249 

func (s MLTableData) DataVersionBase() BaseDataVersionBaseImpl

func (MLTableData) MarshalJSON 

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

type PendingUploadCredentialDto 

type PendingUploadCredentialDto interface {
	PendingUploadCredentialDto() BasePendingUploadCredentialDtoImpl
}

func UnmarshalPendingUploadCredentialDtoImplementation added in v0.20240920.1135249 

func UnmarshalPendingUploadCredentialDtoImplementation(input []byte) (PendingUploadCredentialDto, error)

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{}
	// contains filtered or unexported fields
}

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).

func (RawDataVersionBaseImpl) DataVersionBase added in v0.20240920.1135249 

func (s RawDataVersionBaseImpl) DataVersionBase() BaseDataVersionBaseImpl

type RawPendingUploadCredentialDtoImpl 

type RawPendingUploadCredentialDtoImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

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).

func (RawPendingUploadCredentialDtoImpl) PendingUploadCredentialDto added in v0.20240920.1135249 

func (s RawPendingUploadCredentialDtoImpl) PendingUploadCredentialDto() BasePendingUploadCredentialDtoImpl

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 RegistryDataVersionsListCustomPager added in v0.20240628.1153531 

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

type RegistryDataVersionsListOperationOptions 

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

func DefaultRegistryDataVersionsListOperationOptions 

func DefaultRegistryDataVersionsListOperationOptions() RegistryDataVersionsListOperationOptions

func (RegistryDataVersionsListOperationOptions) ToHeaders 

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

func (RegistryDataVersionsListOperationOptions) ToOData 

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

func (RegistryDataVersionsListOperationOptions) ToQuery 

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

type RegistryDataVersionsListOperationResponse 

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

type SASCredentialDto 

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

	CredentialType PendingUploadCredentialType `json:"credentialType"`
}

func (SASCredentialDto) MarshalJSON 

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

func (SASCredentialDto) PendingUploadCredentialDto added in v0.20240920.1135249 

func (s SASCredentialDto) PendingUploadCredentialDto() BasePendingUploadCredentialDtoImpl

type UriFileDataVersion 

type UriFileDataVersion struct {
	DataType    DataType           `json:"dataType"`
	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) DataVersionBase added in v0.20240920.1135249 

func (s UriFileDataVersion) DataVersionBase() BaseDataVersionBaseImpl

func (UriFileDataVersion) MarshalJSON 

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

type UriFolderDataVersion 

type UriFolderDataVersion struct {
	DataType    DataType           `json:"dataType"`
	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) DataVersionBase added in v0.20240920.1135249 

func (s UriFolderDataVersion) DataVersionBase() BaseDataVersionBaseImpl

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

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.