libraries

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/libraries Documentation

The libraries SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-01/libraries"

Client Initialization

client := libraries.NewLibrariesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LibrariesClient.LibraryGet

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

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

Example Usage: LibrariesClient.ListByWorkspace

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

// alternatively `client.ListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.ListByWorkspaceComplete(ctx, id)
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 ValidateLibraryID 

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

ValidateLibraryID checks that 'input' can be parsed as a Library 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 LibrariesClient 

type LibrariesClient struct {
	Client *resourcemanager.Client
}

func NewLibrariesClientWithBaseURI 

func NewLibrariesClientWithBaseURI(sdkApi sdkEnv.Api) (*LibrariesClient, error)

func (LibrariesClient) LibraryGet 

func (c LibrariesClient) LibraryGet(ctx context.Context, id LibraryId) (result LibraryGetOperationResponse, err error)

LibraryGet ...

func (LibrariesClient) ListByWorkspace 

func (c LibrariesClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

func (LibrariesClient) ListByWorkspaceComplete 

func (c LibrariesClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)

ListByWorkspaceComplete retrieves all the results into a single object

func (LibrariesClient) ListByWorkspaceCompleteMatchingPredicate 

func (c LibrariesClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate LibraryResourceOperationPredicate) (result ListByWorkspaceCompleteResult, err error)

ListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LibraryGetOperationResponse 

type LibraryGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LibraryResource
}

type LibraryId 

type LibraryId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	LibraryName       string
}

LibraryId is a struct representing the Resource ID for a Library

func NewLibraryID 

func NewLibraryID(subscriptionId string, resourceGroupName string, workspaceName string, libraryName string) LibraryId

NewLibraryID returns a new LibraryId struct

func ParseLibraryID 

func ParseLibraryID(input string) (*LibraryId, error)

ParseLibraryID parses 'input' into a LibraryId

func ParseLibraryIDInsensitively 

func ParseLibraryIDInsensitively(input string) (*LibraryId, error)

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

func (*LibraryId) FromParseResult 

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

func (LibraryId) ID 

func (id LibraryId) ID() string

ID returns the formatted Library ID

func (LibraryId) Segments 

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

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

func (LibraryId) String 

func (id LibraryId) String() string

String returns a human-readable description of this Library ID

type LibraryInfo 

type LibraryInfo struct {
	ContainerName      *string `json:"containerName,omitempty"`
	CreatorId          *string `json:"creatorId,omitempty"`
	Name               *string `json:"name,omitempty"`
	Path               *string `json:"path,omitempty"`
	ProvisioningStatus *string `json:"provisioningStatus,omitempty"`
	Type               *string `json:"type,omitempty"`
	UploadedTimestamp  *string `json:"uploadedTimestamp,omitempty"`
}

func (*LibraryInfo) GetUploadedTimestampAsTime 

func (o *LibraryInfo) GetUploadedTimestampAsTime() (*time.Time, error)

func (*LibraryInfo) SetUploadedTimestampAsTime 

func (o *LibraryInfo) SetUploadedTimestampAsTime(input time.Time)

type LibraryResource 

type LibraryResource struct {
	Etag       *string     `json:"etag,omitempty"`
	Id         *string     `json:"id,omitempty"`
	Name       *string     `json:"name,omitempty"`
	Properties LibraryInfo `json:"properties"`
	Type       *string     `json:"type,omitempty"`
}

type LibraryResourceOperationPredicate 

type LibraryResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (LibraryResourceOperationPredicate) Matches 

func (p LibraryResourceOperationPredicate) Matches(input LibraryResource) bool

type ListByWorkspaceCompleteResult 

type ListByWorkspaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []LibraryResource
}

type ListByWorkspaceCustomPager added in v0.20240628.1153531 

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

type ListByWorkspaceOperationResponse 

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]LibraryResource
}

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 

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.