referencedatasets

package
v0.20240325.1135512 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/timeseriesinsights/2020-05-15/referencedatasets Documentation

The referencedatasets SDK allows for interaction with the Azure Resource Manager Service timeseriesinsights (API Version 2020-05-15).

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/timeseriesinsights/2020-05-15/referencedatasets"

Client Initialization

client := referencedatasets.NewReferenceDataSetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReferenceDataSetsClient.CreateOrUpdate

ctx := context.TODO()
id := referencedatasets.NewReferenceDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "referenceDataSetValue")

payload := referencedatasets.ReferenceDataSetCreateOrUpdateParameters{
	// ...
}


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: ReferenceDataSetsClient.Delete

ctx := context.TODO()
id := referencedatasets.NewReferenceDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "referenceDataSetValue")

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: ReferenceDataSetsClient.Get

ctx := context.TODO()
id := referencedatasets.NewReferenceDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "referenceDataSetValue")

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: ReferenceDataSetsClient.ListByEnvironment

ctx := context.TODO()
id := referencedatasets.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue")

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

Example Usage: ReferenceDataSetsClient.Update

ctx := context.TODO()
id := referencedatasets.NewReferenceDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "referenceDataSetValue")

payload := referencedatasets.ReferenceDataSetUpdateParameters{
	// ...
}


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

func PossibleValuesForDataStringComparisonBehavior() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReferenceDataKeyPropertyType 

func PossibleValuesForReferenceDataKeyPropertyType() []string

func ValidateEnvironmentID 

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

ValidateEnvironmentID checks that 'input' can be parsed as a Environment ID

func ValidateReferenceDataSetID 

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

ValidateReferenceDataSetID checks that 'input' can be parsed as a Reference Data Set ID

Types

type CreateOrUpdateOperationResponse 

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

type DataStringComparisonBehavior 

type DataStringComparisonBehavior string
const (
	DataStringComparisonBehaviorOrdinal           DataStringComparisonBehavior = "Ordinal"
	DataStringComparisonBehaviorOrdinalIgnoreCase DataStringComparisonBehavior = "OrdinalIgnoreCase"
)

func (*DataStringComparisonBehavior) UnmarshalJSON added in v0.20240214.1142753 

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

type DeleteOperationResponse 

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

type EnvironmentId 

type EnvironmentId struct {
	SubscriptionId    string
	ResourceGroupName string
	EnvironmentName   string
}

EnvironmentId is a struct representing the Resource ID for a Environment

func NewEnvironmentID 

func NewEnvironmentID(subscriptionId string, resourceGroupName string, environmentName string) EnvironmentId

NewEnvironmentID returns a new EnvironmentId struct

func ParseEnvironmentID 

func ParseEnvironmentID(input string) (*EnvironmentId, error)

ParseEnvironmentID parses 'input' into a EnvironmentId

func ParseEnvironmentIDInsensitively 

func ParseEnvironmentIDInsensitively(input string) (*EnvironmentId, error)

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

func (*EnvironmentId) FromParseResult 

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

func (EnvironmentId) ID 

func (id EnvironmentId) ID() string

ID returns the formatted Environment ID

func (EnvironmentId) Segments 

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

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

func (EnvironmentId) String 

func (id EnvironmentId) String() string

String returns a human-readable description of this Environment ID

type GetOperationResponse 

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

type ListByEnvironmentOperationResponse 

type ListByEnvironmentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReferenceDataSetListResponse
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20240214.1142753 

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

type ReferenceDataKeyPropertyType 

type ReferenceDataKeyPropertyType string
const (
	ReferenceDataKeyPropertyTypeBool     ReferenceDataKeyPropertyType = "Bool"
	ReferenceDataKeyPropertyTypeDateTime ReferenceDataKeyPropertyType = "DateTime"
	ReferenceDataKeyPropertyTypeDouble   ReferenceDataKeyPropertyType = "Double"
	ReferenceDataKeyPropertyTypeString   ReferenceDataKeyPropertyType = "String"
)

func (*ReferenceDataKeyPropertyType) UnmarshalJSON added in v0.20240214.1142753 

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

type ReferenceDataSetCreateOrUpdateParameters 

type ReferenceDataSetCreateOrUpdateParameters struct {
	Location   string                             `json:"location"`
	Properties ReferenceDataSetCreationProperties `json:"properties"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type ReferenceDataSetCreationProperties 

type ReferenceDataSetCreationProperties struct {
	DataStringComparisonBehavior *DataStringComparisonBehavior `json:"dataStringComparisonBehavior,omitempty"`
	KeyProperties                []ReferenceDataSetKeyProperty `json:"keyProperties"`
}

type ReferenceDataSetId 

type ReferenceDataSetId struct {
	SubscriptionId       string
	ResourceGroupName    string
	EnvironmentName      string
	ReferenceDataSetName string
}

ReferenceDataSetId is a struct representing the Resource ID for a Reference Data Set

func NewReferenceDataSetID 

func NewReferenceDataSetID(subscriptionId string, resourceGroupName string, environmentName string, referenceDataSetName string) ReferenceDataSetId

NewReferenceDataSetID returns a new ReferenceDataSetId struct

func ParseReferenceDataSetID 

func ParseReferenceDataSetID(input string) (*ReferenceDataSetId, error)

ParseReferenceDataSetID parses 'input' into a ReferenceDataSetId

func ParseReferenceDataSetIDInsensitively 

func ParseReferenceDataSetIDInsensitively(input string) (*ReferenceDataSetId, error)

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

func (*ReferenceDataSetId) FromParseResult 

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

func (ReferenceDataSetId) ID 

func (id ReferenceDataSetId) ID() string

ID returns the formatted Reference Data Set ID

func (ReferenceDataSetId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Reference Data Set ID

func (ReferenceDataSetId) String 

func (id ReferenceDataSetId) String() string

String returns a human-readable description of this Reference Data Set ID

type ReferenceDataSetKeyProperty 

type ReferenceDataSetKeyProperty struct {
	Name *string                       `json:"name,omitempty"`
	Type *ReferenceDataKeyPropertyType `json:"type,omitempty"`
}

type ReferenceDataSetListResponse 

type ReferenceDataSetListResponse struct {
	Value *[]ReferenceDataSetResource `json:"value,omitempty"`
}

type ReferenceDataSetResource 

type ReferenceDataSetResource struct {
	Id         *string                             `json:"id,omitempty"`
	Location   string                              `json:"location"`
	Name       *string                             `json:"name,omitempty"`
	Properties *ReferenceDataSetResourceProperties `json:"properties,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type ReferenceDataSetResourceProperties 

type ReferenceDataSetResourceProperties struct {
	CreationTime                 *string                       `json:"creationTime,omitempty"`
	DataStringComparisonBehavior *DataStringComparisonBehavior `json:"dataStringComparisonBehavior,omitempty"`
	KeyProperties                []ReferenceDataSetKeyProperty `json:"keyProperties"`
	ProvisioningState            *ProvisioningState            `json:"provisioningState,omitempty"`
}

func (*ReferenceDataSetResourceProperties) GetCreationTimeAsTime 

func (o *ReferenceDataSetResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*ReferenceDataSetResourceProperties) SetCreationTimeAsTime 

func (o *ReferenceDataSetResourceProperties) SetCreationTimeAsTime(input time.Time)

type ReferenceDataSetUpdateParameters 

type ReferenceDataSetUpdateParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type ReferenceDataSetsClient 

type ReferenceDataSetsClient struct {
	Client *resourcemanager.Client
}

func NewReferenceDataSetsClientWithBaseURI 

func NewReferenceDataSetsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReferenceDataSetsClient, error)

func (ReferenceDataSetsClient) CreateOrUpdate 

func (c ReferenceDataSetsClient) CreateOrUpdate(ctx context.Context, id ReferenceDataSetId, input ReferenceDataSetCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ReferenceDataSetsClient) Delete 

func (c ReferenceDataSetsClient) Delete(ctx context.Context, id ReferenceDataSetId) (result DeleteOperationResponse, err error)

Delete ...

func (ReferenceDataSetsClient) Get 

func (c ReferenceDataSetsClient) Get(ctx context.Context, id ReferenceDataSetId) (result GetOperationResponse, err error)

Get ...

func (ReferenceDataSetsClient) ListByEnvironment 

func (c ReferenceDataSetsClient) ListByEnvironment(ctx context.Context, id EnvironmentId) (result ListByEnvironmentOperationResponse, err error)

ListByEnvironment ...

func (ReferenceDataSetsClient) Update 

func (c ReferenceDataSetsClient) Update(ctx context.Context, id ReferenceDataSetId, input ReferenceDataSetUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReferenceDataSetResource
}

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.