edgemodules

package
v0.20231205.1181718 Latest Latest
Warning

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

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

README

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

The edgemodules 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/edgemodules"

Client Initialization

client := edgemodules.NewEdgeModulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EdgeModulesClient.CreateOrUpdate

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

payload := edgemodules.EdgeModuleEntity{
	// ...
}


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

Example Usage: EdgeModulesClient.Delete

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

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

Example Usage: EdgeModulesClient.Get

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

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

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

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

Example Usage: EdgeModulesClient.ListProvisioningToken

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

payload := edgemodules.ListProvisioningTokenInput{
	// ...
}


read, err := client.ListProvisioningToken(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 ValidateEdgeModuleID 

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

ValidateEdgeModuleID checks that 'input' can be parsed as a Edge Module 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

Types

type CreateOrUpdateOperationResponse added in v0.20230906.1160501 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EdgeModuleEntity
}

type DeleteOperationResponse added in v0.20230906.1160501 

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

type EdgeModuleEntity 

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

type EdgeModuleEntityOperationPredicate 

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

func (EdgeModuleEntityOperationPredicate) Matches 

func (p EdgeModuleEntityOperationPredicate) Matches(input EdgeModuleEntity) bool

type EdgeModuleId 

type EdgeModuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	VideoAnalyzerName string
	EdgeModuleName    string
}

EdgeModuleId is a struct representing the Resource ID for a Edge Module

func NewEdgeModuleID 

func NewEdgeModuleID(subscriptionId string, resourceGroupName string, videoAnalyzerName string, edgeModuleName string) EdgeModuleId

NewEdgeModuleID returns a new EdgeModuleId struct

func ParseEdgeModuleID 

func ParseEdgeModuleID(input string) (*EdgeModuleId, error)

ParseEdgeModuleID parses 'input' into a EdgeModuleId

func ParseEdgeModuleIDInsensitively 

func ParseEdgeModuleIDInsensitively(input string) (*EdgeModuleId, error)

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

func (*EdgeModuleId) FromParseResult added in v0.20231127.1171502 

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

func (EdgeModuleId) ID 

func (id EdgeModuleId) ID() string

ID returns the formatted Edge Module ID

func (EdgeModuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Edge Module ID

func (EdgeModuleId) String 

func (id EdgeModuleId) String() string

String returns a human-readable description of this Edge Module ID

type EdgeModuleProperties 

type EdgeModuleProperties struct {
	EdgeModuleId *string `json:"edgeModuleId,omitempty"`
}

type EdgeModuleProvisioningToken 

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

func (*EdgeModuleProvisioningToken) GetExpirationDateAsTime 

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

func (*EdgeModuleProvisioningToken) SetExpirationDateAsTime 

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

type EdgeModulesClient 

type EdgeModulesClient struct {
	Client *resourcemanager.Client
}

func NewEdgeModulesClientWithBaseURI 

func NewEdgeModulesClientWithBaseURI(sdkApi sdkEnv.Api) (*EdgeModulesClient, error)

func (EdgeModulesClient) CreateOrUpdate added in v0.20230906.1160501 

func (c EdgeModulesClient) CreateOrUpdate(ctx context.Context, id EdgeModuleId, input EdgeModuleEntity) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (EdgeModulesClient) Delete added in v0.20230906.1160501 

func (c EdgeModulesClient) Delete(ctx context.Context, id EdgeModuleId) (result DeleteOperationResponse, err error)

Delete ...

func (EdgeModulesClient) Get added in v0.20230906.1160501 

func (c EdgeModulesClient) Get(ctx context.Context, id EdgeModuleId) (result GetOperationResponse, err error)

Get ...

func (EdgeModulesClient) List added in v0.20230906.1160501 

func (c EdgeModulesClient) List(ctx context.Context, id VideoAnalyzerId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (EdgeModulesClient) ListComplete added in v0.20230906.1160501 

func (c EdgeModulesClient) ListComplete(ctx context.Context, id VideoAnalyzerId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (EdgeModulesClient) ListCompleteMatchingPredicate added in v0.20230906.1160501 

func (c EdgeModulesClient) ListCompleteMatchingPredicate(ctx context.Context, id VideoAnalyzerId, options ListOperationOptions, predicate EdgeModuleEntityOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EdgeModulesClient) ListProvisioningToken added in v0.20230906.1160501 

func (c EdgeModulesClient) ListProvisioningToken(ctx context.Context, id EdgeModuleId, input ListProvisioningTokenInput) (result ListProvisioningTokenOperationResponse, err error)

ListProvisioningToken ...

type GetOperationResponse added in v0.20230906.1160501 

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

type ListCompleteResult added in v0.20230906.1160501 

type ListCompleteResult struct {
	Items []EdgeModuleEntity
}

type ListOperationOptions added in v0.20230906.1160501 

type ListOperationOptions struct {
	Filter  *string
	Orderby *string
	Top     *int64
}

func DefaultListOperationOptions added in v0.20230906.1160501 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230906.1160501 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230906.1160501 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230906.1160501 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse added in v0.20230906.1160501 

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

type ListProvisioningTokenInput 

type ListProvisioningTokenInput struct {
	ExpirationDate string `json:"expirationDate"`
}

func (*ListProvisioningTokenInput) GetExpirationDateAsTime 

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

func (*ListProvisioningTokenInput) SetExpirationDateAsTime 

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

type ListProvisioningTokenOperationResponse added in v0.20230906.1160501 

type ListProvisioningTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EdgeModuleProvisioningToken
}

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) FromParseResult added in v0.20231127.1171502 

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

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

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.