contact

package
v0.20240318.1145438 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/orbital/2022-11-01/contact Documentation

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

Client Initialization

client := contact.NewContactClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContactClient.Create

ctx := context.TODO()
id := contact.NewContactID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spacecraftValue", "contactValue")

payload := contact.Contact{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ContactClient.Delete

ctx := context.TODO()
id := contact.NewContactID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spacecraftValue", "contactValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ContactClient.Get

ctx := context.TODO()
id := contact.NewContactID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spacecraftValue", "contactValue")

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: ContactClient.List

ctx := context.TODO()
id := contact.NewSpacecraftID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spacecraftValue")

// 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
}

Example Usage: ContactClient.SpacecraftsListAvailableContacts

ctx := context.TODO()
id := contact.NewSpacecraftID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spacecraftValue")

payload := contact.ContactParameters{
	// ...
}


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

func PossibleValuesForContactsStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateContactID

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

ValidateContactID checks that 'input' can be parsed as a Contact ID

func ValidateSpacecraftID

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

ValidateSpacecraftID checks that 'input' can be parsed as a Spacecraft ID

Types

type AvailableContacts

type AvailableContacts struct {
	GroundStationName *string                    `json:"groundStationName,omitempty"`
	Properties        *ContactInstanceProperties `json:"properties,omitempty"`
	Spacecraft        *ResourceReference         `json:"spacecraft,omitempty"`
}

type AvailableContactsOperationPredicate

type AvailableContactsOperationPredicate struct {
	GroundStationName *string
}

func (AvailableContactsOperationPredicate) Matches

type Contact

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

type ContactClient

type ContactClient struct {
	Client *resourcemanager.Client
}

func NewContactClientWithBaseURI

func NewContactClientWithBaseURI(sdkApi sdkEnv.Api) (*ContactClient, error)

func (ContactClient) Create

func (c ContactClient) Create(ctx context.Context, id ContactId, input Contact) (result CreateOperationResponse, err error)

Create ...

func (ContactClient) CreateThenPoll

func (c ContactClient) CreateThenPoll(ctx context.Context, id ContactId, input Contact) error

CreateThenPoll performs Create then polls until it's completed

func (ContactClient) Delete

func (c ContactClient) Delete(ctx context.Context, id ContactId) (result DeleteOperationResponse, err error)

Delete ...

func (ContactClient) DeleteThenPoll

func (c ContactClient) DeleteThenPoll(ctx context.Context, id ContactId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContactClient) Get

func (c ContactClient) Get(ctx context.Context, id ContactId) (result GetOperationResponse, err error)

Get ...

func (ContactClient) List

func (c ContactClient) List(ctx context.Context, id SpacecraftId) (result ListOperationResponse, err error)

List ...

func (ContactClient) ListComplete

ListComplete retrieves all the results into a single object

func (ContactClient) ListCompleteMatchingPredicate

func (c ContactClient) ListCompleteMatchingPredicate(ctx context.Context, id SpacecraftId, predicate ContactOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContactClient) SpacecraftsListAvailableContacts

func (c ContactClient) SpacecraftsListAvailableContacts(ctx context.Context, id SpacecraftId, input ContactParameters) (result SpacecraftsListAvailableContactsOperationResponse, err error)

SpacecraftsListAvailableContacts ...

func (ContactClient) SpacecraftsListAvailableContactsThenPoll

func (c ContactClient) SpacecraftsListAvailableContactsThenPoll(ctx context.Context, id SpacecraftId, input ContactParameters) error

SpacecraftsListAvailableContactsThenPoll performs SpacecraftsListAvailableContacts then polls until it's completed

type ContactId

type ContactId struct {
	SubscriptionId    string
	ResourceGroupName string
	SpacecraftName    string
	ContactName       string
}

ContactId is a struct representing the Resource ID for a Contact

func NewContactID

func NewContactID(subscriptionId string, resourceGroupName string, spacecraftName string, contactName string) ContactId

NewContactID returns a new ContactId struct

func ParseContactID

func ParseContactID(input string) (*ContactId, error)

ParseContactID parses 'input' into a ContactId

func ParseContactIDInsensitively

func ParseContactIDInsensitively(input string) (*ContactId, error)

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

func (*ContactId) FromParseResult

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

func (ContactId) ID

func (id ContactId) ID() string

ID returns the formatted Contact ID

func (ContactId) Segments

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

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

func (ContactId) String

func (id ContactId) String() string

String returns a human-readable description of this Contact ID

type ContactInstanceProperties

type ContactInstanceProperties struct {
	EndAzimuthDegrees       *float64 `json:"endAzimuthDegrees,omitempty"`
	EndElevationDegrees     *float64 `json:"endElevationDegrees,omitempty"`
	MaximumElevationDegrees *float64 `json:"maximumElevationDegrees,omitempty"`
	RxEndTime               *string  `json:"rxEndTime,omitempty"`
	RxStartTime             *string  `json:"rxStartTime,omitempty"`
	StartAzimuthDegrees     *float64 `json:"startAzimuthDegrees,omitempty"`
	StartElevationDegrees   *float64 `json:"startElevationDegrees,omitempty"`
	TxEndTime               *string  `json:"txEndTime,omitempty"`
	TxStartTime             *string  `json:"txStartTime,omitempty"`
}

func (*ContactInstanceProperties) GetRxEndTimeAsTime

func (o *ContactInstanceProperties) GetRxEndTimeAsTime() (*time.Time, error)

func (*ContactInstanceProperties) GetRxStartTimeAsTime

func (o *ContactInstanceProperties) GetRxStartTimeAsTime() (*time.Time, error)

func (*ContactInstanceProperties) GetTxEndTimeAsTime

func (o *ContactInstanceProperties) GetTxEndTimeAsTime() (*time.Time, error)

func (*ContactInstanceProperties) GetTxStartTimeAsTime

func (o *ContactInstanceProperties) GetTxStartTimeAsTime() (*time.Time, error)

func (*ContactInstanceProperties) SetRxEndTimeAsTime

func (o *ContactInstanceProperties) SetRxEndTimeAsTime(input time.Time)

func (*ContactInstanceProperties) SetRxStartTimeAsTime

func (o *ContactInstanceProperties) SetRxStartTimeAsTime(input time.Time)

func (*ContactInstanceProperties) SetTxEndTimeAsTime

func (o *ContactInstanceProperties) SetTxEndTimeAsTime(input time.Time)

func (*ContactInstanceProperties) SetTxStartTimeAsTime

func (o *ContactInstanceProperties) SetTxStartTimeAsTime(input time.Time)

type ContactOperationPredicate

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

func (ContactOperationPredicate) Matches

func (p ContactOperationPredicate) Matches(input Contact) bool

type ContactParameters

type ContactParameters struct {
	ContactProfile    ResourceReference `json:"contactProfile"`
	EndTime           string            `json:"endTime"`
	GroundStationName string            `json:"groundStationName"`
	StartTime         string            `json:"startTime"`
}

func (*ContactParameters) GetEndTimeAsTime

func (o *ContactParameters) GetEndTimeAsTime() (*time.Time, error)

func (*ContactParameters) GetStartTimeAsTime

func (o *ContactParameters) GetStartTimeAsTime() (*time.Time, error)

func (*ContactParameters) SetEndTimeAsTime

func (o *ContactParameters) SetEndTimeAsTime(input time.Time)

func (*ContactParameters) SetStartTimeAsTime

func (o *ContactParameters) SetStartTimeAsTime(input time.Time)

type ContactsProperties

type ContactsProperties struct {
	AntennaConfiguration    *ContactsPropertiesAntennaConfiguration `json:"antennaConfiguration,omitempty"`
	ContactProfile          ResourceReference                       `json:"contactProfile"`
	EndAzimuthDegrees       *float64                                `json:"endAzimuthDegrees,omitempty"`
	EndElevationDegrees     *float64                                `json:"endElevationDegrees,omitempty"`
	ErrorMessage            *string                                 `json:"errorMessage,omitempty"`
	GroundStationName       string                                  `json:"groundStationName"`
	MaximumElevationDegrees *float64                                `json:"maximumElevationDegrees,omitempty"`
	ProvisioningState       *ProvisioningState                      `json:"provisioningState,omitempty"`
	ReservationEndTime      string                                  `json:"reservationEndTime"`
	ReservationStartTime    string                                  `json:"reservationStartTime"`
	RxEndTime               *string                                 `json:"rxEndTime,omitempty"`
	RxStartTime             *string                                 `json:"rxStartTime,omitempty"`
	StartAzimuthDegrees     *float64                                `json:"startAzimuthDegrees,omitempty"`
	StartElevationDegrees   *float64                                `json:"startElevationDegrees,omitempty"`
	Status                  *ContactsStatus                         `json:"status,omitempty"`
	TxEndTime               *string                                 `json:"txEndTime,omitempty"`
	TxStartTime             *string                                 `json:"txStartTime,omitempty"`
}

func (*ContactsProperties) GetReservationEndTimeAsTime

func (o *ContactsProperties) GetReservationEndTimeAsTime() (*time.Time, error)

func (*ContactsProperties) GetReservationStartTimeAsTime

func (o *ContactsProperties) GetReservationStartTimeAsTime() (*time.Time, error)

func (*ContactsProperties) GetRxEndTimeAsTime

func (o *ContactsProperties) GetRxEndTimeAsTime() (*time.Time, error)

func (*ContactsProperties) GetRxStartTimeAsTime

func (o *ContactsProperties) GetRxStartTimeAsTime() (*time.Time, error)

func (*ContactsProperties) GetTxEndTimeAsTime

func (o *ContactsProperties) GetTxEndTimeAsTime() (*time.Time, error)

func (*ContactsProperties) GetTxStartTimeAsTime

func (o *ContactsProperties) GetTxStartTimeAsTime() (*time.Time, error)

func (*ContactsProperties) SetReservationEndTimeAsTime

func (o *ContactsProperties) SetReservationEndTimeAsTime(input time.Time)

func (*ContactsProperties) SetReservationStartTimeAsTime

func (o *ContactsProperties) SetReservationStartTimeAsTime(input time.Time)

func (*ContactsProperties) SetRxEndTimeAsTime

func (o *ContactsProperties) SetRxEndTimeAsTime(input time.Time)

func (*ContactsProperties) SetRxStartTimeAsTime

func (o *ContactsProperties) SetRxStartTimeAsTime(input time.Time)

func (*ContactsProperties) SetTxEndTimeAsTime

func (o *ContactsProperties) SetTxEndTimeAsTime(input time.Time)

func (*ContactsProperties) SetTxStartTimeAsTime

func (o *ContactsProperties) SetTxStartTimeAsTime(input time.Time)

type ContactsPropertiesAntennaConfiguration

type ContactsPropertiesAntennaConfiguration struct {
	DestinationIP *string   `json:"destinationIp,omitempty"`
	SourceIPs     *[]string `json:"sourceIps,omitempty"`
}

type ContactsStatus

type ContactsStatus string
const (
	ContactsStatusCancelled         ContactsStatus = "cancelled"
	ContactsStatusFailed            ContactsStatus = "failed"
	ContactsStatusProviderCancelled ContactsStatus = "providerCancelled"
	ContactsStatusScheduled         ContactsStatus = "scheduled"
	ContactsStatusSucceeded         ContactsStatus = "succeeded"
)

func (*ContactsStatus) UnmarshalJSON

func (s *ContactsStatus) UnmarshalJSON(bytes []byte) error

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Contact
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Contact
}

type ListOperationResponse

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

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "canceled"
	ProvisioningStateCreating  ProvisioningState = "creating"
	ProvisioningStateDeleting  ProvisioningState = "deleting"
	ProvisioningStateFailed    ProvisioningState = "failed"
	ProvisioningStateSucceeded ProvisioningState = "succeeded"
	ProvisioningStateUpdating  ProvisioningState = "updating"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type ResourceReference

type ResourceReference struct {
	Id string `json:"id"`
}

type SpacecraftId

type SpacecraftId struct {
	SubscriptionId    string
	ResourceGroupName string
	SpacecraftName    string
}

SpacecraftId is a struct representing the Resource ID for a Spacecraft

func NewSpacecraftID

func NewSpacecraftID(subscriptionId string, resourceGroupName string, spacecraftName string) SpacecraftId

NewSpacecraftID returns a new SpacecraftId struct

func ParseSpacecraftID

func ParseSpacecraftID(input string) (*SpacecraftId, error)

ParseSpacecraftID parses 'input' into a SpacecraftId

func ParseSpacecraftIDInsensitively

func ParseSpacecraftIDInsensitively(input string) (*SpacecraftId, error)

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

func (*SpacecraftId) FromParseResult

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

func (SpacecraftId) ID

func (id SpacecraftId) ID() string

ID returns the formatted Spacecraft ID

func (SpacecraftId) Segments

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

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

func (SpacecraftId) String

func (id SpacecraftId) String() string

String returns a human-readable description of this Spacecraft ID

type SpacecraftsListAvailableContactsCompleteResult

type SpacecraftsListAvailableContactsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailableContacts
}

type SpacecraftsListAvailableContactsOperationResponse

type SpacecraftsListAvailableContactsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailableContacts
}

Jump to

Keyboard shortcuts

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