healthbot

package
v52.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 26, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package healthbot implements the Azure ARM Healthbot service API version 2020-12-08.

Microsoft Healthcare Bot is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Healthbot
	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 AvailableOperations 

type AvailableOperations struct {
	autorest.Response `json:"-"`
	// Value - Collection of available operation details
	Value *[]OperationDetail `json:"value,omitempty"`
	// NextLink - URL client should use to fetch the next page (per server side paging).
	// It's null for now, added for future use.
	NextLink *string `json:"nextLink,omitempty"`
}

AvailableOperations available operations of the service

func (AvailableOperations) IsEmpty 

func (ao AvailableOperations) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AvailableOperationsIterator 

type AvailableOperationsIterator struct {
	// contains filtered or unexported fields
}

AvailableOperationsIterator provides access to a complete listing of OperationDetail values.

func NewAvailableOperationsIterator 

func NewAvailableOperationsIterator(page AvailableOperationsPage) AvailableOperationsIterator

Creates a new instance of the AvailableOperationsIterator type.

func (*AvailableOperationsIterator) Next 

func (iter *AvailableOperationsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AvailableOperationsIterator) NextWithContext 

func (iter *AvailableOperationsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AvailableOperationsIterator) NotDone 

func (iter AvailableOperationsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AvailableOperationsIterator) Response 

func (iter AvailableOperationsIterator) Response() AvailableOperations

Response returns the raw server response from the last page request.

func (AvailableOperationsIterator) Value 

func (iter AvailableOperationsIterator) Value() OperationDetail

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AvailableOperationsPage 

type AvailableOperationsPage struct {
	// contains filtered or unexported fields
}

AvailableOperationsPage contains a page of OperationDetail values.

func NewAvailableOperationsPage 

func NewAvailableOperationsPage(cur AvailableOperations, getNextPage func(context.Context, AvailableOperations) (AvailableOperations, error)) AvailableOperationsPage

Creates a new instance of the AvailableOperationsPage type.

func (*AvailableOperationsPage) Next 

func (page *AvailableOperationsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AvailableOperationsPage) NextWithContext 

func (page *AvailableOperationsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AvailableOperationsPage) NotDone 

func (page AvailableOperationsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AvailableOperationsPage) Response 

func (page AvailableOperationsPage) Response() AvailableOperations

Response returns the raw server response from the last page request.

func (AvailableOperationsPage) Values 

func (page AvailableOperationsPage) Values() []OperationDetail

Values returns the slice of values for the current page or nil if there are no values.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Healthbot.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BotResponseList 

type BotResponseList struct {
	autorest.Response `json:"-"`
	// NextLink - READ-ONLY; The link used to get the next page of bot service resources.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; Gets the list of Healthbot results and their properties.
	Value *[]HealthBot `json:"value,omitempty"`
}

BotResponseList the list of Healthbot operation response.

func (BotResponseList) IsEmpty 

func (brl BotResponseList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BotResponseListIterator 

type BotResponseListIterator struct {
	// contains filtered or unexported fields
}

BotResponseListIterator provides access to a complete listing of HealthBot values.

func NewBotResponseListIterator 

func NewBotResponseListIterator(page BotResponseListPage) BotResponseListIterator

Creates a new instance of the BotResponseListIterator type.

func (*BotResponseListIterator) Next 

func (iter *BotResponseListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*BotResponseListIterator) NextWithContext 

func (iter *BotResponseListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (BotResponseListIterator) NotDone 

func (iter BotResponseListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (BotResponseListIterator) Response 

func (iter BotResponseListIterator) Response() BotResponseList

Response returns the raw server response from the last page request.

func (BotResponseListIterator) Value 

func (iter BotResponseListIterator) Value() HealthBot

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type BotResponseListPage 

type BotResponseListPage struct {
	// contains filtered or unexported fields
}

BotResponseListPage contains a page of HealthBot values.

func NewBotResponseListPage 

func NewBotResponseListPage(cur BotResponseList, getNextPage func(context.Context, BotResponseList) (BotResponseList, error)) BotResponseListPage

Creates a new instance of the BotResponseListPage type.

func (*BotResponseListPage) Next 

func (page *BotResponseListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*BotResponseListPage) NextWithContext 

func (page *BotResponseListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (BotResponseListPage) NotDone 

func (page BotResponseListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (BotResponseListPage) Response 

func (page BotResponseListPage) Response() BotResponseList

Response returns the raw server response from the last page request.

func (BotResponseListPage) Values 

func (page BotResponseListPage) Values() []HealthBot

Values returns the slice of values for the current page or nil if there are no values.

type BotsClient 

type BotsClient struct {
	BaseClient
}

BotsClient is the microsoft Healthcare Bot is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.

func NewBotsClient 

func NewBotsClient(subscriptionID string) BotsClient

NewBotsClient creates an instance of the BotsClient client.

func NewBotsClientWithBaseURI 

func NewBotsClientWithBaseURI(baseURI string, subscriptionID string) BotsClient

NewBotsClientWithBaseURI creates an instance of the BotsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BotsClient) Create 

func (client BotsClient) Create(ctx context.Context, resourceGroupName string, botName string, parameters HealthBot) (result BotsCreateFuture, err error)

Create create a new HealthBot. Parameters: resourceGroupName - the name of the Bot resource group in the user subscription. botName - the name of the Bot resource. parameters - the parameters to provide for the created bot.

func (BotsClient) CreatePreparer 

func (client BotsClient) CreatePreparer(ctx context.Context, resourceGroupName string, botName string, parameters HealthBot) (*http.Request, error)

CreatePreparer prepares the Create request.

func (BotsClient) CreateResponder 

func (client BotsClient) CreateResponder(resp *http.Response) (result HealthBot, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (BotsClient) CreateSender 

func (client BotsClient) CreateSender(req *http.Request) (future BotsCreateFuture, err error)

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

func (BotsClient) Delete 

func (client BotsClient) Delete(ctx context.Context, resourceGroupName string, botName string) (result BotsDeleteFuture, err error)

Delete delete a HealthBot. Parameters: resourceGroupName - the name of the Bot resource group in the user subscription. botName - the name of the Bot resource.

func (BotsClient) DeletePreparer 

func (client BotsClient) DeletePreparer(ctx context.Context, resourceGroupName string, botName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BotsClient) DeleteResponder 

func (client BotsClient) 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 (BotsClient) DeleteSender 

func (client BotsClient) DeleteSender(req *http.Request) (future BotsDeleteFuture, err error)

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

func (BotsClient) Get 

func (client BotsClient) Get(ctx context.Context, resourceGroupName string, botName string) (result HealthBot, err error)

Get get a HealthBot. Parameters: resourceGroupName - the name of the Bot resource group in the user subscription. botName - the name of the Bot resource.

func (BotsClient) GetPreparer 

func (client BotsClient) GetPreparer(ctx context.Context, resourceGroupName string, botName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BotsClient) GetResponder 

func (client BotsClient) GetResponder(resp *http.Response) (result HealthBot, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (BotsClient) GetSender 

func (client BotsClient) GetSender(req *http.Request) (*http.Response, error)

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

func (BotsClient) List 

func (client BotsClient) List(ctx context.Context) (result BotResponseListPage, err error)

List returns all the resources of a particular type belonging to a subscription.

func (BotsClient) ListByResourceGroup 

func (client BotsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result BotResponseListPage, err error)

ListByResourceGroup returns all the resources of a particular type belonging to a resource group Parameters: resourceGroupName - the name of the Bot resource group in the user subscription.

func (BotsClient) ListByResourceGroupComplete 

func (client BotsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result BotResponseListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (BotsClient) ListByResourceGroupPreparer 

func (client BotsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (BotsClient) ListByResourceGroupResponder 

func (client BotsClient) ListByResourceGroupResponder(resp *http.Response) (result BotResponseList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (BotsClient) ListByResourceGroupSender 

func (client BotsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (BotsClient) ListComplete 

func (client BotsClient) ListComplete(ctx context.Context) (result BotResponseListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (BotsClient) ListPreparer 

func (client BotsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (BotsClient) ListResponder 

func (client BotsClient) ListResponder(resp *http.Response) (result BotResponseList, err error)

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

func (BotsClient) ListSender 

func (client BotsClient) 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.

func (BotsClient) Update 

func (client BotsClient) Update(ctx context.Context, resourceGroupName string, botName string, parameters UpdateParameters) (result HealthBot, err error)

Update patch a HealthBot. Parameters: resourceGroupName - the name of the Bot resource group in the user subscription. botName - the name of the Bot resource. parameters - the parameters to provide for the required bot.

func (BotsClient) UpdatePreparer 

func (client BotsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, botName string, parameters UpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (BotsClient) UpdateResponder 

func (client BotsClient) UpdateResponder(resp *http.Response) (result HealthBot, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (BotsClient) UpdateSender 

func (client BotsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type BotsCreateFuture 

type BotsCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(BotsClient) (HealthBot, error)
}

BotsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type BotsDeleteFuture 

type BotsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(BotsClient) (autorest.Response, error)
}

BotsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type Error 

type Error struct {
	// Error - The error object.
	Error *ErrorError `json:"error,omitempty"`
}

Error the resource management error response.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

type ErrorError 

type ErrorError struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]Error `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorError the error object.

type HealthBot 

type HealthBot struct {
	autorest.Response `json:"-"`
	// Sku - SKU of the HealthBot.
	Sku *Sku `json:"sku,omitempty"`
	// Properties - The set of properties specific to Healthbot resource.
	Properties *Properties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,omitempty"`
}

HealthBot healthBot resource definition

func (HealthBot) MarshalJSON 

func (hb HealthBot) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HealthBot.

type IdentityType 

type IdentityType string

IdentityType enumerates the values for identity type. 

const (
	// Application ...
	Application IdentityType = "Application"
	// Key ...
	Key IdentityType = "Key"
	// ManagedIdentity ...
	ManagedIdentity IdentityType = "ManagedIdentity"
	// User ...
	User IdentityType = "User"
)

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.

type OperationDetail 

type OperationDetail struct {
	// Name - Name of the operation
	Name *string `json:"name,omitempty"`
	// IsDataAction - Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - Origin of the operation
	Origin *string `json:"origin,omitempty"`
	// Properties - Additional properties.
	Properties interface{} `json:"properties,omitempty"`
}

OperationDetail operation detail payload

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Resource provider of the operation
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource of the operation
	Resource *string `json:"resource,omitempty"`
	// Operation - Localized friendly name for the operation
	Operation *string `json:"operation,omitempty"`
	// Description - Localized friendly description for the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay operation display payload

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the microsoft Healthcare Bot is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result AvailableOperationsPage, err error)

List lists all the available HealthBot operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result AvailableOperationsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result AvailableOperations, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 Properties 

type Properties struct {
	// ProvisioningState - READ-ONLY; The provisioning state of the Healthbot resource.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// BotManagementPortalLink - READ-ONLY; The link.
	BotManagementPortalLink *string `json:"botManagementPortalLink,omitempty"`
}

Properties the properties of a HealthBot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,omitempty"`
}

Resource the resource model definition for a ARM tracked top level resource

type Sku 

type Sku struct {
	// Name - The name of the HealthBot SKU. Possible values include: 'F0', 'S1', 'C0'
	Name SkuName `json:"name,omitempty"`
}

Sku the resource model definition representing SKU

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// C0 ...
	C0 SkuName = "C0"
	// F0 ...
	F0 SkuName = "F0"
	// S1 ...
	S1 SkuName = "S1"
)

func PossibleSkuNameValues 

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	CreatedByType IdentityType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC)
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	LastModifiedByType IdentityType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData read only system data

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateParameters 

type UpdateParameters struct {
	// Tags - Tags for a HealthBot.
	Tags map[string]*string `json:"tags"`
	// Sku - SKU of the HealthBot.
	Sku *Sku `json:"sku,omitempty"`
}

UpdateParameters parameters for updating a HealthBot.

func (UpdateParameters) MarshalJSON 

func (up UpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateParameters.

type ValidationResult 

type ValidationResult struct {
	// Status - The status code of the response validation.
	Status *string `json:"status,omitempty"`
}

ValidationResult the response returned from validation process

Source Files

View all Source files

Directories

Path Synopsis

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.