liveoutputs

package
v0.20230615.1121338 Latest Latest
Warning

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

 Go to latest Published: Jun 15, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/media/2022-08-01/liveoutputs Documentation

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

Client Initialization

client := liveoutputs.NewLiveOutputsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LiveOutputsClient.AsyncOperation

ctx := context.TODO()
id := liveoutputs.NewLiveOutputOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "operationIdValue")

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

Example Usage: LiveOutputsClient.Create

ctx := context.TODO()
id := liveoutputs.NewLiveOutputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "liveEventValue", "liveOutputValue")

payload := liveoutputs.LiveOutput{
	// ...
}


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

Example Usage: LiveOutputsClient.Delete

ctx := context.TODO()
id := liveoutputs.NewLiveOutputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "liveEventValue", "liveOutputValue")

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

Example Usage: LiveOutputsClient.Get

ctx := context.TODO()
id := liveoutputs.NewLiveOutputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "liveEventValue", "liveOutputValue")

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

ctx := context.TODO()
id := liveoutputs.NewLiveEventID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "liveEventValue")

// 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: LiveOutputsClient.OperationLocation

ctx := context.TODO()
id := liveoutputs.NewLiveOutputOperationLocationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mediaServiceValue", "liveEventValue", "liveOutputValue", "operationIdValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAsyncOperationStatus 

func PossibleValuesForAsyncOperationStatus() []string

func PossibleValuesForLiveOutputResourceState 

func PossibleValuesForLiveOutputResourceState() []string

func ValidateLiveEventID 

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

ValidateLiveEventID checks that 'input' can be parsed as a Live Event ID

func ValidateLiveOutputID 

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

ValidateLiveOutputID checks that 'input' can be parsed as a Live Output ID

func ValidateLiveOutputOperationID 

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

ValidateLiveOutputOperationID checks that 'input' can be parsed as a Live Output Operation ID

func ValidateLiveOutputOperationLocationID 

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

ValidateLiveOutputOperationLocationID checks that 'input' can be parsed as a Live Output Operation Location ID

Types

type AsyncOperationOperationResponse 

type AsyncOperationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationResult
}

type AsyncOperationResult 

type AsyncOperationResult struct {
	Error  *ErrorDetail          `json:"error,omitempty"`
	Name   *string               `json:"name,omitempty"`
	Status *AsyncOperationStatus `json:"status,omitempty"`
}

type AsyncOperationStatus 

type AsyncOperationStatus string
const (
	AsyncOperationStatusFailed     AsyncOperationStatus = "Failed"
	AsyncOperationStatusInProgress AsyncOperationStatus = "InProgress"
	AsyncOperationStatusSucceeded  AsyncOperationStatus = "Succeeded"
)

func (*AsyncOperationStatus) UnmarshalJSON added in v0.20230406.1124617 

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

type CreateOperationResponse 

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

type DeleteOperationResponse 

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

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail 

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type GetOperationResponse 

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

type Hls 

type Hls struct {
	FragmentsPerTsSegment *int64 `json:"fragmentsPerTsSegment,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []LiveOutput
}

type ListOperationResponse 

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

type LiveEventId 

type LiveEventId struct {
	SubscriptionId    string
	ResourceGroupName string
	MediaServiceName  string
	LiveEventName     string
}

LiveEventId is a struct representing the Resource ID for a Live Event

func NewLiveEventID 

func NewLiveEventID(subscriptionId string, resourceGroupName string, mediaServiceName string, liveEventName string) LiveEventId

NewLiveEventID returns a new LiveEventId struct

func ParseLiveEventID 

func ParseLiveEventID(input string) (*LiveEventId, error)

ParseLiveEventID parses 'input' into a LiveEventId

func ParseLiveEventIDInsensitively 

func ParseLiveEventIDInsensitively(input string) (*LiveEventId, error)

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

func (LiveEventId) ID 

func (id LiveEventId) ID() string

ID returns the formatted Live Event ID

func (LiveEventId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Live Event ID

func (LiveEventId) String 

func (id LiveEventId) String() string

String returns a human-readable description of this Live Event ID

type LiveOutput 

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

type LiveOutputId 

type LiveOutputId struct {
	SubscriptionId    string
	ResourceGroupName string
	MediaServiceName  string
	LiveEventName     string
	LiveOutputName    string
}

LiveOutputId is a struct representing the Resource ID for a Live Output

func NewLiveOutputID 

func NewLiveOutputID(subscriptionId string, resourceGroupName string, mediaServiceName string, liveEventName string, liveOutputName string) LiveOutputId

NewLiveOutputID returns a new LiveOutputId struct

func ParseLiveOutputID 

func ParseLiveOutputID(input string) (*LiveOutputId, error)

ParseLiveOutputID parses 'input' into a LiveOutputId

func ParseLiveOutputIDInsensitively 

func ParseLiveOutputIDInsensitively(input string) (*LiveOutputId, error)

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

func (LiveOutputId) ID 

func (id LiveOutputId) ID() string

ID returns the formatted Live Output ID

func (LiveOutputId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Live Output ID

func (LiveOutputId) String 

func (id LiveOutputId) String() string

String returns a human-readable description of this Live Output ID

type LiveOutputOperationId 

type LiveOutputOperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	MediaServiceName  string
	OperationId       string
}

LiveOutputOperationId is a struct representing the Resource ID for a Live Output Operation

func NewLiveOutputOperationID 

func NewLiveOutputOperationID(subscriptionId string, resourceGroupName string, mediaServiceName string, operationId string) LiveOutputOperationId

NewLiveOutputOperationID returns a new LiveOutputOperationId struct

func ParseLiveOutputOperationID 

func ParseLiveOutputOperationID(input string) (*LiveOutputOperationId, error)

ParseLiveOutputOperationID parses 'input' into a LiveOutputOperationId

func ParseLiveOutputOperationIDInsensitively 

func ParseLiveOutputOperationIDInsensitively(input string) (*LiveOutputOperationId, error)

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

func (LiveOutputOperationId) ID 

func (id LiveOutputOperationId) ID() string

ID returns the formatted Live Output Operation ID

func (LiveOutputOperationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Live Output Operation ID

func (LiveOutputOperationId) String 

func (id LiveOutputOperationId) String() string

String returns a human-readable description of this Live Output Operation ID

type LiveOutputOperationLocationId 

type LiveOutputOperationLocationId struct {
	SubscriptionId    string
	ResourceGroupName string
	MediaServiceName  string
	LiveEventName     string
	LiveOutputName    string
	OperationId       string
}

LiveOutputOperationLocationId is a struct representing the Resource ID for a Live Output Operation Location

func NewLiveOutputOperationLocationID 

func NewLiveOutputOperationLocationID(subscriptionId string, resourceGroupName string, mediaServiceName string, liveEventName string, liveOutputName string, operationId string) LiveOutputOperationLocationId

NewLiveOutputOperationLocationID returns a new LiveOutputOperationLocationId struct

func ParseLiveOutputOperationLocationID 

func ParseLiveOutputOperationLocationID(input string) (*LiveOutputOperationLocationId, error)

ParseLiveOutputOperationLocationID parses 'input' into a LiveOutputOperationLocationId

func ParseLiveOutputOperationLocationIDInsensitively 

func ParseLiveOutputOperationLocationIDInsensitively(input string) (*LiveOutputOperationLocationId, error)

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

func (LiveOutputOperationLocationId) ID 

func (id LiveOutputOperationLocationId) ID() string

ID returns the formatted Live Output Operation Location ID

func (LiveOutputOperationLocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Live Output Operation Location ID

func (LiveOutputOperationLocationId) String 

func (id LiveOutputOperationLocationId) String() string

String returns a human-readable description of this Live Output Operation Location ID

type LiveOutputOperationPredicate 

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

func (LiveOutputOperationPredicate) Matches 

func (p LiveOutputOperationPredicate) Matches(input LiveOutput) bool

type LiveOutputProperties 

type LiveOutputProperties struct {
	ArchiveWindowLength string                   `json:"archiveWindowLength"`
	AssetName           string                   `json:"assetName"`
	Created             *string                  `json:"created,omitempty"`
	Description         *string                  `json:"description,omitempty"`
	Hls                 *Hls                     `json:"hls,omitempty"`
	LastModified        *string                  `json:"lastModified,omitempty"`
	ManifestName        *string                  `json:"manifestName,omitempty"`
	OutputSnapTime      *int64                   `json:"outputSnapTime,omitempty"`
	ProvisioningState   *string                  `json:"provisioningState,omitempty"`
	ResourceState       *LiveOutputResourceState `json:"resourceState,omitempty"`
	RewindWindowLength  *string                  `json:"rewindWindowLength,omitempty"`
}

func (*LiveOutputProperties) GetCreatedAsTime 

func (o *LiveOutputProperties) GetCreatedAsTime() (*time.Time, error)

func (*LiveOutputProperties) GetLastModifiedAsTime 

func (o *LiveOutputProperties) GetLastModifiedAsTime() (*time.Time, error)

func (*LiveOutputProperties) SetCreatedAsTime 

func (o *LiveOutputProperties) SetCreatedAsTime(input time.Time)

func (*LiveOutputProperties) SetLastModifiedAsTime 

func (o *LiveOutputProperties) SetLastModifiedAsTime(input time.Time)

type LiveOutputResourceState 

type LiveOutputResourceState string
const (
	LiveOutputResourceStateCreating LiveOutputResourceState = "Creating"
	LiveOutputResourceStateDeleting LiveOutputResourceState = "Deleting"
	LiveOutputResourceStateRunning  LiveOutputResourceState = "Running"
)

func (*LiveOutputResourceState) UnmarshalJSON added in v0.20230406.1124617 

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

type LiveOutputsClient 

type LiveOutputsClient struct {
	Client *resourcemanager.Client
}

func NewLiveOutputsClientWithBaseURI 

func NewLiveOutputsClientWithBaseURI(api environments.Api) (*LiveOutputsClient, error)

func (LiveOutputsClient) AsyncOperation 

func (c LiveOutputsClient) AsyncOperation(ctx context.Context, id LiveOutputOperationId) (result AsyncOperationOperationResponse, err error)

AsyncOperation ...

func (LiveOutputsClient) Create 

func (c LiveOutputsClient) Create(ctx context.Context, id LiveOutputId, input LiveOutput) (result CreateOperationResponse, err error)

Create ...

func (LiveOutputsClient) CreateThenPoll 

func (c LiveOutputsClient) CreateThenPoll(ctx context.Context, id LiveOutputId, input LiveOutput) error

CreateThenPoll performs Create then polls until it's completed

func (LiveOutputsClient) Delete 

func (c LiveOutputsClient) Delete(ctx context.Context, id LiveOutputId) (result DeleteOperationResponse, err error)

Delete ...

func (LiveOutputsClient) DeleteThenPoll 

func (c LiveOutputsClient) DeleteThenPoll(ctx context.Context, id LiveOutputId) error

DeleteThenPoll performs Delete then polls until it's completed

func (LiveOutputsClient) Get 

func (c LiveOutputsClient) Get(ctx context.Context, id LiveOutputId) (result GetOperationResponse, err error)

Get ...

func (LiveOutputsClient) List 

func (c LiveOutputsClient) List(ctx context.Context, id LiveEventId) (result ListOperationResponse, err error)

List ...

func (LiveOutputsClient) ListComplete 

func (c LiveOutputsClient) ListComplete(ctx context.Context, id LiveEventId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (LiveOutputsClient) ListCompleteMatchingPredicate 

func (c LiveOutputsClient) ListCompleteMatchingPredicate(ctx context.Context, id LiveEventId, predicate LiveOutputOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (LiveOutputsClient) OperationLocation 

func (c LiveOutputsClient) OperationLocation(ctx context.Context, id LiveOutputOperationLocationId) (result OperationLocationOperationResponse, err error)

OperationLocation ...

type OperationLocationOperationResponse 

type OperationLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LiveOutput
}

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.