datatypes

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/networkanalytics/2023-11-15/datatypes Documentation

The datatypes SDK allows for interaction with Azure Resource Manager networkanalytics (API Version 2023-11-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/networkanalytics/2023-11-15/datatypes"

Client Initialization

client := datatypes.NewDataTypesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataTypesClient.Create

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")

payload := datatypes.DataType{
	// ...
}


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

Example Usage: DataTypesClient.Delete

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")

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

Example Usage: DataTypesClient.DeleteData

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")
var payload interface{}

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

Example Usage: DataTypesClient.GenerateStorageContainerSasToken

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")

payload := datatypes.ContainerSaS{
	// ...
}


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

Example Usage: DataTypesClient.Get

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")

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: DataTypesClient.ListByDataProduct

ctx := context.TODO()
id := datatypes.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

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

Example Usage: DataTypesClient.Update

ctx := context.TODO()
id := datatypes.NewDataTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName", "dataTypeName")

payload := datatypes.DataTypeUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataTypeState 

func PossibleValuesForDataTypeState() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateDataProductID 

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

ValidateDataProductID checks that 'input' can be parsed as a Data Product ID

func ValidateDataTypeID 

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

ValidateDataTypeID checks that 'input' can be parsed as a Data Type ID

Types

type ContainerSaS 

type ContainerSaS struct {
	ExpiryTimeStamp string `json:"expiryTimeStamp"`
	IPAddress       string `json:"ipAddress"`
	StartTimeStamp  string `json:"startTimeStamp"`
}

func (*ContainerSaS) GetExpiryTimeStampAsTime 

func (o *ContainerSaS) GetExpiryTimeStampAsTime() (*time.Time, error)

func (*ContainerSaS) GetStartTimeStampAsTime 

func (o *ContainerSaS) GetStartTimeStampAsTime() (*time.Time, error)

func (*ContainerSaS) SetExpiryTimeStampAsTime 

func (o *ContainerSaS) SetExpiryTimeStampAsTime(input time.Time)

func (*ContainerSaS) SetStartTimeStampAsTime 

func (o *ContainerSaS) SetStartTimeStampAsTime(input time.Time)

type ContainerSasToken 

type ContainerSasToken struct {
	StorageContainerSasToken string `json:"storageContainerSasToken"`
}

type CreateOperationResponse 

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

type DataProductId 

type DataProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	DataProductName   string
}

DataProductId is a struct representing the Resource ID for a Data Product

func NewDataProductID 

func NewDataProductID(subscriptionId string, resourceGroupName string, dataProductName string) DataProductId

NewDataProductID returns a new DataProductId struct

func ParseDataProductID 

func ParseDataProductID(input string) (*DataProductId, error)

ParseDataProductID parses 'input' into a DataProductId

func ParseDataProductIDInsensitively 

func ParseDataProductIDInsensitively(input string) (*DataProductId, error)

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

func (*DataProductId) FromParseResult 

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

func (DataProductId) ID 

func (id DataProductId) ID() string

ID returns the formatted Data Product ID

func (DataProductId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Product ID

func (DataProductId) String 

func (id DataProductId) String() string

String returns a human-readable description of this Data Product ID

type DataType 

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

type DataTypeId 

type DataTypeId struct {
	SubscriptionId    string
	ResourceGroupName string
	DataProductName   string
	DataTypeName      string
}

DataTypeId is a struct representing the Resource ID for a Data Type

func NewDataTypeID 

func NewDataTypeID(subscriptionId string, resourceGroupName string, dataProductName string, dataTypeName string) DataTypeId

NewDataTypeID returns a new DataTypeId struct

func ParseDataTypeID 

func ParseDataTypeID(input string) (*DataTypeId, error)

ParseDataTypeID parses 'input' into a DataTypeId

func ParseDataTypeIDInsensitively 

func ParseDataTypeIDInsensitively(input string) (*DataTypeId, error)

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

func (*DataTypeId) FromParseResult 

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

func (DataTypeId) ID 

func (id DataTypeId) ID() string

ID returns the formatted Data Type ID

func (DataTypeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Type ID

func (DataTypeId) String 

func (id DataTypeId) String() string

String returns a human-readable description of this Data Type ID

type DataTypeOperationPredicate 

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

func (DataTypeOperationPredicate) Matches 

func (p DataTypeOperationPredicate) Matches(input DataType) bool

type DataTypeProperties 

type DataTypeProperties struct {
	DatabaseCacheRetention *int64             `json:"databaseCacheRetention,omitempty"`
	DatabaseRetention      *int64             `json:"databaseRetention,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
	State                  *DataTypeState     `json:"state,omitempty"`
	StateReason            *string            `json:"stateReason,omitempty"`
	StorageOutputRetention *int64             `json:"storageOutputRetention,omitempty"`
	VisualizationURL       *string            `json:"visualizationUrl,omitempty"`
}

type DataTypeState 

type DataTypeState string
const (
	DataTypeStateRunning DataTypeState = "Running"
	DataTypeStateStopped DataTypeState = "Stopped"
)

func (*DataTypeState) UnmarshalJSON 

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

type DataTypeUpdate 

type DataTypeUpdate struct {
	Properties *DataTypeUpdateProperties `json:"properties,omitempty"`
}

type DataTypeUpdateProperties 

type DataTypeUpdateProperties struct {
	DatabaseCacheRetention *int64         `json:"databaseCacheRetention,omitempty"`
	DatabaseRetention      *int64         `json:"databaseRetention,omitempty"`
	State                  *DataTypeState `json:"state,omitempty"`
	StorageOutputRetention *int64         `json:"storageOutputRetention,omitempty"`
}

type DataTypesClient 

type DataTypesClient struct {
	Client *resourcemanager.Client
}

func NewDataTypesClientWithBaseURI 

func NewDataTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*DataTypesClient, error)

func (DataTypesClient) Create 

func (c DataTypesClient) Create(ctx context.Context, id DataTypeId, input DataType) (result CreateOperationResponse, err error)

Create ...

func (DataTypesClient) CreateThenPoll 

func (c DataTypesClient) CreateThenPoll(ctx context.Context, id DataTypeId, input DataType) error

CreateThenPoll performs Create then polls until it's completed

func (DataTypesClient) Delete 

func (c DataTypesClient) Delete(ctx context.Context, id DataTypeId) (result DeleteOperationResponse, err error)

Delete ...

func (DataTypesClient) DeleteData 

func (c DataTypesClient) DeleteData(ctx context.Context, id DataTypeId, input interface{}) (result DeleteDataOperationResponse, err error)

DeleteData ...

func (DataTypesClient) DeleteDataThenPoll 

func (c DataTypesClient) DeleteDataThenPoll(ctx context.Context, id DataTypeId, input interface{}) error

DeleteDataThenPoll performs DeleteData then polls until it's completed

func (DataTypesClient) DeleteThenPoll 

func (c DataTypesClient) DeleteThenPoll(ctx context.Context, id DataTypeId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DataTypesClient) GenerateStorageContainerSasToken 

func (c DataTypesClient) GenerateStorageContainerSasToken(ctx context.Context, id DataTypeId, input ContainerSaS) (result GenerateStorageContainerSasTokenOperationResponse, err error)

GenerateStorageContainerSasToken ...

func (DataTypesClient) Get 

func (c DataTypesClient) Get(ctx context.Context, id DataTypeId) (result GetOperationResponse, err error)

Get ...

func (DataTypesClient) ListByDataProduct 

func (c DataTypesClient) ListByDataProduct(ctx context.Context, id DataProductId) (result ListByDataProductOperationResponse, err error)

ListByDataProduct ...

func (DataTypesClient) ListByDataProductComplete 

func (c DataTypesClient) ListByDataProductComplete(ctx context.Context, id DataProductId) (ListByDataProductCompleteResult, error)

ListByDataProductComplete retrieves all the results into a single object

func (DataTypesClient) ListByDataProductCompleteMatchingPredicate 

func (c DataTypesClient) ListByDataProductCompleteMatchingPredicate(ctx context.Context, id DataProductId, predicate DataTypeOperationPredicate) (result ListByDataProductCompleteResult, err error)

ListByDataProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataTypesClient) Update 

func (c DataTypesClient) Update(ctx context.Context, id DataTypeId, input DataTypeUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DataTypesClient) UpdateThenPoll 

func (c DataTypesClient) UpdateThenPoll(ctx context.Context, id DataTypeId, input DataTypeUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type DeleteDataOperationResponse 

type DeleteDataOperationResponse 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 GenerateStorageContainerSasTokenOperationResponse 

type GenerateStorageContainerSasTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerSasToken
}

type GetOperationResponse 

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

type ListByDataProductCompleteResult 

type ListByDataProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataType
}

type ListByDataProductCustomPager 

type ListByDataProductCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByDataProductCustomPager) NextPageLink() *odata.Link

type ListByDataProductOperationResponse 

type ListByDataProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataType
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataType
}

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.