datacontainer

package
v0.20231214.1160726 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2022-10-01/datacontainer Documentation

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

Client Initialization

client := datacontainer.NewDataContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataContainerClient.CreateOrUpdate

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

payload := datacontainer.DataContainerResource{
	// ...
}


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

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

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

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

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

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

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

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

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

Types

type CreateOrUpdateOperationResponse 

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

type DataContainer 

type DataContainer struct {
	DataType      DataType           `json:"dataType"`
	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 DataContainerClient 

type DataContainerClient struct {
	Client *resourcemanager.Client
}

func NewDataContainerClientWithBaseURI 

func NewDataContainerClientWithBaseURI(sdkApi sdkEnv.Api) (*DataContainerClient, error)

func (DataContainerClient) CreateOrUpdate 

func (c DataContainerClient) CreateOrUpdate(ctx context.Context, id DataId, input DataContainerResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DataContainerClient) Delete 

func (c DataContainerClient) Delete(ctx context.Context, id DataId) (result DeleteOperationResponse, err error)

Delete ...

func (DataContainerClient) Get 

func (c DataContainerClient) Get(ctx context.Context, id DataId) (result GetOperationResponse, err error)

Get ...

func (DataContainerClient) List 

func (c DataContainerClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (DataContainerClient) ListComplete 

func (c DataContainerClient) ListComplete(ctx context.Context, id WorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DataContainerClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DataContainerResource 

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

type DataContainerResourceOperationPredicate 

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

func (DataContainerResourceOperationPredicate) Matches 

func (p DataContainerResourceOperationPredicate) Matches(input DataContainerResource) bool

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) FromParseResult added in v0.20231127.1171502 

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

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []DataContainerResource
}

type ListOperationOptions 

type ListOperationOptions struct {
	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 

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

type ListOperationResponse 

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

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 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) FromParseResult added in v0.20231127.1171502 

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

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

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.