jobversions

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/jobversions Documentation

The jobversions SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-01-preview).

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/sql/2023-02-01-preview/jobversions"

Client Initialization

client := jobversions.NewJobVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobVersionsClient.Get

ctx := context.TODO()
id := jobversions.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "jobValue", "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: JobVersionsClient.ListByJob

ctx := context.TODO()
id := jobversions.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "jobValue")

// alternatively `client.ListByJob(ctx, id)` can be used to do batched pagination
items, err := client.ListByJobComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateJobID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateVersionID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type JobId
  • func NewJobID(subscriptionId string, resourceGroupName string, serverName string, ...) JobId
  • func ParseJobID(input string) (*JobId, error)
  • func ParseJobIDInsensitively(input string) (*JobId, error)
  • func (id *JobId) FromParseResult(input resourceids.ParseResult) error
  • func (id JobId) ID() string
  • func (id JobId) Segments() []resourceids.Segment
  • func (id JobId) String() string
• type JobVersionsClient
  • func NewJobVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*JobVersionsClient, error)
  • func (c JobVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)
  • func (c JobVersionsClient) ListByJob(ctx context.Context, id JobId) (result ListByJobOperationResponse, err error)
  • func (c JobVersionsClient) ListByJobComplete(ctx context.Context, id JobId) (ListByJobCompleteResult, error)
  • func (c JobVersionsClient) ListByJobCompleteMatchingPredicate(ctx context.Context, id JobId, predicate ResourceOperationPredicate) (result ListByJobCompleteResult, err error)
• type ListByJobCompleteResult
• type ListByJobOperationResponse
• type Resource
• type ResourceOperationPredicate
  • func (p ResourceOperationPredicate) Matches(input Resource) bool
• type VersionId
  • func NewVersionID(subscriptionId string, resourceGroupName string, serverName string, ...) VersionId
  • func ParseVersionID(input string) (*VersionId, error)
  • func ParseVersionIDInsensitively(input string) (*VersionId, error)
  • func (id *VersionId) FromParseResult(input resourceids.ParseResult) error
  • func (id VersionId) ID() string
  • func (id VersionId) Segments() []resourceids.Segment
  • func (id VersionId) String() string

Functions

func ValidateJobID

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

ValidateJobID checks that 'input' can be parsed as a Job 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 GetOperationResponse

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

type JobId

type JobId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	JobAgentName      string
	JobName           string
}

JobId is a struct representing the Resource ID for a Job

func NewJobID

func NewJobID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string, jobName string) JobId

NewJobID returns a new JobId struct

func ParseJobID

func ParseJobID(input string) (*JobId, error)

ParseJobID parses 'input' into a JobId

func ParseJobIDInsensitively

func ParseJobIDInsensitively(input string) (*JobId, error)

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

func (*JobId) FromParseResult

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

func (JobId) ID

func (id JobId) ID() string

ID returns the formatted Job ID

func (JobId) Segments

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

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

func (JobId) String

func (id JobId) String() string

String returns a human-readable description of this Job ID

type JobVersionsClient

type JobVersionsClient struct {
	Client *resourcemanager.Client
}

func NewJobVersionsClientWithBaseURI

func NewJobVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*JobVersionsClient, error)

func (JobVersionsClient) Get

func (c JobVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)

Get ...

func (JobVersionsClient) ListByJob

func (c JobVersionsClient) ListByJob(ctx context.Context, id JobId) (result ListByJobOperationResponse, err error)

ListByJob ...

func (JobVersionsClient) ListByJobComplete

func (c JobVersionsClient) ListByJobComplete(ctx context.Context, id JobId) (ListByJobCompleteResult, error)

ListByJobComplete retrieves all the results into a single object

func (JobVersionsClient) ListByJobCompleteMatchingPredicate

func (c JobVersionsClient) ListByJobCompleteMatchingPredicate(ctx context.Context, id JobId, predicate ResourceOperationPredicate) (result ListByJobCompleteResult, err error)

ListByJobCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByJobCompleteResult

type ListByJobCompleteResult struct {
	Items []Resource
}

type ListByJobOperationResponse

type ListByJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Resource
}

type Resource

type Resource struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ResourceOperationPredicate

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

func (ResourceOperationPredicate) Matches

func (p ResourceOperationPredicate) Matches(input Resource) bool

type VersionId

type VersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	JobAgentName      string
	JobName           string
	VersionName       string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID

func NewVersionID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string, jobName 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