groundstation

package
v0.20221213.1164123 Latest Latest
Warning

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

Go to latest
Published: Dec 13, 2022 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/orbital/2022-03-01/groundstation Documentation

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

Client Initialization

client := groundstation.NewGroundStationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GroundStationClient.AvailableGroundStationsGet

ctx := context.TODO()
id := groundstation.NewAvailableGroundStationID("12345678-1234-9876-4563-123456789012", "groundStationValue")

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

Example Usage: GroundStationClient.AvailableGroundStationsListByCapability

ctx := context.TODO()
id := groundstation.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.AvailableGroundStationsListByCapability(ctx, id, groundstation.DefaultAvailableGroundStationsListByCapabilityOperationOptions())` can be used to do batched pagination
items, err := client.AvailableGroundStationsListByCapabilityComplete(ctx, id, groundstation.DefaultAvailableGroundStationsListByCapabilityOperationOptions())
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 PossibleValuesForCapabilityParameter

func PossibleValuesForCapabilityParameter() []string

func PossibleValuesForReleaseMode

func PossibleValuesForReleaseMode() []string

func ValidateAvailableGroundStationID

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

ValidateAvailableGroundStationID checks that 'input' can be parsed as a Available Ground Station ID

Types

type AvailableGroundStation

type AvailableGroundStation struct {
	Id         *string                           `json:"id,omitempty"`
	Location   *string                           `json:"location,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *AvailableGroundStationProperties `json:"properties,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type AvailableGroundStationId

type AvailableGroundStationId struct {
	SubscriptionId    string
	GroundStationName string
}

AvailableGroundStationId is a struct representing the Resource ID for a Available Ground Station

func NewAvailableGroundStationID

func NewAvailableGroundStationID(subscriptionId string, groundStationName string) AvailableGroundStationId

NewAvailableGroundStationID returns a new AvailableGroundStationId struct

func ParseAvailableGroundStationID

func ParseAvailableGroundStationID(input string) (*AvailableGroundStationId, error)

ParseAvailableGroundStationID parses 'input' into a AvailableGroundStationId

func ParseAvailableGroundStationIDInsensitively

func ParseAvailableGroundStationIDInsensitively(input string) (*AvailableGroundStationId, error)

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

func (AvailableGroundStationId) ID

ID returns the formatted Available Ground Station ID

func (AvailableGroundStationId) Segments

Segments returns a slice of Resource ID Segments which comprise this Available Ground Station ID

func (AvailableGroundStationId) String

func (id AvailableGroundStationId) String() string

String returns a human-readable description of this Available Ground Station ID

type AvailableGroundStationOperationPredicate

type AvailableGroundStationOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AvailableGroundStationOperationPredicate) Matches

type AvailableGroundStationProperties

type AvailableGroundStationProperties struct {
	AltitudeMeters   *float64     `json:"altitudeMeters,omitempty"`
	City             *string      `json:"city,omitempty"`
	LatitudeDegrees  *float64     `json:"latitudeDegrees,omitempty"`
	LongitudeDegrees *float64     `json:"longitudeDegrees,omitempty"`
	ProviderName     *string      `json:"providerName,omitempty"`
	ReleaseMode      *ReleaseMode `json:"releaseMode,omitempty"`
}

type AvailableGroundStationsGetOperationResponse

type AvailableGroundStationsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *AvailableGroundStation
}

type AvailableGroundStationsListByCapabilityCompleteResult

type AvailableGroundStationsListByCapabilityCompleteResult struct {
	Items []AvailableGroundStation
}

type AvailableGroundStationsListByCapabilityOperationOptions

type AvailableGroundStationsListByCapabilityOperationOptions struct {
	Capability *CapabilityParameter
}

type AvailableGroundStationsListByCapabilityOperationResponse

type AvailableGroundStationsListByCapabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]AvailableGroundStation
	// contains filtered or unexported fields
}

func (AvailableGroundStationsListByCapabilityOperationResponse) HasMore

func (AvailableGroundStationsListByCapabilityOperationResponse) LoadMore

type CapabilityParameter

type CapabilityParameter string
const (
	CapabilityParameterCommunication    CapabilityParameter = "Communication"
	CapabilityParameterEarthObservation CapabilityParameter = "EarthObservation"
)

type GroundStationClient

type GroundStationClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewGroundStationClientWithBaseURI

func NewGroundStationClientWithBaseURI(endpoint string) GroundStationClient

func (GroundStationClient) AvailableGroundStationsGet

AvailableGroundStationsGet ...

func (GroundStationClient) AvailableGroundStationsListByCapability

AvailableGroundStationsListByCapability ...

func (GroundStationClient) AvailableGroundStationsListByCapabilityComplete

AvailableGroundStationsListByCapabilityComplete retrieves all of the results into a single object

func (GroundStationClient) AvailableGroundStationsListByCapabilityCompleteMatchingPredicate

AvailableGroundStationsListByCapabilityCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ReleaseMode

type ReleaseMode string
const (
	ReleaseModeGA      ReleaseMode = "GA"
	ReleaseModePreview ReleaseMode = "Preview"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL