bandwidthschedules

package
v0.20240221.1115631 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-12-01/bandwidthschedules Documentation

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

Client Initialization

client := bandwidthschedules.NewBandwidthSchedulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BandwidthSchedulesClient.CreateOrUpdate

ctx := context.TODO()
id := bandwidthschedules.NewBandwidthScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "bandwidthScheduleValue")

payload := bandwidthschedules.BandwidthSchedule{
	// ...
}


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

Example Usage: BandwidthSchedulesClient.Delete

ctx := context.TODO()
id := bandwidthschedules.NewBandwidthScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "bandwidthScheduleValue")

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

Example Usage: BandwidthSchedulesClient.Get

ctx := context.TODO()
id := bandwidthschedules.NewBandwidthScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "bandwidthScheduleValue")

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: BandwidthSchedulesClient.ListByDataBoxEdgeDevice

ctx := context.TODO()
id := bandwidthschedules.NewDataBoxEdgeDeviceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue")

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

func PossibleValuesForDayOfWeek() []string

func ValidateBandwidthScheduleID 

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

ValidateBandwidthScheduleID checks that 'input' can be parsed as a Bandwidth Schedule ID

func ValidateDataBoxEdgeDeviceID 

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

ValidateDataBoxEdgeDeviceID checks that 'input' can be parsed as a Data Box Edge Device ID

Types

type BandwidthSchedule 

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

type BandwidthScheduleId 

type BandwidthScheduleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
	BandwidthScheduleName string
}

BandwidthScheduleId is a struct representing the Resource ID for a Bandwidth Schedule

func NewBandwidthScheduleID 

func NewBandwidthScheduleID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string, bandwidthScheduleName string) BandwidthScheduleId

NewBandwidthScheduleID returns a new BandwidthScheduleId struct

func ParseBandwidthScheduleID 

func ParseBandwidthScheduleID(input string) (*BandwidthScheduleId, error)

ParseBandwidthScheduleID parses 'input' into a BandwidthScheduleId

func ParseBandwidthScheduleIDInsensitively 

func ParseBandwidthScheduleIDInsensitively(input string) (*BandwidthScheduleId, error)

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

func (*BandwidthScheduleId) FromParseResult 

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

func (BandwidthScheduleId) ID 

func (id BandwidthScheduleId) ID() string

ID returns the formatted Bandwidth Schedule ID

func (BandwidthScheduleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Bandwidth Schedule ID

func (BandwidthScheduleId) String 

func (id BandwidthScheduleId) String() string

String returns a human-readable description of this Bandwidth Schedule ID

type BandwidthScheduleOperationPredicate 

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

func (BandwidthScheduleOperationPredicate) Matches 

func (p BandwidthScheduleOperationPredicate) Matches(input BandwidthSchedule) bool

type BandwidthScheduleProperties 

type BandwidthScheduleProperties struct {
	Days       []DayOfWeek `json:"days"`
	RateInMbps int64       `json:"rateInMbps"`
	Start      string      `json:"start"`
	Stop       string      `json:"stop"`
}

type BandwidthSchedulesClient 

type BandwidthSchedulesClient struct {
	Client *resourcemanager.Client
}

func NewBandwidthSchedulesClientWithBaseURI 

func NewBandwidthSchedulesClientWithBaseURI(sdkApi sdkEnv.Api) (*BandwidthSchedulesClient, error)

func (BandwidthSchedulesClient) CreateOrUpdate 

func (c BandwidthSchedulesClient) CreateOrUpdate(ctx context.Context, id BandwidthScheduleId, input BandwidthSchedule) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (BandwidthSchedulesClient) CreateOrUpdateThenPoll 

func (c BandwidthSchedulesClient) CreateOrUpdateThenPoll(ctx context.Context, id BandwidthScheduleId, input BandwidthSchedule) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BandwidthSchedulesClient) Delete 

func (c BandwidthSchedulesClient) Delete(ctx context.Context, id BandwidthScheduleId) (result DeleteOperationResponse, err error)

Delete ...

func (BandwidthSchedulesClient) DeleteThenPoll 

func (c BandwidthSchedulesClient) DeleteThenPoll(ctx context.Context, id BandwidthScheduleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (BandwidthSchedulesClient) Get 

func (c BandwidthSchedulesClient) Get(ctx context.Context, id BandwidthScheduleId) (result GetOperationResponse, err error)

Get ...

func (BandwidthSchedulesClient) ListByDataBoxEdgeDevice 

func (c BandwidthSchedulesClient) ListByDataBoxEdgeDevice(ctx context.Context, id DataBoxEdgeDeviceId) (result ListByDataBoxEdgeDeviceOperationResponse, err error)

ListByDataBoxEdgeDevice ...

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceComplete 

func (c BandwidthSchedulesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, id DataBoxEdgeDeviceId) (ListByDataBoxEdgeDeviceCompleteResult, error)

ListByDataBoxEdgeDeviceComplete retrieves all the results into a single object

func (BandwidthSchedulesClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate 

func (c BandwidthSchedulesClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate(ctx context.Context, id DataBoxEdgeDeviceId, predicate BandwidthScheduleOperationPredicate) (result ListByDataBoxEdgeDeviceCompleteResult, err error)

ListByDataBoxEdgeDeviceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BandwidthSchedule
}

type DataBoxEdgeDeviceId 

type DataBoxEdgeDeviceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
}

DataBoxEdgeDeviceId is a struct representing the Resource ID for a Data Box Edge Device

func NewDataBoxEdgeDeviceID 

func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId

NewDataBoxEdgeDeviceID returns a new DataBoxEdgeDeviceId struct

func ParseDataBoxEdgeDeviceID 

func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)

ParseDataBoxEdgeDeviceID parses 'input' into a DataBoxEdgeDeviceId

func ParseDataBoxEdgeDeviceIDInsensitively 

func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)

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

func (*DataBoxEdgeDeviceId) FromParseResult 

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

func (DataBoxEdgeDeviceId) ID 

func (id DataBoxEdgeDeviceId) ID() string

ID returns the formatted Data Box Edge Device ID

func (DataBoxEdgeDeviceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Box Edge Device ID

func (DataBoxEdgeDeviceId) String 

func (id DataBoxEdgeDeviceId) String() string

String returns a human-readable description of this Data Box Edge Device ID

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func (*DayOfWeek) UnmarshalJSON 

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

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        *BandwidthSchedule
}

type ListByDataBoxEdgeDeviceCompleteResult 

type ListByDataBoxEdgeDeviceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BandwidthSchedule
}

type ListByDataBoxEdgeDeviceOperationResponse 

type ListByDataBoxEdgeDeviceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BandwidthSchedule
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.