schemaregistry

package
v0.20231213.1163732 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/schemaregistry Documentation

The schemaregistry SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2024-01-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/eventhub/2024-01-01/schemaregistry"

Client Initialization

client := schemaregistry.NewSchemaRegistryClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SchemaRegistryClient.CreateOrUpdate

ctx := context.TODO()
id := schemaregistry.NewSchemaGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "schemaGroupValue")

payload := schemaregistry.SchemaGroup{
	// ...
}


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

ctx := context.TODO()
id := schemaregistry.NewSchemaGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "schemaGroupValue")

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

ctx := context.TODO()
id := schemaregistry.NewSchemaGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "schemaGroupValue")

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: SchemaRegistryClient.ListByNamespace

ctx := context.TODO()
id := schemaregistry.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSchemaCompatibility 

func PossibleValuesForSchemaCompatibility() []string

func PossibleValuesForSchemaType 

func PossibleValuesForSchemaType() []string

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidateSchemaGroupID 

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

ValidateSchemaGroupID checks that 'input' can be parsed as a Schema Group ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByNamespaceCompleteResult 

type ListByNamespaceCompleteResult struct {
	Items []SchemaGroup
}

type ListByNamespaceOperationOptions 

type ListByNamespaceOperationOptions struct {
	Skip *int64
	Top  *int64
}

func DefaultListByNamespaceOperationOptions 

func DefaultListByNamespaceOperationOptions() ListByNamespaceOperationOptions

func (ListByNamespaceOperationOptions) ToHeaders 

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

func (ListByNamespaceOperationOptions) ToOData 

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

func (ListByNamespaceOperationOptions) ToQuery 

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

type ListByNamespaceOperationResponse 

type ListByNamespaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SchemaGroup
}

type NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult added in v0.20231127.1171502 

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

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

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type SchemaCompatibility 

type SchemaCompatibility string
const (
	SchemaCompatibilityBackward SchemaCompatibility = "Backward"
	SchemaCompatibilityForward  SchemaCompatibility = "Forward"
	SchemaCompatibilityNone     SchemaCompatibility = "None"
)

func (*SchemaCompatibility) UnmarshalJSON 

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

type SchemaGroup 

type SchemaGroup struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *SchemaGroupProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type SchemaGroupId 

type SchemaGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	SchemaGroupName   string
}

SchemaGroupId is a struct representing the Resource ID for a Schema Group

func NewSchemaGroupID 

func NewSchemaGroupID(subscriptionId string, resourceGroupName string, namespaceName string, schemaGroupName string) SchemaGroupId

NewSchemaGroupID returns a new SchemaGroupId struct

func ParseSchemaGroupID 

func ParseSchemaGroupID(input string) (*SchemaGroupId, error)

ParseSchemaGroupID parses 'input' into a SchemaGroupId

func ParseSchemaGroupIDInsensitively 

func ParseSchemaGroupIDInsensitively(input string) (*SchemaGroupId, error)

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

func (*SchemaGroupId) FromParseResult added in v0.20231127.1171502 

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

func (SchemaGroupId) ID 

func (id SchemaGroupId) ID() string

ID returns the formatted Schema Group ID

func (SchemaGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Schema Group ID

func (SchemaGroupId) String 

func (id SchemaGroupId) String() string

String returns a human-readable description of this Schema Group ID

type SchemaGroupOperationPredicate 

type SchemaGroupOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (SchemaGroupOperationPredicate) Matches 

func (p SchemaGroupOperationPredicate) Matches(input SchemaGroup) bool

type SchemaGroupProperties 

type SchemaGroupProperties struct {
	CreatedAtUtc        *string              `json:"createdAtUtc,omitempty"`
	ETag                *string              `json:"eTag,omitempty"`
	GroupProperties     *map[string]string   `json:"groupProperties,omitempty"`
	SchemaCompatibility *SchemaCompatibility `json:"schemaCompatibility,omitempty"`
	SchemaType          *SchemaType          `json:"schemaType,omitempty"`
	UpdatedAtUtc        *string              `json:"updatedAtUtc,omitempty"`
}

func (*SchemaGroupProperties) GetCreatedAtUtcAsTime 

func (o *SchemaGroupProperties) GetCreatedAtUtcAsTime() (*time.Time, error)

func (*SchemaGroupProperties) GetUpdatedAtUtcAsTime 

func (o *SchemaGroupProperties) GetUpdatedAtUtcAsTime() (*time.Time, error)

func (*SchemaGroupProperties) SetCreatedAtUtcAsTime 

func (o *SchemaGroupProperties) SetCreatedAtUtcAsTime(input time.Time)

func (*SchemaGroupProperties) SetUpdatedAtUtcAsTime 

func (o *SchemaGroupProperties) SetUpdatedAtUtcAsTime(input time.Time)

type SchemaRegistryClient 

type SchemaRegistryClient struct {
	Client *resourcemanager.Client
}

func NewSchemaRegistryClientWithBaseURI 

func NewSchemaRegistryClientWithBaseURI(sdkApi sdkEnv.Api) (*SchemaRegistryClient, error)

func (SchemaRegistryClient) CreateOrUpdate 

func (c SchemaRegistryClient) CreateOrUpdate(ctx context.Context, id SchemaGroupId, input SchemaGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SchemaRegistryClient) Delete 

func (c SchemaRegistryClient) Delete(ctx context.Context, id SchemaGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (SchemaRegistryClient) Get 

func (c SchemaRegistryClient) Get(ctx context.Context, id SchemaGroupId) (result GetOperationResponse, err error)

Get ...

func (SchemaRegistryClient) ListByNamespace 

func (c SchemaRegistryClient) ListByNamespace(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions) (result ListByNamespaceOperationResponse, err error)

ListByNamespace ...

func (SchemaRegistryClient) ListByNamespaceComplete 

func (c SchemaRegistryClient) ListByNamespaceComplete(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions) (ListByNamespaceCompleteResult, error)

ListByNamespaceComplete retrieves all the results into a single object

func (SchemaRegistryClient) ListByNamespaceCompleteMatchingPredicate 

func (c SchemaRegistryClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions, predicate SchemaGroupOperationPredicate) (result ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SchemaType 

type SchemaType string
const (
	SchemaTypeAvro    SchemaType = "Avro"
	SchemaTypeUnknown SchemaType = "Unknown"
)

func (*SchemaType) UnmarshalJSON 

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

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.