giversions

README

github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/giversions Documentation

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

Client Initialization

client := giversions.NewGiVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GiVersionsClient.Get

ctx := context.TODO()
id := giversions.NewGiVersionID("12345678-1234-9876-4563-123456789012", "locationValue", "giVersionValue")

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: GiVersionsClient.ListByLocation

ctx := context.TODO()
id := giversions.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Documentation

Index

• func ValidateGiVersionID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type GiVersion
• type GiVersionId
  • func NewGiVersionID(subscriptionId string, locationName string, giVersionName string) GiVersionId
  • func ParseGiVersionID(input string) (*GiVersionId, error)
  • func ParseGiVersionIDInsensitively(input string) (*GiVersionId, error)
  • func (id *GiVersionId) FromParseResult(input resourceids.ParseResult) error
  • func (id GiVersionId) ID() string
  • func (id GiVersionId) Segments() []resourceids.Segment
  • func (id GiVersionId) String() string
• type GiVersionOperationPredicate
  • func (p GiVersionOperationPredicate) Matches(input GiVersion) bool
• type GiVersionProperties
• type GiVersionsClient
  • func NewGiVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*GiVersionsClient, error)
  • func (c GiVersionsClient) Get(ctx context.Context, id GiVersionId) (result GetOperationResponse, err error)
  • func (c GiVersionsClient) ListByLocation(ctx context.Context, id LocationId) (result ListByLocationOperationResponse, err error)
  • func (c GiVersionsClient) ListByLocationComplete(ctx context.Context, id LocationId) (ListByLocationCompleteResult, error)
  • func (c GiVersionsClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate GiVersionOperationPredicate) (result ListByLocationCompleteResult, err error)
• type ListByLocationCompleteResult
• type ListByLocationCustomPager
  • func (p *ListByLocationCustomPager) NextPageLink() *odata.Link
• type ListByLocationOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string

Functions

func ValidateGiVersionID

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

ValidateGiVersionID checks that 'input' can be parsed as a Gi Version ID

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type GetOperationResponse

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

type GiVersion

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

type GiVersionId

type GiVersionId struct {
	SubscriptionId string
	LocationName   string
	GiVersionName  string
}

GiVersionId is a struct representing the Resource ID for a Gi Version

func NewGiVersionID

func NewGiVersionID(subscriptionId string, locationName string, giVersionName string) GiVersionId

NewGiVersionID returns a new GiVersionId struct

func ParseGiVersionID

func ParseGiVersionID(input string) (*GiVersionId, error)

ParseGiVersionID parses 'input' into a GiVersionId

func ParseGiVersionIDInsensitively

func ParseGiVersionIDInsensitively(input string) (*GiVersionId, error)

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

func (*GiVersionId) FromParseResult

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

func (GiVersionId) ID

func (id GiVersionId) ID() string

ID returns the formatted Gi Version ID

func (GiVersionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Gi Version ID

func (GiVersionId) String

func (id GiVersionId) String() string

String returns a human-readable description of this Gi Version ID

type GiVersionOperationPredicate

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

func (GiVersionOperationPredicate) Matches

func (p GiVersionOperationPredicate) Matches(input GiVersion) bool

type GiVersionProperties

type GiVersionProperties struct {
	Version *string `json:"version,omitempty"`
}

type GiVersionsClient

type GiVersionsClient struct {
	Client *resourcemanager.Client
}

func NewGiVersionsClientWithBaseURI

func NewGiVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*GiVersionsClient, error)

func (GiVersionsClient) Get

func (c GiVersionsClient) Get(ctx context.Context, id GiVersionId) (result GetOperationResponse, err error)

Get ...

func (GiVersionsClient) ListByLocation

func (c GiVersionsClient) ListByLocation(ctx context.Context, id LocationId) (result ListByLocationOperationResponse, err error)

ListByLocation ...

func (GiVersionsClient) ListByLocationComplete

func (c GiVersionsClient) ListByLocationComplete(ctx context.Context, id LocationId) (ListByLocationCompleteResult, error)

ListByLocationComplete retrieves all the results into a single object

func (GiVersionsClient) ListByLocationCompleteMatchingPredicate

func (c GiVersionsClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate GiVersionOperationPredicate) (result ListByLocationCompleteResult, err error)

ListByLocationCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByLocationCompleteResult

type ListByLocationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GiVersion
}

type ListByLocationCustomPager

type ListByLocationCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByLocationCustomPager) NextPageLink

func (p *ListByLocationCustomPager) NextPageLink() *odata.Link

type ListByLocationOperationResponse

type ListByLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GiVersion
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID