querykeys

package
v0.20221102.1171058 Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2022 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/search/2020-03-13/querykeys Documentation

The querykeys SDK allows for interaction with the Azure Resource Manager Service search (API Version 2020-03-13).

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/search/2020-03-13/querykeys"

Client Initialization

client := querykeys.NewQueryKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: QueryKeysClient.Create

ctx := context.TODO()
id := querykeys.NewCreateQueryKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "nameValue")

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

Example Usage: QueryKeysClient.Delete

ctx := context.TODO()
id := querykeys.NewDeleteQueryKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "keyValue")

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

Example Usage: QueryKeysClient.ListBySearchService

ctx := context.TODO()
id := querykeys.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

// alternatively `client.ListBySearchService(ctx, id, querykeys.DefaultListBySearchServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListBySearchServiceComplete(ctx, id, querykeys.DefaultListBySearchServiceOperationOptions())
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 ValidateCreateQueryKeyID

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

ValidateCreateQueryKeyID checks that 'input' can be parsed as a Create Query Key ID

func ValidateDeleteQueryKeyID

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

ValidateDeleteQueryKeyID checks that 'input' can be parsed as a Delete Query Key ID

func ValidateSearchServiceID

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

ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID

Types

type CreateOperationOptions

type CreateOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultCreateOperationOptions

func DefaultCreateOperationOptions() CreateOperationOptions

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *QueryKey
}

type CreateQueryKeyId

type CreateQueryKeyId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
	Name              string
}

CreateQueryKeyId is a struct representing the Resource ID for a Create Query Key

func NewCreateQueryKeyID

func NewCreateQueryKeyID(subscriptionId string, resourceGroupName string, searchServiceName string, name string) CreateQueryKeyId

NewCreateQueryKeyID returns a new CreateQueryKeyId struct

func ParseCreateQueryKeyID

func ParseCreateQueryKeyID(input string) (*CreateQueryKeyId, error)

ParseCreateQueryKeyID parses 'input' into a CreateQueryKeyId

func ParseCreateQueryKeyIDInsensitively

func ParseCreateQueryKeyIDInsensitively(input string) (*CreateQueryKeyId, error)

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

func (CreateQueryKeyId) ID

func (id CreateQueryKeyId) ID() string

ID returns the formatted Create Query Key ID

func (CreateQueryKeyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Create Query Key ID

func (CreateQueryKeyId) String

func (id CreateQueryKeyId) String() string

String returns a human-readable description of this Create Query Key ID

type DeleteOperationOptions

type DeleteOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type DeleteQueryKeyId

type DeleteQueryKeyId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
	Key               string
}

DeleteQueryKeyId is a struct representing the Resource ID for a Delete Query Key

func NewDeleteQueryKeyID

func NewDeleteQueryKeyID(subscriptionId string, resourceGroupName string, searchServiceName string, key string) DeleteQueryKeyId

NewDeleteQueryKeyID returns a new DeleteQueryKeyId struct

func ParseDeleteQueryKeyID

func ParseDeleteQueryKeyID(input string) (*DeleteQueryKeyId, error)

ParseDeleteQueryKeyID parses 'input' into a DeleteQueryKeyId

func ParseDeleteQueryKeyIDInsensitively

func ParseDeleteQueryKeyIDInsensitively(input string) (*DeleteQueryKeyId, error)

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

func (DeleteQueryKeyId) ID

func (id DeleteQueryKeyId) ID() string

ID returns the formatted Delete Query Key ID

func (DeleteQueryKeyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Delete Query Key ID

func (DeleteQueryKeyId) String

func (id DeleteQueryKeyId) String() string

String returns a human-readable description of this Delete Query Key ID

type ListBySearchServiceCompleteResult

type ListBySearchServiceCompleteResult struct {
	Items []QueryKey
}

type ListBySearchServiceOperationOptions

type ListBySearchServiceOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultListBySearchServiceOperationOptions

func DefaultListBySearchServiceOperationOptions() ListBySearchServiceOperationOptions

type ListBySearchServiceOperationResponse

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

func (ListBySearchServiceOperationResponse) HasMore

func (ListBySearchServiceOperationResponse) LoadMore

type QueryKey

type QueryKey struct {
	Key  *string `json:"key,omitempty"`
	Name *string `json:"name,omitempty"`
}

type QueryKeyOperationPredicate

type QueryKeyOperationPredicate struct {
	Key  *string
	Name *string
}

func (QueryKeyOperationPredicate) Matches

func (p QueryKeyOperationPredicate) Matches(input QueryKey) bool

type QueryKeysClient

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

func NewQueryKeysClientWithBaseURI

func NewQueryKeysClientWithBaseURI(endpoint string) QueryKeysClient

func (QueryKeysClient) Create

Create ...

func (QueryKeysClient) Delete

Delete ...

func (QueryKeysClient) ListBySearchService

ListBySearchService ...

func (QueryKeysClient) ListBySearchServiceComplete

ListBySearchServiceComplete retrieves all of the results into a single object

func (QueryKeysClient) ListBySearchServiceCompleteMatchingPredicate

func (c QueryKeysClient) ListBySearchServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, options ListBySearchServiceOperationOptions, predicate QueryKeyOperationPredicate) (resp ListBySearchServiceCompleteResult, err error)

ListBySearchServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type SearchServiceId

type SearchServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
}

SearchServiceId is a struct representing the Resource ID for a Search Service

func NewSearchServiceID

func NewSearchServiceID(subscriptionId string, resourceGroupName string, searchServiceName string) SearchServiceId

NewSearchServiceID returns a new SearchServiceId struct

func ParseSearchServiceID

func ParseSearchServiceID(input string) (*SearchServiceId, error)

ParseSearchServiceID parses 'input' into a SearchServiceId

func ParseSearchServiceIDInsensitively

func ParseSearchServiceIDInsensitively(input string) (*SearchServiceId, error)

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

func (SearchServiceId) ID

func (id SearchServiceId) ID() string

ID returns the formatted Search Service ID

func (SearchServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Search Service ID

func (SearchServiceId) String

func (id SearchServiceId) String() string

String returns a human-readable description of this Search Service ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL