search

package
v5.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2016 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package search implements the Azure ARM Search service API version 2015-02-28.

Client that can be used to manage Azure Search services and API keys.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Search
	APIVersion = "2015-02-28"

	// DefaultBaseURI is the default URI used for the service Search
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AdminKeyResult 

type AdminKeyResult struct {
	autorest.Response `json:"-"`
	PrimaryKey        *string `json:"primaryKey,omitempty"`
	SecondaryKey      *string `json:"secondaryKey,omitempty"`
}

AdminKeyResult is response containing the primary and secondary API keys for a given Azure Search service.

type AdminKeysClient 

type AdminKeysClient struct {
	ManagementClient
}

AdminKeysClient is the client that can be used to manage Azure Search services and API keys.

func NewAdminKeysClient 

func NewAdminKeysClient(subscriptionID string) AdminKeysClient

NewAdminKeysClient creates an instance of the AdminKeysClient client.

func NewAdminKeysClientWithBaseURI 

func NewAdminKeysClientWithBaseURI(baseURI string, subscriptionID string) AdminKeysClient

NewAdminKeysClientWithBaseURI creates an instance of the AdminKeysClient client.

func (AdminKeysClient) List 

func (client AdminKeysClient) List(resourceGroupName string, serviceName string) (result AdminKeyResult, err error)

List returns the primary and secondary API keys for the given Azure Search service.

resourceGroupName is the name of the resource group within the current subscription. serviceName is the name of the Search service for which to list admin keys.

func (AdminKeysClient) ListPreparer 

func (client AdminKeysClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AdminKeysClient) ListResponder 

func (client AdminKeysClient) ListResponder(resp *http.Response) (result AdminKeyResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AdminKeysClient) ListSender 

func (client AdminKeysClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ListQueryKeysResult 

type ListQueryKeysResult struct {
	autorest.Response `json:"-"`
	Value             *[]QueryKey `json:"value,omitempty"`
}

ListQueryKeysResult is response containing the query API keys for a given Azure Search service.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Search.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Failed specifies the failed state for provisioning state.
	Failed ProvisioningState = "failed"
	// Provisioning specifies the provisioning state for provisioning state.
	Provisioning ProvisioningState = "provisioning"
	// Succeeded specifies the succeeded state for provisioning state.
	Succeeded ProvisioningState = "succeeded"
)

type QueryKey 

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

QueryKey is describes an API key for a given Azure Search service that has permissions for query operations only.

type QueryKeysClient 

type QueryKeysClient struct {
	ManagementClient
}

QueryKeysClient is the client that can be used to manage Azure Search services and API keys.

func NewQueryKeysClient 

func NewQueryKeysClient(subscriptionID string) QueryKeysClient

NewQueryKeysClient creates an instance of the QueryKeysClient client.

func NewQueryKeysClientWithBaseURI 

func NewQueryKeysClientWithBaseURI(baseURI string, subscriptionID string) QueryKeysClient

NewQueryKeysClientWithBaseURI creates an instance of the QueryKeysClient client.

func (QueryKeysClient) List 

func (client QueryKeysClient) List(resourceGroupName string, serviceName string) (result ListQueryKeysResult, err error)

List returns the list of query API keys for the given Azure Search service.

resourceGroupName is the name of the resource group within the current subscription. serviceName is the name of the Search service for which to list query keys.

func (QueryKeysClient) ListPreparer 

func (client QueryKeysClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (QueryKeysClient) ListResponder 

func (client QueryKeysClient) ListResponder(resp *http.Response) (result ListQueryKeysResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (QueryKeysClient) ListSender 

func (client QueryKeysClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Resource 

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

Resource is

type ServiceCreateOrUpdateParameters 

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

ServiceCreateOrUpdateParameters is properties that describe an Azure Search service.

type ServiceListResult 

type ServiceListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ServiceResource `json:"value,omitempty"`
}

ServiceListResult is response containing a list of Azure Search services for a given resource group.

type ServiceProperties 

type ServiceProperties struct {
	Sku            *Sku   `json:"sku,omitempty"`
	ReplicaCount   *int32 `json:"replicaCount,omitempty"`
	PartitionCount *int32 `json:"partitionCount,omitempty"`
}

ServiceProperties is defines properties of an Azure Search service that can be modified.

type ServiceReadableProperties 

type ServiceReadableProperties struct {
	Status            ServiceStatus     `json:"status,omitempty"`
	StatusDetails     *string           `json:"statusDetails,omitempty"`
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	Sku               *Sku              `json:"sku,omitempty"`
	ReplicaCount      *int32            `json:"replicaCount,omitempty"`
	PartitionCount    *int32            `json:"partitionCount,omitempty"`
}

ServiceReadableProperties is defines all the properties of an Azure Search service.

type ServiceResource 

type ServiceResource struct {
	autorest.Response `json:"-"`
	ID                *string                    `json:"id,omitempty"`
	Name              *string                    `json:"name,omitempty"`
	Location          *string                    `json:"location,omitempty"`
	Tags              *map[string]*string        `json:"tags,omitempty"`
	Properties        *ServiceReadableProperties `json:"properties,omitempty"`
}

ServiceResource is describes an Azure Search service and its current state.

type ServiceStatus 

type ServiceStatus string

ServiceStatus enumerates the values for service status. 

const (
	// ServiceStatusDegraded specifies the service status degraded state for
	// service status.
	ServiceStatusDegraded ServiceStatus = "degraded"
	// ServiceStatusDeleting specifies the service status deleting state for
	// service status.
	ServiceStatusDeleting ServiceStatus = "deleting"
	// ServiceStatusDisabled specifies the service status disabled state for
	// service status.
	ServiceStatusDisabled ServiceStatus = "disabled"
	// ServiceStatusError specifies the service status error state for service
	// status.
	ServiceStatusError ServiceStatus = "error"
	// ServiceStatusProvisioning specifies the service status provisioning
	// state for service status.
	ServiceStatusProvisioning ServiceStatus = "provisioning"
	// ServiceStatusRunning specifies the service status running state for
	// service status.
	ServiceStatusRunning ServiceStatus = "running"
)

type ServicesClient 

type ServicesClient struct {
	ManagementClient
}

ServicesClient is the client that can be used to manage Azure Search services and API keys.

func NewServicesClient 

func NewServicesClient(subscriptionID string) ServicesClient

NewServicesClient creates an instance of the ServicesClient client.

func NewServicesClientWithBaseURI 

func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient

NewServicesClientWithBaseURI creates an instance of the ServicesClient client.

func (ServicesClient) CreateOrUpdate 

func (client ServicesClient) CreateOrUpdate(resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (result ServiceResource, err error)

CreateOrUpdate creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.

resourceGroupName is the name of the resource group within the current subscription. serviceName is the name of the Search service to create or update. parameters is the properties to set or update on the Search service.

func (ServicesClient) CreateOrUpdatePreparer 

func (client ServicesClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServicesClient) CreateOrUpdateResponder 

func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ServicesClient) CreateOrUpdateSender 

func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) Delete 

func (client ServicesClient) Delete(resourceGroupName string, serviceName string) (result autorest.Response, err error)

Delete deletes a Search service in the given resource group, along with its associated resources.

resourceGroupName is the name of the resource group within the current subscription. serviceName is the name of the Search service to delete.

func (ServicesClient) DeletePreparer 

func (client ServicesClient) DeletePreparer(resourceGroupName string, serviceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServicesClient) DeleteResponder 

func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ServicesClient) DeleteSender 

func (client ServicesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) List 

func (client ServicesClient) List(resourceGroupName string) (result ServiceListResult, err error)

List returns a list of all Search services in the given resource group.

resourceGroupName is the name of the resource group within the current subscription.

func (ServicesClient) ListPreparer 

func (client ServicesClient) ListPreparer(resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServicesClient) ListResponder 

func (client ServicesClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ServicesClient) ListSender 

func (client ServicesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Sku 

type Sku struct {
	Name SkuType `json:"name,omitempty"`
}

Sku is defines the SKU of an Azure Search Service, which determines price tier and capacity limits.

type SkuType 

type SkuType string

SkuType enumerates the values for sku type. 

const (
	// Free specifies the free state for sku type.
	Free SkuType = "free"
	// Standard specifies the standard state for sku type.
	Standard SkuType = "standard"
	// Standard2 specifies the standard 2 state for sku type.
	Standard2 SkuType = "standard2"
)

type SubResource 

type SubResource struct {
	ID *string `json:"id,omitempty"`
}

SubResource is

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.