videos

package
v0.20230406.1222242 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/videoanalyzer/2021-05-01-preview/videos Documentation

The videos SDK allows for interaction with the Azure Resource Manager Service videoanalyzer (API Version 2021-05-01-preview).

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/videoanalyzer/2021-05-01-preview/videos"

Client Initialization

client := videos.NewVideosClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VideosClient.AccessPoliciesCreateOrUpdate

ctx := context.TODO()
id := videos.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "accessPolicyValue")

payload := videos.AccessPolicyEntity{
	// ...
}


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

Example Usage: VideosClient.AccessPoliciesDelete

ctx := context.TODO()
id := videos.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "accessPolicyValue")

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

Example Usage: VideosClient.AccessPoliciesGet

ctx := context.TODO()
id := videos.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "accessPolicyValue")

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

Example Usage: VideosClient.AccessPoliciesList

ctx := context.TODO()
id := videos.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

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

Example Usage: VideosClient.AccessPoliciesUpdate

ctx := context.TODO()
id := videos.NewAccessPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "accessPolicyValue")

payload := videos.AccessPolicyEntity{
	// ...
}


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

Example Usage: VideosClient.VideosCreateOrUpdate

ctx := context.TODO()
id := videos.NewVideoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "videoValue")

payload := videos.VideoEntity{
	// ...
}


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

Example Usage: VideosClient.VideosDelete

ctx := context.TODO()
id := videos.NewVideoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "videoValue")

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

Example Usage: VideosClient.VideosGet

ctx := context.TODO()
id := videos.NewVideoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "videoValue")

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

Example Usage: VideosClient.VideosList

ctx := context.TODO()
id := videos.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

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

Example Usage: VideosClient.VideosListStreamingToken

ctx := context.TODO()
id := videos.NewVideoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "videoValue")

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

Example Usage: VideosClient.VideosUpdate

ctx := context.TODO()
id := videos.NewVideoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue", "videoValue")

payload := videos.VideoEntity{
	// ...
}


read, err := client.VideosUpdate(ctx, id, payload)
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 PossibleValuesForAccessPolicyEccAlgo 

func PossibleValuesForAccessPolicyEccAlgo() []string

func PossibleValuesForAccessPolicyRole 

func PossibleValuesForAccessPolicyRole() []string

func PossibleValuesForAccessPolicyRsaAlgo 

func PossibleValuesForAccessPolicyRsaAlgo() []string

func PossibleValuesForVideoType 

func PossibleValuesForVideoType() []string

func ValidateAccessPolicyID added in v0.20220907.1111434 

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

ValidateAccessPolicyID checks that 'input' can be parsed as a Access Policy ID

func ValidateVideoAnalyzerID 

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

ValidateVideoAnalyzerID checks that 'input' can be parsed as a Video Analyzer ID

func ValidateVideoID 

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

ValidateVideoID checks that 'input' can be parsed as a Video ID

Types

type AccessPoliciesCreateOrUpdateOperationResponse 

type AccessPoliciesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessPolicyEntity
}

type AccessPoliciesDeleteOperationResponse 

type AccessPoliciesDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type AccessPoliciesGetOperationResponse 

type AccessPoliciesGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessPolicyEntity
}

type AccessPoliciesListCompleteResult 

type AccessPoliciesListCompleteResult struct {
	Items []AccessPolicyEntity
}

type AccessPoliciesListOperationOptions 

type AccessPoliciesListOperationOptions struct {
	Top *int64
}

func DefaultAccessPoliciesListOperationOptions 

func DefaultAccessPoliciesListOperationOptions() AccessPoliciesListOperationOptions

type AccessPoliciesListOperationResponse 

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

func (AccessPoliciesListOperationResponse) HasMore 

func (r AccessPoliciesListOperationResponse) HasMore() bool

func (AccessPoliciesListOperationResponse) LoadMore 

func (r AccessPoliciesListOperationResponse) LoadMore(ctx context.Context) (resp AccessPoliciesListOperationResponse, err error)

type AccessPoliciesUpdateOperationResponse 

type AccessPoliciesUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessPolicyEntity
}

type AccessPolicyEccAlgo 

type AccessPolicyEccAlgo string
const (
	AccessPolicyEccAlgoESFiveOneTwo     AccessPolicyEccAlgo = "ES512"
	AccessPolicyEccAlgoESThreeEightFour AccessPolicyEccAlgo = "ES384"
	AccessPolicyEccAlgoESTwoFiveSix     AccessPolicyEccAlgo = "ES256"
)

type AccessPolicyEntity 

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

type AccessPolicyEntityOperationPredicate 

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

func (AccessPolicyEntityOperationPredicate) Matches 

func (p AccessPolicyEntityOperationPredicate) Matches(input AccessPolicyEntity) bool

type AccessPolicyId added in v0.20220907.1111434 

type AccessPolicyId struct {
	SubscriptionId    string
	ResourceGroupName string
	VideoAnalyzerName string
	AccessPolicyName  string
}

AccessPolicyId is a struct representing the Resource ID for a Access Policy

func NewAccessPolicyID added in v0.20220907.1111434 

func NewAccessPolicyID(subscriptionId string, resourceGroupName string, videoAnalyzerName string, accessPolicyName string) AccessPolicyId

NewAccessPolicyID returns a new AccessPolicyId struct

func ParseAccessPolicyID added in v0.20220907.1111434 

func ParseAccessPolicyID(input string) (*AccessPolicyId, error)

ParseAccessPolicyID parses 'input' into a AccessPolicyId

func ParseAccessPolicyIDInsensitively added in v0.20220907.1111434 

func ParseAccessPolicyIDInsensitively(input string) (*AccessPolicyId, error)

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

func (AccessPolicyId) ID added in v0.20220907.1111434 

func (id AccessPolicyId) ID() string

ID returns the formatted Access Policy ID

func (AccessPolicyId) Segments added in v0.20220907.1111434 

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

Segments returns a slice of Resource ID Segments which comprise this Access Policy ID

func (AccessPolicyId) String added in v0.20220907.1111434 

func (id AccessPolicyId) String() string

String returns a human-readable description of this Access Policy ID

type AccessPolicyProperties 

type AccessPolicyProperties struct {
	Authentication AuthenticationBase `json:"authentication"`
	Role           *AccessPolicyRole  `json:"role,omitempty"`
}

func (*AccessPolicyProperties) UnmarshalJSON 

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

type AccessPolicyRole 

type AccessPolicyRole string
const (
	AccessPolicyRoleReader AccessPolicyRole = "Reader"
)

type AccessPolicyRsaAlgo 

type AccessPolicyRsaAlgo string
const (
	AccessPolicyRsaAlgoRSFiveOneTwo     AccessPolicyRsaAlgo = "RS512"
	AccessPolicyRsaAlgoRSThreeEightFour AccessPolicyRsaAlgo = "RS384"
	AccessPolicyRsaAlgoRSTwoFiveSix     AccessPolicyRsaAlgo = "RS256"
)

type AuthenticationBase 

type AuthenticationBase interface {
}

type EccTokenKey 

type EccTokenKey struct {
	Alg AccessPolicyEccAlgo `json:"alg"`
	X   string              `json:"x"`
	Y   string              `json:"y"`

	// Fields inherited from TokenKey
	Kid string `json:"kid"`
}

func (EccTokenKey) MarshalJSON 

func (s EccTokenKey) MarshalJSON() ([]byte, error)

type JwtAuthentication 

type JwtAuthentication struct {
	Audiences *[]string     `json:"audiences,omitempty"`
	Claims    *[]TokenClaim `json:"claims,omitempty"`
	Issuers   *[]string     `json:"issuers,omitempty"`
	Keys      *[]TokenKey   `json:"keys,omitempty"`
}

func (JwtAuthentication) MarshalJSON 

func (s JwtAuthentication) MarshalJSON() ([]byte, error)

func (*JwtAuthentication) UnmarshalJSON 

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

type RsaTokenKey 

type RsaTokenKey struct {
	Alg AccessPolicyRsaAlgo `json:"alg"`
	E   string              `json:"e"`
	N   string              `json:"n"`

	// Fields inherited from TokenKey
	Kid string `json:"kid"`
}

func (RsaTokenKey) MarshalJSON 

func (s RsaTokenKey) MarshalJSON() ([]byte, error)

type TokenClaim 

type TokenClaim struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type TokenKey 

type TokenKey interface {
}

type VideoAnalyzerId 

type VideoAnalyzerId struct {
	SubscriptionId    string
	ResourceGroupName string
	VideoAnalyzerName string
}

VideoAnalyzerId is a struct representing the Resource ID for a Video Analyzer

func NewVideoAnalyzerID 

func NewVideoAnalyzerID(subscriptionId string, resourceGroupName string, videoAnalyzerName string) VideoAnalyzerId

NewVideoAnalyzerID returns a new VideoAnalyzerId struct

func ParseVideoAnalyzerID 

func ParseVideoAnalyzerID(input string) (*VideoAnalyzerId, error)

ParseVideoAnalyzerID parses 'input' into a VideoAnalyzerId

func ParseVideoAnalyzerIDInsensitively 

func ParseVideoAnalyzerIDInsensitively(input string) (*VideoAnalyzerId, error)

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

func (VideoAnalyzerId) ID 

func (id VideoAnalyzerId) ID() string

ID returns the formatted Video Analyzer ID

func (VideoAnalyzerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Video Analyzer ID

func (VideoAnalyzerId) String 

func (id VideoAnalyzerId) String() string

String returns a human-readable description of this Video Analyzer ID

type VideoEntity 

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

type VideoEntityOperationPredicate 

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

func (VideoEntityOperationPredicate) Matches 

func (p VideoEntityOperationPredicate) Matches(input VideoEntity) bool

type VideoFlags 

type VideoFlags struct {
	CanStream   bool `json:"canStream"`
	HasData     bool `json:"hasData"`
	IsRecording bool `json:"isRecording"`
}

type VideoId 

type VideoId struct {
	SubscriptionId    string
	ResourceGroupName string
	VideoAnalyzerName string
	VideoName         string
}

VideoId is a struct representing the Resource ID for a Video

func NewVideoID 

func NewVideoID(subscriptionId string, resourceGroupName string, videoAnalyzerName string, videoName string) VideoId

NewVideoID returns a new VideoId struct

func ParseVideoID 

func ParseVideoID(input string) (*VideoId, error)

ParseVideoID parses 'input' into a VideoId

func ParseVideoIDInsensitively 

func ParseVideoIDInsensitively(input string) (*VideoId, error)

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

func (VideoId) ID 

func (id VideoId) ID() string

ID returns the formatted Video ID

func (VideoId) Segments 

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

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

func (VideoId) String 

func (id VideoId) String() string

String returns a human-readable description of this Video ID

type VideoMediaInfo 

type VideoMediaInfo struct {
	SegmentLength *string `json:"segmentLength,omitempty"`
}

type VideoProperties 

type VideoProperties struct {
	Description *string         `json:"description,omitempty"`
	Flags       *VideoFlags     `json:"flags,omitempty"`
	MediaInfo   *VideoMediaInfo `json:"mediaInfo,omitempty"`
	Streaming   *VideoStreaming `json:"streaming,omitempty"`
	Title       *string         `json:"title,omitempty"`
	Type        *VideoType      `json:"type,omitempty"`
}

type VideoStreaming 

type VideoStreaming struct {
	ArchiveBaseUrl *string `json:"archiveBaseUrl,omitempty"`
}

type VideoStreamingToken 

type VideoStreamingToken struct {
	ExpirationDate *string `json:"expirationDate,omitempty"`
	Token          *string `json:"token,omitempty"`
}

func (*VideoStreamingToken) GetExpirationDateAsTime 

func (o *VideoStreamingToken) GetExpirationDateAsTime() (*time.Time, error)

func (*VideoStreamingToken) SetExpirationDateAsTime 

func (o *VideoStreamingToken) SetExpirationDateAsTime(input time.Time)

type VideoType 

type VideoType string
const (
	VideoTypeArchive VideoType = "Archive"
)

type VideosClient 

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

func NewVideosClientWithBaseURI 

func NewVideosClientWithBaseURI(endpoint string) VideosClient

func (VideosClient) AccessPoliciesCreateOrUpdate 

func (c VideosClient) AccessPoliciesCreateOrUpdate(ctx context.Context, id AccessPolicyId, input AccessPolicyEntity) (result AccessPoliciesCreateOrUpdateOperationResponse, err error)

AccessPoliciesCreateOrUpdate ...

func (VideosClient) AccessPoliciesDelete 

func (c VideosClient) AccessPoliciesDelete(ctx context.Context, id AccessPolicyId) (result AccessPoliciesDeleteOperationResponse, err error)

AccessPoliciesDelete ...

func (VideosClient) AccessPoliciesGet 

func (c VideosClient) AccessPoliciesGet(ctx context.Context, id AccessPolicyId) (result AccessPoliciesGetOperationResponse, err error)

AccessPoliciesGet ...

func (VideosClient) AccessPoliciesList 

func (c VideosClient) AccessPoliciesList(ctx context.Context, id VideoAnalyzerId, options AccessPoliciesListOperationOptions) (resp AccessPoliciesListOperationResponse, err error)

AccessPoliciesList ...

func (VideosClient) AccessPoliciesListComplete 

func (c VideosClient) AccessPoliciesListComplete(ctx context.Context, id VideoAnalyzerId, options AccessPoliciesListOperationOptions) (AccessPoliciesListCompleteResult, error)

AccessPoliciesListComplete retrieves all of the results into a single object

func (VideosClient) AccessPoliciesListCompleteMatchingPredicate 

func (c VideosClient) AccessPoliciesListCompleteMatchingPredicate(ctx context.Context, id VideoAnalyzerId, options AccessPoliciesListOperationOptions, predicate AccessPolicyEntityOperationPredicate) (resp AccessPoliciesListCompleteResult, err error)

AccessPoliciesListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VideosClient) AccessPoliciesUpdate 

func (c VideosClient) AccessPoliciesUpdate(ctx context.Context, id AccessPolicyId, input AccessPolicyEntity) (result AccessPoliciesUpdateOperationResponse, err error)

AccessPoliciesUpdate ...

func (VideosClient) VideosCreateOrUpdate 

func (c VideosClient) VideosCreateOrUpdate(ctx context.Context, id VideoId, input VideoEntity) (result VideosCreateOrUpdateOperationResponse, err error)

VideosCreateOrUpdate ...

func (VideosClient) VideosDelete 

func (c VideosClient) VideosDelete(ctx context.Context, id VideoId) (result VideosDeleteOperationResponse, err error)

VideosDelete ...

func (VideosClient) VideosGet 

func (c VideosClient) VideosGet(ctx context.Context, id VideoId) (result VideosGetOperationResponse, err error)

VideosGet ...

func (VideosClient) VideosList 

func (c VideosClient) VideosList(ctx context.Context, id VideoAnalyzerId, options VideosListOperationOptions) (resp VideosListOperationResponse, err error)

VideosList ...

func (VideosClient) VideosListComplete 

func (c VideosClient) VideosListComplete(ctx context.Context, id VideoAnalyzerId, options VideosListOperationOptions) (VideosListCompleteResult, error)

VideosListComplete retrieves all of the results into a single object

func (VideosClient) VideosListCompleteMatchingPredicate 

func (c VideosClient) VideosListCompleteMatchingPredicate(ctx context.Context, id VideoAnalyzerId, options VideosListOperationOptions, predicate VideoEntityOperationPredicate) (resp VideosListCompleteResult, err error)

VideosListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VideosClient) VideosListStreamingToken 

func (c VideosClient) VideosListStreamingToken(ctx context.Context, id VideoId) (result VideosListStreamingTokenOperationResponse, err error)

VideosListStreamingToken ...

func (VideosClient) VideosUpdate 

func (c VideosClient) VideosUpdate(ctx context.Context, id VideoId, input VideoEntity) (result VideosUpdateOperationResponse, err error)

VideosUpdate ...

type VideosCreateOrUpdateOperationResponse 

type VideosCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *VideoEntity
}

type VideosDeleteOperationResponse 

type VideosDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type VideosGetOperationResponse 

type VideosGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *VideoEntity
}

type VideosListCompleteResult 

type VideosListCompleteResult struct {
	Items []VideoEntity
}

type VideosListOperationOptions 

type VideosListOperationOptions struct {
	Top *int64
}

func DefaultVideosListOperationOptions 

func DefaultVideosListOperationOptions() VideosListOperationOptions

type VideosListOperationResponse 

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

func (VideosListOperationResponse) HasMore 

func (r VideosListOperationResponse) HasMore() bool

func (VideosListOperationResponse) LoadMore 

func (r VideosListOperationResponse) LoadMore(ctx context.Context) (resp VideosListOperationResponse, err error)

type VideosListStreamingTokenOperationResponse 

type VideosListStreamingTokenOperationResponse struct {
	HttpResponse *http.Response
	Model        *VideoStreamingToken
}

type VideosUpdateOperationResponse 

type VideosUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *VideoEntity
}

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.