openshiftversions

README

github.com/hashicorp/go-azure-sdk/resource-manager/redhatopenshift/2023-04-01/openshiftversions Documentation

The openshiftversions SDK allows for interaction with the Azure Resource Manager Service redhatopenshift (API Version 2023-04-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/redhatopenshift/2023-04-01/openshiftversions"

Client Initialization

client := openshiftversions.NewOpenShiftVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OpenShiftVersionsClient.List

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

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ListCompleteResult
• type ListOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type OpenShiftVersion
• type OpenShiftVersionOperationPredicate
  • func (p OpenShiftVersionOperationPredicate) Matches(input OpenShiftVersion) bool
• type OpenShiftVersionProperties
• type OpenShiftVersionsClient
  • func NewOpenShiftVersionsClientWithBaseURI(api environments.Api) (*OpenShiftVersionsClient, error)
  • func (c OpenShiftVersionsClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)
  • func (c OpenShiftVersionsClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)
  • func (c OpenShiftVersionsClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, ...) (result ListCompleteResult, err error)

Functions

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 ListCompleteResult

type ListCompleteResult struct {
	Items []OpenShiftVersion
}

type ListOperationResponse

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

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

type OpenShiftVersion

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

type OpenShiftVersionOperationPredicate

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

func (OpenShiftVersionOperationPredicate) Matches

func (p OpenShiftVersionOperationPredicate) Matches(input OpenShiftVersion) bool

type OpenShiftVersionProperties

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

type OpenShiftVersionsClient

type OpenShiftVersionsClient struct {
	Client *resourcemanager.Client
}

func NewOpenShiftVersionsClientWithBaseURI

func NewOpenShiftVersionsClientWithBaseURI(api environments.Api) (*OpenShiftVersionsClient, error)

func (OpenShiftVersionsClient) List

func (c OpenShiftVersionsClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)

List ...

func (OpenShiftVersionsClient) ListComplete

func (c OpenShiftVersionsClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (OpenShiftVersionsClient) ListCompleteMatchingPredicate

func (c OpenShiftVersionsClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate OpenShiftVersionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate