cloudantv1

package
v0.7.5 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 12 Imported by: 9

Documentation

Overview

Package cloudantv1 : Operations and models for the CloudantV1 service

Index

Constants

View Source 
const (
	ActiveTaskPhaseDocidCopyConst    = "docid_copy"
	ActiveTaskPhaseDocidSortConst    = "docid_sort"
	ActiveTaskPhaseDocumentCopyConst = "document_copy"
	ActiveTaskPhaseIdsConst          = "ids"
	ActiveTaskPhaseViewConst         = "view"
)

Constants associated with the ActiveTask.Phase property. The phase the active task is in. `docid_sort`, `docid_copy`, `document_copy` phases are available for `database_compaction`, while `ids` and `view` phases are available for `view_compaction` type tasks.

View Source 
const (
	ActiveTaskProcessStatusExitingConst           = "exiting"
	ActiveTaskProcessStatusGarbageCollectingConst = "garbage_collecting"
	ActiveTaskProcessStatusRunnableConst          = "runnable"
	ActiveTaskProcessStatusRunningConst           = "running"
	ActiveTaskProcessStatusSuspendedConst         = "suspended"
	ActiveTaskProcessStatusWaitingConst           = "waiting"
)

Constants associated with the ActiveTask.ProcessStatus property. Process status.

View Source 
const (
	ActiveTaskTypeDatabaseCompactionConst = "database_compaction"
	ActiveTaskTypeIndexerConst            = "indexer"
	ActiveTaskTypeReplicationConst        = "replication"
	ActiveTaskTypeSearchIndexerConst      = "search_indexer"
	ActiveTaskTypeViewCompactionConst     = "view_compaction"
)

Constants associated with the ActiveTask.Type property. Operation type.

View Source 
const (
	ActivityTrackerEventsTypesDataConst       = "data"
	ActivityTrackerEventsTypesManagementConst = "management"
)

Constants associated with the ActivityTrackerEvents.Types property.

View Source 
const (
	AnalyzerNameArabicConst     = "arabic"
	AnalyzerNameArmenianConst   = "armenian"
	AnalyzerNameBasqueConst     = "basque"
	AnalyzerNameBrazilianConst  = "brazilian"
	AnalyzerNameBulgarianConst  = "bulgarian"
	AnalyzerNameCatalanConst    = "catalan"
	AnalyzerNameChineseConst    = "chinese"
	AnalyzerNameCjkConst        = "cjk"
	AnalyzerNameClassicConst    = "classic"
	AnalyzerNameCzechConst      = "czech"
	AnalyzerNameDanishConst     = "danish"
	AnalyzerNameDutchConst      = "dutch"
	AnalyzerNameEmailConst      = "email"
	AnalyzerNameEnglishConst    = "english"
	AnalyzerNameFinnishConst    = "finnish"
	AnalyzerNameFrenchConst     = "french"
	AnalyzerNameGalicianConst   = "galician"
	AnalyzerNameGermanConst     = "german"
	AnalyzerNameGreekConst      = "greek"
	AnalyzerNameHindiConst      = "hindi"
	AnalyzerNameHungarianConst  = "hungarian"
	AnalyzerNameIndonesianConst = "indonesian"
	AnalyzerNameIrishConst      = "irish"
	AnalyzerNameItalianConst    = "italian"
	AnalyzerNameJapaneseConst   = "japanese"
	AnalyzerNameKeywordConst    = "keyword"
	AnalyzerNameLatvianConst    = "latvian"
	AnalyzerNameNorwegianConst  = "norwegian"
	AnalyzerNamePerfieldConst   = "perfield"
	AnalyzerNamePersianConst    = "persian"
	AnalyzerNamePolishConst     = "polish"
	AnalyzerNamePortugueseConst = "portuguese"
	AnalyzerNameRomanianConst   = "romanian"
	AnalyzerNameRussianConst    = "russian"
	AnalyzerNameSimpleConst     = "simple"
	AnalyzerNameSpanishConst    = "spanish"
	AnalyzerNameStandardConst   = "standard"
	AnalyzerNameSwedishConst    = "swedish"
	AnalyzerNameThaiConst       = "thai"
	AnalyzerNameTurkishConst    = "turkish"
	AnalyzerNameWhitespaceConst = "whitespace"
)

Constants associated with the Analyzer.Name property. Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is `standard` * For query text indexes the default is `keyword` * For a query text index default_field the default is `standard`.

View Source 
const (
	AnalyzerConfigurationNameArabicConst     = "arabic"
	AnalyzerConfigurationNameArmenianConst   = "armenian"
	AnalyzerConfigurationNameBasqueConst     = "basque"
	AnalyzerConfigurationNameBrazilianConst  = "brazilian"
	AnalyzerConfigurationNameBulgarianConst  = "bulgarian"
	AnalyzerConfigurationNameCatalanConst    = "catalan"
	AnalyzerConfigurationNameChineseConst    = "chinese"
	AnalyzerConfigurationNameCjkConst        = "cjk"
	AnalyzerConfigurationNameClassicConst    = "classic"
	AnalyzerConfigurationNameCzechConst      = "czech"
	AnalyzerConfigurationNameDanishConst     = "danish"
	AnalyzerConfigurationNameDutchConst      = "dutch"
	AnalyzerConfigurationNameEmailConst      = "email"
	AnalyzerConfigurationNameEnglishConst    = "english"
	AnalyzerConfigurationNameFinnishConst    = "finnish"
	AnalyzerConfigurationNameFrenchConst     = "french"
	AnalyzerConfigurationNameGalicianConst   = "galician"
	AnalyzerConfigurationNameGermanConst     = "german"
	AnalyzerConfigurationNameGreekConst      = "greek"
	AnalyzerConfigurationNameHindiConst      = "hindi"
	AnalyzerConfigurationNameHungarianConst  = "hungarian"
	AnalyzerConfigurationNameIndonesianConst = "indonesian"
	AnalyzerConfigurationNameIrishConst      = "irish"
	AnalyzerConfigurationNameItalianConst    = "italian"
	AnalyzerConfigurationNameJapaneseConst   = "japanese"
	AnalyzerConfigurationNameKeywordConst    = "keyword"
	AnalyzerConfigurationNameLatvianConst    = "latvian"
	AnalyzerConfigurationNameNorwegianConst  = "norwegian"
	AnalyzerConfigurationNamePerfieldConst   = "perfield"
	AnalyzerConfigurationNamePersianConst    = "persian"
	AnalyzerConfigurationNamePolishConst     = "polish"
	AnalyzerConfigurationNamePortugueseConst = "portuguese"
	AnalyzerConfigurationNameRomanianConst   = "romanian"
	AnalyzerConfigurationNameRussianConst    = "russian"
	AnalyzerConfigurationNameSimpleConst     = "simple"
	AnalyzerConfigurationNameSpanishConst    = "spanish"
	AnalyzerConfigurationNameStandardConst   = "standard"
	AnalyzerConfigurationNameSwedishConst    = "swedish"
	AnalyzerConfigurationNameThaiConst       = "thai"
	AnalyzerConfigurationNameTurkishConst    = "turkish"
	AnalyzerConfigurationNameWhitespaceConst = "whitespace"
)

Constants associated with the AnalyzerConfiguration.Name property. Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is `standard` * For query text indexes the default is `keyword` * For a query text index default_field the default is `standard`.

View Source 
const (
	DbEventTypeCreatedConst = "created"
	DbEventTypeDeletedConst = "deleted"
	DbEventTypeUpdatedConst = "updated"
)

Constants associated with the DbEvent.Type property. A database event.

View Source 
const (
	DeleteIndexOptionsTypeJSONConst    = "json"
	DeleteIndexOptionsTypeSpecialConst = "special"
	DeleteIndexOptionsTypeTextConst    = "text"
)

Constants associated with the DeleteIndexOptions.Type property. Path parameter to specify the index type.

View Source 
const (
	DocumentRevisionStatusStatusAvailableConst = "available"
	DocumentRevisionStatusStatusDeletedConst   = "deleted"
	DocumentRevisionStatusStatusMissingConst   = "missing"
)

Constants associated with the DocumentRevisionStatus.Status property. Status of the revision. May be one of: - `available`: Revision is available for retrieving with rev query parameter - `missing`: Revision is not available - `deleted`: Revision belongs to deleted document.

View Source 
const (
	ExplainResultMrArgsViewTypeMapConst    = "map"
	ExplainResultMrArgsViewTypeReduceConst = "reduce"
)

Constants associated with the ExplainResultMrArgs.ViewType property. The type of the underlying view.

View Source 
const (
	GetDbUpdatesOptionsFeedContinuousConst  = "continuous"
	GetDbUpdatesOptionsFeedEventsourceConst = "eventsource"
	GetDbUpdatesOptionsFeedLongpollConst    = "longpoll"
	GetDbUpdatesOptionsFeedNormalConst      = "normal"
)

Constants associated with the GetDbUpdatesOptions.Feed property. Query parameter to specify the changes feed type.

View Source 
const (
	GetSchedulerDocsOptionsStatesCompletedConst    = "completed"
	GetSchedulerDocsOptionsStatesCrashingConst     = "crashing"
	GetSchedulerDocsOptionsStatesErrorConst        = "error"
	GetSchedulerDocsOptionsStatesFailedConst       = "failed"
	GetSchedulerDocsOptionsStatesInitializingConst = "initializing"
	GetSchedulerDocsOptionsStatesPendingConst      = "pending"
	GetSchedulerDocsOptionsStatesRunningConst      = "running"
)

Constants associated with the GetSchedulerDocsOptions.States property. Schema for replication state.

View Source 
const (
	IndexFieldTypeBooleanConst = "boolean"
	IndexFieldTypeNumberConst  = "number"
	IndexFieldTypeStringConst  = "string"
)

Constants associated with the IndexField.Type property. The type of the named field.

View Source 
const (
	IndexInformationTypeJSONConst    = "json"
	IndexInformationTypeSpecialConst = "special"
	IndexInformationTypeTextConst    = "text"
)

Constants associated with the IndexInformation.Type property. Schema for the type of an index.

View Source 
const (
	IndexResultResultCreatedConst = "created"
	IndexResultResultExistsConst  = "exists"
)

Constants associated with the IndexResult.Result property. Flag to show whether the index was created or one already exists.

View Source 
const (
	PostActivityTrackerEventsOptionsTypesDataConst       = "data"
	PostActivityTrackerEventsOptionsTypesManagementConst = "management"
)

Constants associated with the PostActivityTrackerEventsOptions.Types property.

View Source 
const (
	PostChangesOptionsFeedContinuousConst  = "continuous"
	PostChangesOptionsFeedEventsourceConst = "eventsource"
	PostChangesOptionsFeedLongpollConst    = "longpoll"
	PostChangesOptionsFeedNormalConst      = "normal"
)

Constants associated with the PostChangesOptions.Feed property. Query parameter to specify the changes feed type.

View Source 
const (
	PostExplainOptionsSortAscConst  = "asc"
	PostExplainOptionsSortDescConst = "desc"
)

Constants associated with the PostExplainOptions.Sort property. Schema for a mapping of field name to sort direction.

View Source 
const (
	PostExplainOptionsUpdateFalseConst = "false"
	PostExplainOptionsUpdateLazyConst  = "lazy"
	PostExplainOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostExplainOptions.Update property. Whether to update the index prior to returning the result.

View Source 
const (
	PostFindOptionsSortAscConst  = "asc"
	PostFindOptionsSortDescConst = "desc"
)

Constants associated with the PostFindOptions.Sort property. Schema for a mapping of field name to sort direction.

View Source 
const (
	PostFindOptionsUpdateFalseConst = "false"
	PostFindOptionsUpdateLazyConst  = "lazy"
	PostFindOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostFindOptions.Update property. Whether to update the index prior to returning the result.

View Source 
const (
	PostIndexOptionsTypeJSONConst    = "json"
	PostIndexOptionsTypeSpecialConst = "special"
	PostIndexOptionsTypeTextConst    = "text"
)

Constants associated with the PostIndexOptions.Type property. Schema for the type of an index.

View Source 
const (
	PostPartitionExplainOptionsSortAscConst  = "asc"
	PostPartitionExplainOptionsSortDescConst = "desc"
)

Constants associated with the PostPartitionExplainOptions.Sort property. Schema for a mapping of field name to sort direction.

View Source 
const (
	PostPartitionExplainOptionsUpdateFalseConst = "false"
	PostPartitionExplainOptionsUpdateLazyConst  = "lazy"
	PostPartitionExplainOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostPartitionExplainOptions.Update property. Whether to update the index prior to returning the result.

View Source 
const (
	PostPartitionFindOptionsSortAscConst  = "asc"
	PostPartitionFindOptionsSortDescConst = "desc"
)

Constants associated with the PostPartitionFindOptions.Sort property. Schema for a mapping of field name to sort direction.

View Source 
const (
	PostPartitionFindOptionsUpdateFalseConst = "false"
	PostPartitionFindOptionsUpdateLazyConst  = "lazy"
	PostPartitionFindOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostPartitionFindOptions.Update property. Whether to update the index prior to returning the result.

View Source 
const (
	PostPartitionViewOptionsUpdateFalseConst = "false"
	PostPartitionViewOptionsUpdateLazyConst  = "lazy"
	PostPartitionViewOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostPartitionViewOptions.Update property. Parameter to specify whether or not the view in question should be updated prior to responding to the user.

* `true` - Return results after the view is updated. * `false` - Return results without updating the view. * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.

View Source 
const (
	PostSearchAnalyzeOptionsAnalyzerArabicConst     = "arabic"
	PostSearchAnalyzeOptionsAnalyzerArmenianConst   = "armenian"
	PostSearchAnalyzeOptionsAnalyzerBasqueConst     = "basque"
	PostSearchAnalyzeOptionsAnalyzerBrazilianConst  = "brazilian"
	PostSearchAnalyzeOptionsAnalyzerBulgarianConst  = "bulgarian"
	PostSearchAnalyzeOptionsAnalyzerCatalanConst    = "catalan"
	PostSearchAnalyzeOptionsAnalyzerChineseConst    = "chinese"
	PostSearchAnalyzeOptionsAnalyzerCjkConst        = "cjk"
	PostSearchAnalyzeOptionsAnalyzerClassicConst    = "classic"
	PostSearchAnalyzeOptionsAnalyzerCzechConst      = "czech"
	PostSearchAnalyzeOptionsAnalyzerDanishConst     = "danish"
	PostSearchAnalyzeOptionsAnalyzerDutchConst      = "dutch"
	PostSearchAnalyzeOptionsAnalyzerEmailConst      = "email"
	PostSearchAnalyzeOptionsAnalyzerEnglishConst    = "english"
	PostSearchAnalyzeOptionsAnalyzerFinnishConst    = "finnish"
	PostSearchAnalyzeOptionsAnalyzerFrenchConst     = "french"
	PostSearchAnalyzeOptionsAnalyzerGalicianConst   = "galician"
	PostSearchAnalyzeOptionsAnalyzerGermanConst     = "german"
	PostSearchAnalyzeOptionsAnalyzerGreekConst      = "greek"
	PostSearchAnalyzeOptionsAnalyzerHindiConst      = "hindi"
	PostSearchAnalyzeOptionsAnalyzerHungarianConst  = "hungarian"
	PostSearchAnalyzeOptionsAnalyzerIndonesianConst = "indonesian"
	PostSearchAnalyzeOptionsAnalyzerIrishConst      = "irish"
	PostSearchAnalyzeOptionsAnalyzerItalianConst    = "italian"
	PostSearchAnalyzeOptionsAnalyzerJapaneseConst   = "japanese"
	PostSearchAnalyzeOptionsAnalyzerKeywordConst    = "keyword"
	PostSearchAnalyzeOptionsAnalyzerLatvianConst    = "latvian"
	PostSearchAnalyzeOptionsAnalyzerNorwegianConst  = "norwegian"
	PostSearchAnalyzeOptionsAnalyzerPersianConst    = "persian"
	PostSearchAnalyzeOptionsAnalyzerPolishConst     = "polish"
	PostSearchAnalyzeOptionsAnalyzerPortugueseConst = "portuguese"
	PostSearchAnalyzeOptionsAnalyzerRomanianConst   = "romanian"
	PostSearchAnalyzeOptionsAnalyzerRussianConst    = "russian"
	PostSearchAnalyzeOptionsAnalyzerSimpleConst     = "simple"
	PostSearchAnalyzeOptionsAnalyzerSpanishConst    = "spanish"
	PostSearchAnalyzeOptionsAnalyzerStandardConst   = "standard"
	PostSearchAnalyzeOptionsAnalyzerSwedishConst    = "swedish"
	PostSearchAnalyzeOptionsAnalyzerThaiConst       = "thai"
	PostSearchAnalyzeOptionsAnalyzerTurkishConst    = "turkish"
	PostSearchAnalyzeOptionsAnalyzerWhitespaceConst = "whitespace"
)

Constants associated with the PostSearchAnalyzeOptions.Analyzer property. The analyzer type that is being used at the tokenization.

View Source 
const (
	PostViewOptionsUpdateFalseConst = "false"
	PostViewOptionsUpdateLazyConst  = "lazy"
	PostViewOptionsUpdateTrueConst  = "true"
)

Constants associated with the PostViewOptions.Update property. Parameter to specify whether or not the view in question should be updated prior to responding to the user.

* `true` - Return results after the view is updated. * `false` - Return results without updating the view. * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.

View Source 
const (
	PutCloudantSecurityConfigurationOptionsCloudantAdminConst      = "_admin"
	PutCloudantSecurityConfigurationOptionsCloudantDbUpdatesConst  = "_db_updates"
	PutCloudantSecurityConfigurationOptionsCloudantDesignConst     = "_design"
	PutCloudantSecurityConfigurationOptionsCloudantReaderConst     = "_reader"
	PutCloudantSecurityConfigurationOptionsCloudantReplicatorConst = "_replicator"
	PutCloudantSecurityConfigurationOptionsCloudantSecurityConst   = "_security"
	PutCloudantSecurityConfigurationOptionsCloudantShardsConst     = "_shards"
	PutCloudantSecurityConfigurationOptionsCloudantWriterConst     = "_writer"
)

Constants associated with the PutCloudantSecurityConfigurationOptions.Cloudant property. Database permissions for Cloudant users and/or API keys.

View Source 
const (
	PutSecurityOptionsCloudantAdminConst      = "_admin"
	PutSecurityOptionsCloudantDbUpdatesConst  = "_db_updates"
	PutSecurityOptionsCloudantDesignConst     = "_design"
	PutSecurityOptionsCloudantReaderConst     = "_reader"
	PutSecurityOptionsCloudantReplicatorConst = "_replicator"
	PutSecurityOptionsCloudantSecurityConst   = "_security"
	PutSecurityOptionsCloudantShardsConst     = "_shards"
	PutSecurityOptionsCloudantWriterConst     = "_writer"
)

Constants associated with the PutSecurityOptions.Cloudant property. Database permissions for Cloudant users and/or API keys.

View Source 
const (
	SchedulerDocumentStateCompletedConst    = "completed"
	SchedulerDocumentStateCrashingConst     = "crashing"
	SchedulerDocumentStateErrorConst        = "error"
	SchedulerDocumentStateFailedConst       = "failed"
	SchedulerDocumentStateInitializingConst = "initializing"
	SchedulerDocumentStatePendingConst      = "pending"
	SchedulerDocumentStateRunningConst      = "running"
)

Constants associated with the SchedulerDocument.State property. Schema for replication state.

View Source 
const (
	SecurityCloudantAdminConst      = "_admin"
	SecurityCloudantDbUpdatesConst  = "_db_updates"
	SecurityCloudantDesignConst     = "_design"
	SecurityCloudantReaderConst     = "_reader"
	SecurityCloudantReplicatorConst = "_replicator"
	SecurityCloudantSecurityConst   = "_security"
	SecurityCloudantShardsConst     = "_shards"
	SecurityCloudantWriterConst     = "_writer"
)

Constants associated with the Security.Cloudant property. Database permissions for Cloudant users and/or API keys.

View Source 
const (
	UpInformationStatusMaintenanceModeConst = "maintenance_mode"
	UpInformationStatusNolbConst            = "nolb"
	UpInformationStatusOkConst              = "ok"
)

Constants associated with the UpInformation.Status property. status.

View Source 
const (
	UserContextRolesAdminConst      = "_admin"
	UserContextRolesDbUpdatesConst  = "_db_updates"
	UserContextRolesDesignConst     = "_design"
	UserContextRolesReaderConst     = "_reader"
	UserContextRolesReplicatorConst = "_replicator"
	UserContextRolesSecurityConst   = "_security"
	UserContextRolesShardsConst     = "_shards"
	UserContextRolesWriterConst     = "_writer"
)

Constants associated with the UserContext.Roles property. Schema for a security role.

View Source 
const (
	ViewQueryUpdateFalseConst = "false"
	ViewQueryUpdateLazyConst  = "lazy"
	ViewQueryUpdateTrueConst  = "true"
)

Constants associated with the ViewQuery.Update property. Parameter to specify whether or not the view in question should be updated prior to responding to the user.

* `true` - Return results after the view is updated. * `false` - Return results without updating the view. * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.

View Source 
const DefaultServiceName = "cloudant"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "http://localhost:5984"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	DeleteAttachmentOptionsBatchOkConst = "ok"
)

Constants associated with the DeleteAttachmentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	DeleteDesignDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the DeleteDesignDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	DeleteDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the DeleteDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	DeleteLocalDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the DeleteLocalDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	DeleteReplicationDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the DeleteReplicationDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	PostDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the PostDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	PostPartitionSearchOptionsStaleOkConst = "ok"
)

Constants associated with the PostPartitionSearchOptions.Stale property. Do not wait for the index to finish building to return results.

View Source 
const (
	PostSearchOptionsStaleOkConst = "ok"
)

Constants associated with the PostSearchOptions.Stale property. Do not wait for the index to finish building to return results.

View Source 
const (
	PutDesignDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the PutDesignDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	PutDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the PutDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	PutLocalDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the PutLocalDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

View Source 
const (
	PutReplicationDocumentOptionsBatchOkConst = "ok"
)

Constants associated with the PutReplicationDocumentOptions.Batch property. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.0.28 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalActiveTask 

func UnmarshalActiveTask(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalActiveTask unmarshals an instance of ActiveTask from the specified map of raw messages.

func UnmarshalActivityTrackerEvents added in v0.0.32 

func UnmarshalActivityTrackerEvents(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalActivityTrackerEvents unmarshals an instance of ActivityTrackerEvents from the specified map of raw messages.

func UnmarshalAllDocsQueriesResult 

func UnmarshalAllDocsQueriesResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAllDocsQueriesResult unmarshals an instance of AllDocsQueriesResult from the specified map of raw messages.

func UnmarshalAllDocsQuery 

func UnmarshalAllDocsQuery(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAllDocsQuery unmarshals an instance of AllDocsQuery from the specified map of raw messages.

func UnmarshalAllDocsResult 

func UnmarshalAllDocsResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAllDocsResult unmarshals an instance of AllDocsResult from the specified map of raw messages.

func UnmarshalAnalyzer 

func UnmarshalAnalyzer(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAnalyzer unmarshals an instance of Analyzer from the specified map of raw messages.

func UnmarshalAnalyzerConfiguration 

func UnmarshalAnalyzerConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAnalyzerConfiguration unmarshals an instance of AnalyzerConfiguration from the specified map of raw messages.

func UnmarshalApiKeysResult 

func UnmarshalApiKeysResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApiKeysResult unmarshals an instance of ApiKeysResult from the specified map of raw messages.

func UnmarshalAttachment 

func UnmarshalAttachment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAttachment unmarshals an instance of Attachment from the specified map of raw messages.

func UnmarshalBulkDocs 

func UnmarshalBulkDocs(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkDocs unmarshals an instance of BulkDocs from the specified map of raw messages.

func UnmarshalBulkGetQueryDocument 

func UnmarshalBulkGetQueryDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkGetQueryDocument unmarshals an instance of BulkGetQueryDocument from the specified map of raw messages.

func UnmarshalBulkGetResult 

func UnmarshalBulkGetResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkGetResult unmarshals an instance of BulkGetResult from the specified map of raw messages.

func UnmarshalBulkGetResultDocument 

func UnmarshalBulkGetResultDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkGetResultDocument unmarshals an instance of BulkGetResultDocument from the specified map of raw messages.

func UnmarshalBulkGetResultItem 

func UnmarshalBulkGetResultItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkGetResultItem unmarshals an instance of BulkGetResultItem from the specified map of raw messages.

func UnmarshalCapacityThroughputInformation added in v0.0.27 

func UnmarshalCapacityThroughputInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCapacityThroughputInformation unmarshals an instance of CapacityThroughputInformation from the specified map of raw messages.

func UnmarshalCapacityThroughputInformationCurrent added in v0.0.27 

func UnmarshalCapacityThroughputInformationCurrent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCapacityThroughputInformationCurrent unmarshals an instance of CapacityThroughputInformationCurrent from the specified map of raw messages.

func UnmarshalCapacityThroughputInformationTarget added in v0.0.27 

func UnmarshalCapacityThroughputInformationTarget(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCapacityThroughputInformationTarget unmarshals an instance of CapacityThroughputInformationTarget from the specified map of raw messages.

func UnmarshalChange 

func UnmarshalChange(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChange unmarshals an instance of Change from the specified map of raw messages.

func UnmarshalChangesResult 

func UnmarshalChangesResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChangesResult unmarshals an instance of ChangesResult from the specified map of raw messages.

func UnmarshalChangesResultItem 

func UnmarshalChangesResultItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChangesResultItem unmarshals an instance of ChangesResultItem from the specified map of raw messages.

func UnmarshalContentInformationSizes 

func UnmarshalContentInformationSizes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContentInformationSizes unmarshals an instance of ContentInformationSizes from the specified map of raw messages.

func UnmarshalCorsInformation added in v0.0.27 

func UnmarshalCorsInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCorsInformation unmarshals an instance of CorsInformation from the specified map of raw messages.

func UnmarshalCurrentThroughputInformation added in v0.0.27 

func UnmarshalCurrentThroughputInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCurrentThroughputInformation unmarshals an instance of CurrentThroughputInformation from the specified map of raw messages.

func UnmarshalCurrentThroughputInformationThroughput added in v0.0.27 

func UnmarshalCurrentThroughputInformationThroughput(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCurrentThroughputInformationThroughput unmarshals an instance of CurrentThroughputInformationThroughput from the specified map of raw messages.

func UnmarshalDatabaseInformation 

func UnmarshalDatabaseInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDatabaseInformation unmarshals an instance of DatabaseInformation from the specified map of raw messages.

func UnmarshalDatabaseInformationCluster 

func UnmarshalDatabaseInformationCluster(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDatabaseInformationCluster unmarshals an instance of DatabaseInformationCluster from the specified map of raw messages.

func UnmarshalDatabaseInformationProps 

func UnmarshalDatabaseInformationProps(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDatabaseInformationProps unmarshals an instance of DatabaseInformationProps from the specified map of raw messages.

func UnmarshalDbEvent 

func UnmarshalDbEvent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDbEvent unmarshals an instance of DbEvent from the specified map of raw messages.

func UnmarshalDbUpdates 

func UnmarshalDbUpdates(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDbUpdates unmarshals an instance of DbUpdates from the specified map of raw messages.

func UnmarshalDbsInfoResult 

func UnmarshalDbsInfoResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDbsInfoResult unmarshals an instance of DbsInfoResult from the specified map of raw messages.

func UnmarshalDesignDocument 

func UnmarshalDesignDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDesignDocument unmarshals an instance of DesignDocument from the specified map of raw messages.

func UnmarshalDesignDocumentInformation 

func UnmarshalDesignDocumentInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDesignDocumentInformation unmarshals an instance of DesignDocumentInformation from the specified map of raw messages.

func UnmarshalDesignDocumentOptions 

func UnmarshalDesignDocumentOptions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDesignDocumentOptions unmarshals an instance of DesignDocumentOptions from the specified map of raw messages.

func UnmarshalDesignDocumentViewIndex added in v0.0.24 

func UnmarshalDesignDocumentViewIndex(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDesignDocumentViewIndex unmarshals an instance of DesignDocumentViewIndex from the specified map of raw messages.

func UnmarshalDesignDocumentViewsMapReduce 

func UnmarshalDesignDocumentViewsMapReduce(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDesignDocumentViewsMapReduce unmarshals an instance of DesignDocumentViewsMapReduce from the specified map of raw messages.

func UnmarshalDocsResultRow 

func UnmarshalDocsResultRow(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocsResultRow unmarshals an instance of DocsResultRow from the specified map of raw messages.

func UnmarshalDocsResultRowValue 

func UnmarshalDocsResultRowValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocsResultRowValue unmarshals an instance of DocsResultRowValue from the specified map of raw messages.

func UnmarshalDocument 

func UnmarshalDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocument unmarshals an instance of Document from the specified map of raw messages.

func UnmarshalDocumentResult 

func UnmarshalDocumentResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocumentResult unmarshals an instance of DocumentResult from the specified map of raw messages.

func UnmarshalDocumentRevisionStatus 

func UnmarshalDocumentRevisionStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocumentRevisionStatus unmarshals an instance of DocumentRevisionStatus from the specified map of raw messages.

func UnmarshalDocumentShardInfo 

func UnmarshalDocumentShardInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDocumentShardInfo unmarshals an instance of DocumentShardInfo from the specified map of raw messages.

func UnmarshalExecutionStats 

func UnmarshalExecutionStats(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExecutionStats unmarshals an instance of ExecutionStats from the specified map of raw messages.

func UnmarshalExplainResult 

func UnmarshalExplainResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExplainResult unmarshals an instance of ExplainResult from the specified map of raw messages.

func UnmarshalExplainResultMrArgs added in v0.6.0 

func UnmarshalExplainResultMrArgs(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExplainResultMrArgs unmarshals an instance of ExplainResultMrArgs from the specified map of raw messages.

func UnmarshalExplainResultOpts added in v0.6.0 

func UnmarshalExplainResultOpts(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExplainResultOpts unmarshals an instance of ExplainResultOpts from the specified map of raw messages.

func UnmarshalFindResult 

func UnmarshalFindResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFindResult unmarshals an instance of FindResult from the specified map of raw messages.

func UnmarshalIndexDefinition 

func UnmarshalIndexDefinition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexDefinition unmarshals an instance of IndexDefinition from the specified map of raw messages.

func UnmarshalIndexField 

func UnmarshalIndexField(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexField unmarshals an instance of IndexField from the specified map of raw messages.

func UnmarshalIndexInformation 

func UnmarshalIndexInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexInformation unmarshals an instance of IndexInformation from the specified map of raw messages.

func UnmarshalIndexResult 

func UnmarshalIndexResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexResult unmarshals an instance of IndexResult from the specified map of raw messages.

func UnmarshalIndexTextOperatorDefaultField 

func UnmarshalIndexTextOperatorDefaultField(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexTextOperatorDefaultField unmarshals an instance of IndexTextOperatorDefaultField from the specified map of raw messages.

func UnmarshalIndexesInformation 

func UnmarshalIndexesInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIndexesInformation unmarshals an instance of IndexesInformation from the specified map of raw messages.

func UnmarshalMembershipInformation 

func UnmarshalMembershipInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMembershipInformation unmarshals an instance of MembershipInformation from the specified map of raw messages.

func UnmarshalOk 

func UnmarshalOk(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOk unmarshals an instance of Ok from the specified map of raw messages.

func UnmarshalPartitionInformation 

func UnmarshalPartitionInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionInformation unmarshals an instance of PartitionInformation from the specified map of raw messages.

func UnmarshalPartitionInformationIndexes 

func UnmarshalPartitionInformationIndexes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionInformationIndexes unmarshals an instance of PartitionInformationIndexes from the specified map of raw messages.

func UnmarshalPartitionInformationIndexesIndexes 

func UnmarshalPartitionInformationIndexesIndexes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionInformationIndexesIndexes unmarshals an instance of PartitionInformationIndexesIndexes from the specified map of raw messages.

func UnmarshalPartitionInformationSizes 

func UnmarshalPartitionInformationSizes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionInformationSizes unmarshals an instance of PartitionInformationSizes from the specified map of raw messages.

func UnmarshalPartitionedIndexesDetailedInformation added in v0.6.0 

func UnmarshalPartitionedIndexesDetailedInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionedIndexesDetailedInformation unmarshals an instance of PartitionedIndexesDetailedInformation from the specified map of raw messages.

func UnmarshalPartitionedIndexesInformation added in v0.6.0 

func UnmarshalPartitionedIndexesInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPartitionedIndexesInformation unmarshals an instance of PartitionedIndexesInformation from the specified map of raw messages.

func UnmarshalReplicationCreateTargetParameters 

func UnmarshalReplicationCreateTargetParameters(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationCreateTargetParameters unmarshals an instance of ReplicationCreateTargetParameters from the specified map of raw messages.

func UnmarshalReplicationDatabase 

func UnmarshalReplicationDatabase(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationDatabase unmarshals an instance of ReplicationDatabase from the specified map of raw messages.

func UnmarshalReplicationDatabaseAuth 

func UnmarshalReplicationDatabaseAuth(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationDatabaseAuth unmarshals an instance of ReplicationDatabaseAuth from the specified map of raw messages.

func UnmarshalReplicationDatabaseAuthBasic added in v0.0.38 

func UnmarshalReplicationDatabaseAuthBasic(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationDatabaseAuthBasic unmarshals an instance of ReplicationDatabaseAuthBasic from the specified map of raw messages.

func UnmarshalReplicationDatabaseAuthIam 

func UnmarshalReplicationDatabaseAuthIam(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationDatabaseAuthIam unmarshals an instance of ReplicationDatabaseAuthIam from the specified map of raw messages.

func UnmarshalReplicationDocument 

func UnmarshalReplicationDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReplicationDocument unmarshals an instance of ReplicationDocument from the specified map of raw messages.

func UnmarshalRevisions 

func UnmarshalRevisions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevisions unmarshals an instance of Revisions from the specified map of raw messages.

func UnmarshalRevsDiff 

func UnmarshalRevsDiff(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevsDiff unmarshals an instance of RevsDiff from the specified map of raw messages.

func UnmarshalSchedulerDocsResult 

func UnmarshalSchedulerDocsResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerDocsResult unmarshals an instance of SchedulerDocsResult from the specified map of raw messages.

func UnmarshalSchedulerDocument 

func UnmarshalSchedulerDocument(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerDocument unmarshals an instance of SchedulerDocument from the specified map of raw messages.

func UnmarshalSchedulerInfo 

func UnmarshalSchedulerInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerInfo unmarshals an instance of SchedulerInfo from the specified map of raw messages.

func UnmarshalSchedulerJob 

func UnmarshalSchedulerJob(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerJob unmarshals an instance of SchedulerJob from the specified map of raw messages.

func UnmarshalSchedulerJobEvent 

func UnmarshalSchedulerJobEvent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerJobEvent unmarshals an instance of SchedulerJobEvent from the specified map of raw messages.

func UnmarshalSchedulerJobsResult 

func UnmarshalSchedulerJobsResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchedulerJobsResult unmarshals an instance of SchedulerJobsResult from the specified map of raw messages.

func UnmarshalSearchAnalyzeResult 

func UnmarshalSearchAnalyzeResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchAnalyzeResult unmarshals an instance of SearchAnalyzeResult from the specified map of raw messages.

func UnmarshalSearchIndexDefinition 

func UnmarshalSearchIndexDefinition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchIndexDefinition unmarshals an instance of SearchIndexDefinition from the specified map of raw messages.

func UnmarshalSearchIndexInfo 

func UnmarshalSearchIndexInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchIndexInfo unmarshals an instance of SearchIndexInfo from the specified map of raw messages.

func UnmarshalSearchInfoResult 

func UnmarshalSearchInfoResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchInfoResult unmarshals an instance of SearchInfoResult from the specified map of raw messages.

func UnmarshalSearchResult 

func UnmarshalSearchResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchResult unmarshals an instance of SearchResult from the specified map of raw messages.

func UnmarshalSearchResultProperties 

func UnmarshalSearchResultProperties(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchResultProperties unmarshals an instance of SearchResultProperties from the specified map of raw messages.

func UnmarshalSearchResultRow 

func UnmarshalSearchResultRow(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSearchResultRow unmarshals an instance of SearchResultRow from the specified map of raw messages.

func UnmarshalSecurity 

func UnmarshalSecurity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecurity unmarshals an instance of Security from the specified map of raw messages.

func UnmarshalSecurityObject 

func UnmarshalSecurityObject(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecurityObject unmarshals an instance of SecurityObject from the specified map of raw messages.

func UnmarshalServerInformation 

func UnmarshalServerInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServerInformation unmarshals an instance of ServerInformation from the specified map of raw messages.

func UnmarshalServerVendor 

func UnmarshalServerVendor(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServerVendor unmarshals an instance of ServerVendor from the specified map of raw messages.

func UnmarshalSessionAuthentication 

func UnmarshalSessionAuthentication(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSessionAuthentication unmarshals an instance of SessionAuthentication from the specified map of raw messages.

func UnmarshalSessionInformation 

func UnmarshalSessionInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSessionInformation unmarshals an instance of SessionInformation from the specified map of raw messages.

func UnmarshalShardsInformation 

func UnmarshalShardsInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalShardsInformation unmarshals an instance of ShardsInformation from the specified map of raw messages.

func UnmarshalThroughputInformation added in v0.0.27 

func UnmarshalThroughputInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalThroughputInformation unmarshals an instance of ThroughputInformation from the specified map of raw messages.

func UnmarshalUpInformation 

func UnmarshalUpInformation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpInformation unmarshals an instance of UpInformation from the specified map of raw messages.

func UnmarshalUpdatesPending added in v0.4.1 

func UnmarshalUpdatesPending(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpdatesPending unmarshals an instance of UpdatesPending from the specified map of raw messages.

func UnmarshalUserContext 

func UnmarshalUserContext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserContext unmarshals an instance of UserContext from the specified map of raw messages.

func UnmarshalUuidsResult 

func UnmarshalUuidsResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUuidsResult unmarshals an instance of UuidsResult from the specified map of raw messages.

func UnmarshalViewQueriesResult 

func UnmarshalViewQueriesResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalViewQueriesResult unmarshals an instance of ViewQueriesResult from the specified map of raw messages.

func UnmarshalViewQuery 

func UnmarshalViewQuery(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalViewQuery unmarshals an instance of ViewQuery from the specified map of raw messages.

func UnmarshalViewResult 

func UnmarshalViewResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalViewResult unmarshals an instance of ViewResult from the specified map of raw messages.

func UnmarshalViewResultRow 

func UnmarshalViewResultRow(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalViewResultRow unmarshals an instance of ViewResultRow from the specified map of raw messages.

Types

type ActiveTask 

type ActiveTask struct {
	// The total count of attempted doc revisions fetched with `_bulk_get`. Available for `replication` type tasks.
	BulkGetAttempts *int64 `json:"bulk_get_attempts,omitempty"`

	// The total count of successful docs fetched with `_bulk_get`. Available for `replication` type tasks.
	BulkGetDocs *int64 `json:"bulk_get_docs,omitempty"`

	// Processed changes. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.
	ChangesDone *int64 `json:"changes_done,omitempty"`

	// The count of changes not yet replicated. Available for `replication` type tasks.
	ChangesPending *int64 `json:"changes_pending,omitempty"`

	// Specifies the checkpoint interval in ms. Available for `replication` type tasks.
	CheckpointInterval *int64 `json:"checkpoint_interval,omitempty"`

	// The source sequence id which was last successfully replicated. Available for `replication` type tasks.
	CheckpointedSourceSeq *string `json:"checkpointed_source_seq,omitempty"`

	// The replication configured to be continuous. Available for `replication` type tasks.
	Continuous *bool `json:"continuous,omitempty"`

	// Source database.
	Database *string `json:"database" validate:"required"`

	// The design document that belongs to this task. Available for `indexer`, `search_indexer`, `view_compaction` type
	// tasks.
	DesignDocument *string `json:"design_document,omitempty"`

	// Replication document ID. Available for `replication` type tasks.
	DocID *string `json:"doc_id,omitempty"`

	// Number of document write failures. Available for `replication` type tasks.
	DocWriteFailures *int64 `json:"doc_write_failures,omitempty"`

	// Number of documents read. Available for `replication` type tasks.
	DocsRead *int64 `json:"docs_read,omitempty"`

	// Number of documents written to target. Available for `replication` type tasks.
	DocsWritten *int64 `json:"docs_written,omitempty"`

	// The search index that belongs to this task. Available for `search_indexer` type tasks.
	Index *string `json:"index,omitempty"`

	// Indexer process ID. Available for `indexer` type tasks.
	IndexerPid *string `json:"indexer_pid,omitempty"`

	// The count of docs which have been read from the source. Available for `replication` type tasks.
	MissingRevisionsFound *int64 `json:"missing_revisions_found,omitempty"`

	// Cluster node where the task is running.
	Node *string `json:"node" validate:"required"`

	// The phase the active task is in. `docid_sort`, `docid_copy`, `document_copy` phases are available for
	// `database_compaction`, while `ids` and `view` phases are available for `view_compaction` type tasks.
	Phase *string `json:"phase,omitempty"`

	// Process ID.
	Pid *string `json:"pid" validate:"required"`

	// Process status.
	ProcessStatus *string `json:"process_status,omitempty"`

	// Current percentage progress. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction`
	// type tasks.
	Progress *int64 `json:"progress,omitempty"`

	// Replication ID. Available for `replication` type tasks.
	ReplicationID *string `json:"replication_id,omitempty"`

	// Indicates whether a compaction retry is currently running on the database. Available for `database_compaction` type
	// tasks.
	Retry *bool `json:"retry,omitempty"`

	// The count of revisions which have been checked since this replication began. Available for `replication` type tasks.
	RevisionsChecked *int64 `json:"revisions_checked,omitempty"`

	// Replication source. Available for `replication` type tasks.
	Source *string `json:"source,omitempty"`

	// The last sequence number obtained from the source database changes feed. Available for `replication` type tasks.
	SourceSeq *string `json:"source_seq,omitempty"`

	// Schema for a Unix epoch timestamp.
	StartedOn *int64 `json:"started_on" validate:"required"`

	// Replication target. Available for `replication` type tasks.
	Target *string `json:"target,omitempty"`

	// The last sequence number processed by the replicator. Available for `replication` type tasks.
	ThroughSeq *string `json:"through_seq,omitempty"`

	// Total changes to process. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type
	// tasks.
	TotalChanges *int64 `json:"total_changes,omitempty"`

	// Operation type.
	Type *string `json:"type" validate:"required"`

	// Schema for a Unix epoch timestamp.
	UpdatedOn *int64 `json:"updated_on" validate:"required"`

	// Name of user running replication or owning the indexer. Available for `indexer`, `replication` type tasks.
	User *string `json:"user,omitempty"`

	// Number of view indexes. Available for `view_compaction` type tasks.
	View *int64 `json:"view,omitempty"`
}

ActiveTask : Schema for information about a running task.

type ActivityTrackerEvents added in v0.0.32 

type ActivityTrackerEvents struct {
	// An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.
	// "management" is a required element of this array.
	Types []string `json:"types" validate:"required"`
}

ActivityTrackerEvents : Schema for Activity Tracker events.

type AllDocsQueriesResult 

type AllDocsQueriesResult struct {
	// An array of result objects - one for each query. Each result object contains the same fields as the response to a
	// regular `/_all_docs` request.
	Results []AllDocsResult `json:"results" validate:"required"`
}

AllDocsQueriesResult : Schema for the result of an all documents queries operation.

type AllDocsQuery 

type AllDocsQuery struct {
	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for a document ID.
	EndKey *string `json:"end_key,omitempty"`

	// Schema for a document ID.
	Key *string `json:"key,omitempty"`

	// Schema for a list of document IDs.
	Keys []string `json:"keys,omitempty"`

	// Schema for a document ID.
	StartKey *string `json:"start_key,omitempty"`
}

AllDocsQuery : Schema for an all documents query operation.

type AllDocsResult 

type AllDocsResult struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// List of doc results.
	Rows []DocsResultRow `json:"rows" validate:"required"`

	// Current update sequence for the database.
	UpdateSeq *string `json:"update_seq,omitempty"`
}

AllDocsResult : Schema for the result of an all documents operation.

type Analyzer 

type Analyzer struct {
	// Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on
	// the analyzer usage:
	// * For search indexes the default is `standard` * For query text indexes the default is `keyword` * For a query text
	// index default_field the default is `standard`.
	Name *string `json:"name,omitempty"`

	// Custom stopwords to use with the named analyzer.
	Stopwords []string `json:"stopwords,omitempty"`
}

Analyzer : Schema for a full text search analyzer.

type AnalyzerConfiguration 

type AnalyzerConfiguration struct {
	// Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on
	// the analyzer usage:
	// * For search indexes the default is `standard` * For query text indexes the default is `keyword` * For a query text
	// index default_field the default is `standard`.
	Name *string `json:"name,omitempty"`

	// Custom stopwords to use with the named analyzer.
	Stopwords []string `json:"stopwords,omitempty"`

	// Schema for mapping a field name to a per field analyzer.
	Fields map[string]Analyzer `json:"fields,omitempty"`
}

AnalyzerConfiguration : Schema for a search analyzer configuration.

type ApiKeysResult 

type ApiKeysResult struct {
	// ok.
	Ok *bool `json:"ok" validate:"required"`

	// The generated api key.
	Key *string `json:"key" validate:"required"`

	// The password associated with the api key.
	Password *string `json:"password" validate:"required"`
}

ApiKeysResult : Schema for api keys.

type Attachment 

type Attachment struct {
	// Attachment MIME type.
	ContentType *string `json:"content_type,omitempty"`

	// Base64-encoded content. Available if attachment content is requested by using the query parameters
	// `attachments=true` or `atts_since`. Note that when used with a view or changes feed `include_docs` must also be
	// `true`.
	Data *[]byte `json:"data,omitempty"`

	// Content hash digest. It starts with prefix which announce hash type (e.g. `md5-`) and continues with Base64-encoded
	// hash digest.
	Digest *string `json:"digest,omitempty"`

	// Compressed attachment size in bytes. Available if content_type was in list of compressible types when the attachment
	// was added and the query parameter `att_encoding_info` is `true`. Note that when used with a view or changes feed
	// `include_docs` must also be `true`.
	EncodedLength *int64 `json:"encoded_length,omitempty"`

	// Compression codec. Available if content_type was in list of compressible types when the attachment was added and the
	// and the query parameter `att_encoding_info` is `true`. Note that when used with a view or changes feed
	// `include_docs` must also be `true`.
	Encoding *string `json:"encoding,omitempty"`

	// True if the attachment follows in a multipart request or response.
	Follows *bool `json:"follows,omitempty"`

	// Real attachment size in bytes. Not available if inline attachment content requested.
	Length *int64 `json:"length,omitempty"`

	// Revision number when attachment was added.
	Revpos *int64 `json:"revpos,omitempty"`

	// Has `true` value if object contains stub info and no content. Otherwise omitted in response.
	Stub *bool `json:"stub,omitempty"`
}

Attachment : Schema for an attachment.

type BulkDocs 

type BulkDocs struct {
	// Array of documents.
	Docs []Document `json:"docs" validate:"required"`

	// If `false`, prevents the database from assigning them new revision IDs. Default is `true`.
	NewEdits *bool `json:"new_edits,omitempty"`
}

BulkDocs : Schema for submitting documents for bulk modifications.

type BulkGetQueryDocument 

type BulkGetQueryDocument struct {
	// Includes attachments only since specified revisions.
	AttsSince []string `json:"atts_since,omitempty"`

	// Schema for a document ID.
	ID *string `json:"id" validate:"required"`

	// Schema for a document revision identifier.
	Rev *string `json:"rev,omitempty"`
}

BulkGetQueryDocument : Schema for a document item in a bulk get query.

type BulkGetResult 

type BulkGetResult struct {
	// Results.
	Results []BulkGetResultItem `json:"results" validate:"required"`
}

BulkGetResult : Schema for the results object of a bulk get operation.

type BulkGetResultDocument 

type BulkGetResultDocument struct {
	// Schema for the result of a document modification.
	Error *DocumentResult `json:"error,omitempty"`

	// Schema for a document.
	Ok *Document `json:"ok,omitempty"`
}

BulkGetResultDocument : Schema for BulkGetResult object containing a successfully retrieved document or error information.

type BulkGetResultItem 

type BulkGetResultItem struct {
	// Array of document revisions or error information.
	Docs []BulkGetResultDocument `json:"docs" validate:"required"`

	// Schema for a document ID.
	ID *string `json:"id" validate:"required"`
}

BulkGetResultItem : Schema for the document revisions information from a bulk get operation.

type CapacityThroughputInformation added in v0.0.27 

type CapacityThroughputInformation struct {
	// Detailed information about provisioned throughput capacity.
	Current *CapacityThroughputInformationCurrent `json:"current" validate:"required"`

	// Detailed information about target throughput capacity.
	Target *CapacityThroughputInformationTarget `json:"target,omitempty"`
}

CapacityThroughputInformation : Schema for information about the currently provisioned and target throughput capacity.

type CapacityThroughputInformationCurrent added in v0.0.27 

type CapacityThroughputInformationCurrent struct {
	// Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.
	Throughput *ThroughputInformation `json:"throughput" validate:"required"`
}

CapacityThroughputInformationCurrent : Detailed information about provisioned throughput capacity.

type CapacityThroughputInformationTarget added in v0.0.27 

type CapacityThroughputInformationTarget struct {
	// Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.
	Throughput *ThroughputInformation `json:"throughput" validate:"required"`
}

CapacityThroughputInformationTarget : Detailed information about target throughput capacity.

type Change 

type Change struct {
	// Schema for a document revision identifier.
	Rev *string `json:"rev" validate:"required"`
}

Change : Schema for a document leaf with single field rev.

type ChangesResult 

type ChangesResult struct {
	// last_seq.
	LastSeq *string `json:"last_seq" validate:"required"`

	// pending.
	Pending *int64 `json:"pending" validate:"required"`

	// results.
	Results []ChangesResultItem `json:"results" validate:"required"`
}

ChangesResult : Schema for normal changes feed result.

type ChangesResultItem 

type ChangesResultItem struct {
	// List of document's leaves with single field rev.
	Changes []Change `json:"changes" validate:"required"`

	// if `true` then the document is deleted.
	Deleted *bool `json:"deleted,omitempty"`

	// Schema for a document.
	Doc *Document `json:"doc,omitempty"`

	// Schema for a document ID.
	ID *string `json:"id" validate:"required"`

	// Update sequence.
	Seq *string `json:"seq" validate:"required"`
}

ChangesResultItem : Schema for an item in the changes results array.

type CloudantV1 

type CloudantV1 struct {
	Service *base.BaseService
}

CloudantV1 : NoSQL database based on Apache CouchDB See: https://cloud.ibm.com/docs/services/Cloudant/

func NewCloudantV1 

func NewCloudantV1(options *CloudantV1Options) (service *CloudantV1, err error)

NewCloudantV1 : constructs an instance of CloudantV1 with passed in options.

func NewCloudantV1UsingExternalConfig 

func NewCloudantV1UsingExternalConfig(options *CloudantV1Options) (cloudant *CloudantV1, err error)

NewCloudantV1UsingExternalConfig : constructs an instance of CloudantV1 with passed in options and external configuration.

func (*CloudantV1) Clone added in v0.0.28 

func (cloudant *CloudantV1) Clone() *CloudantV1

Clone makes a copy of "cloudant" suitable for processing requests.

func (*CloudantV1) DeleteAttachment 

func (cloudant *CloudantV1) DeleteAttachment(deleteAttachmentOptions *DeleteAttachmentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteAttachment : Delete an attachment Deletes the attachment with the filename, `{attachment_name}`, from the specified doc. You must supply the `rev` query parameter or `If-Match` header with the current revision to delete the attachment.

func (*CloudantV1) DeleteAttachmentWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteAttachmentWithContext(ctx context.Context, deleteAttachmentOptions *DeleteAttachmentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteAttachmentWithContext is an alternate form of the DeleteAttachment method which supports a Context parameter

func (*CloudantV1) DeleteDatabase 

func (cloudant *CloudantV1) DeleteDatabase(deleteDatabaseOptions *DeleteDatabaseOptions) (result *Ok, response *core.DetailedResponse, err error)

DeleteDatabase : Delete a database Deletes the specified database and all documents and attachments contained within it. To avoid deleting a database, the server responds with a 400 HTTP status code when the request URL includes a `?rev=` parameter. This response suggests that a user wanted to delete a document but forgot to add the document ID to the URL.

func (*CloudantV1) DeleteDatabaseWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteDatabaseWithContext(ctx context.Context, deleteDatabaseOptions *DeleteDatabaseOptions) (result *Ok, response *core.DetailedResponse, err error)

DeleteDatabaseWithContext is an alternate form of the DeleteDatabase method which supports a Context parameter

func (*CloudantV1) DeleteDesignDocument 

func (cloudant *CloudantV1) DeleteDesignDocument(deleteDesignDocumentOptions *DeleteDesignDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteDesignDocument : Delete a design document Marks the specified design document as deleted by adding a `_deleted` field with the value `true`. Documents with this field are not returned with requests but stay in the database. You must supply the current (latest) revision, either by using the `rev` parameter or by using the `If-Match` header to specify the revision.

func (*CloudantV1) DeleteDesignDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteDesignDocumentWithContext(ctx context.Context, deleteDesignDocumentOptions *DeleteDesignDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteDesignDocumentWithContext is an alternate form of the DeleteDesignDocument method which supports a Context parameter

func (*CloudantV1) DeleteDocument 

func (cloudant *CloudantV1) DeleteDocument(deleteDocumentOptions *DeleteDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteDocument : Delete a document Marks the specified document as deleted by adding a `_deleted` field with the value `true`. Documents with this field are not returned within requests anymore but stay in the database. You must supply the current (latest) revision, either by using the `rev` parameter or by using the `If-Match` header to specify the revision.

func (*CloudantV1) DeleteDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteDocumentWithContext(ctx context.Context, deleteDocumentOptions *DeleteDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteDocumentWithContext is an alternate form of the DeleteDocument method which supports a Context parameter

func (*CloudantV1) DeleteIndex 

func (cloudant *CloudantV1) DeleteIndex(deleteIndexOptions *DeleteIndexOptions) (result *Ok, response *core.DetailedResponse, err error)

DeleteIndex : Delete an index

func (*CloudantV1) DeleteIndexWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteIndexWithContext(ctx context.Context, deleteIndexOptions *DeleteIndexOptions) (result *Ok, response *core.DetailedResponse, err error)

DeleteIndexWithContext is an alternate form of the DeleteIndex method which supports a Context parameter

func (*CloudantV1) DeleteLocalDocument 

func (cloudant *CloudantV1) DeleteLocalDocument(deleteLocalDocumentOptions *DeleteLocalDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteLocalDocument : Delete a local document Deletes the specified local document. The semantics are identical to deleting a standard document in the specified database, except that the document is not replicated.

func (*CloudantV1) DeleteLocalDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteLocalDocumentWithContext(ctx context.Context, deleteLocalDocumentOptions *DeleteLocalDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteLocalDocumentWithContext is an alternate form of the DeleteLocalDocument method which supports a Context parameter

func (*CloudantV1) DeleteReplicationDocument 

func (cloudant *CloudantV1) DeleteReplicationDocument(deleteReplicationDocumentOptions *DeleteReplicationDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteReplicationDocument : Cancel a replication Cancels a replication by deleting the document that describes it from the `_replicator` database.

func (*CloudantV1) DeleteReplicationDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) DeleteReplicationDocumentWithContext(ctx context.Context, deleteReplicationDocumentOptions *DeleteReplicationDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

DeleteReplicationDocumentWithContext is an alternate form of the DeleteReplicationDocument method which supports a Context parameter

func (*CloudantV1) DisableRetries added in v0.0.28 

func (cloudant *CloudantV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*CloudantV1) EnableRetries added in v0.0.28 

func (cloudant *CloudantV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*CloudantV1) GetActiveTasks 

func (cloudant *CloudantV1) GetActiveTasks(getActiveTasksOptions *GetActiveTasksOptions) (result []ActiveTask, response *core.DetailedResponse, err error)

GetActiveTasks : Retrieve list of running tasks Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the currently running tasks, with each task described as a single object. Depending on the operation type, the set of response object fields might be different.

func (*CloudantV1) GetActiveTasksWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetActiveTasksWithContext(ctx context.Context, getActiveTasksOptions *GetActiveTasksOptions) (result []ActiveTask, response *core.DetailedResponse, err error)

GetActiveTasksWithContext is an alternate form of the GetActiveTasks method which supports a Context parameter

func (*CloudantV1) GetActivityTrackerEvents added in v0.0.32 

func (cloudant *CloudantV1) GetActivityTrackerEvents(getActivityTrackerEventsOptions *GetActivityTrackerEventsOptions) (result *ActivityTrackerEvents, response *core.DetailedResponse, err error)

GetActivityTrackerEvents : Retrieve Activity Tracker events information Check event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.

func (*CloudantV1) GetActivityTrackerEventsWithContext added in v0.0.32 

func (cloudant *CloudantV1) GetActivityTrackerEventsWithContext(ctx context.Context, getActivityTrackerEventsOptions *GetActivityTrackerEventsOptions) (result *ActivityTrackerEvents, response *core.DetailedResponse, err error)

GetActivityTrackerEventsWithContext is an alternate form of the GetActivityTrackerEvents method which supports a Context parameter

func (*CloudantV1) GetAllDbs 

func (cloudant *CloudantV1) GetAllDbs(getAllDbsOptions *GetAllDbsOptions) (result []string, response *core.DetailedResponse, err error)

GetAllDbs : Query a list of all database names in the instance

func (*CloudantV1) GetAllDbsWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetAllDbsWithContext(ctx context.Context, getAllDbsOptions *GetAllDbsOptions) (result []string, response *core.DetailedResponse, err error)

GetAllDbsWithContext is an alternate form of the GetAllDbs method which supports a Context parameter

func (*CloudantV1) GetAttachment 

func (cloudant *CloudantV1) GetAttachment(getAttachmentOptions *GetAttachmentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetAttachment : Retrieve an attachment Returns the file attachment that is associated with the document. The raw data of the associated attachment is returned, just as if you were accessing a static file. The returned Content-Type header is the same as the content type set when the document attachment was submitted to the database.

func (*CloudantV1) GetAttachmentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetAttachmentWithContext(ctx context.Context, getAttachmentOptions *GetAttachmentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetAttachmentWithContext is an alternate form of the GetAttachment method which supports a Context parameter

func (*CloudantV1) GetCapacityThroughputInformation added in v0.0.27 

func (cloudant *CloudantV1) GetCapacityThroughputInformation(getCapacityThroughputInformationOptions *GetCapacityThroughputInformationOptions) (result *CapacityThroughputInformation, response *core.DetailedResponse, err error)

GetCapacityThroughputInformation : Retrieve provisioned throughput capacity information View the amount of provisioned throughput capacity that is allocated to an IBM Cloudant instance and what is the target provisioned throughput capacity.

func (*CloudantV1) GetCapacityThroughputInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetCapacityThroughputInformationWithContext(ctx context.Context, getCapacityThroughputInformationOptions *GetCapacityThroughputInformationOptions) (result *CapacityThroughputInformation, response *core.DetailedResponse, err error)

GetCapacityThroughputInformationWithContext is an alternate form of the GetCapacityThroughputInformation method which supports a Context parameter

func (*CloudantV1) GetCorsInformation 

func (cloudant *CloudantV1) GetCorsInformation(getCorsInformationOptions *GetCorsInformationOptions) (result *CorsInformation, response *core.DetailedResponse, err error)

GetCorsInformation : Retrieve CORS configuration information Lists all Cross-origin resource sharing (CORS) configuration. CORS defines a way in which the browser and the server interact to determine whether or not to allow the request.

func (*CloudantV1) GetCorsInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetCorsInformationWithContext(ctx context.Context, getCorsInformationOptions *GetCorsInformationOptions) (result *CorsInformation, response *core.DetailedResponse, err error)

GetCorsInformationWithContext is an alternate form of the GetCorsInformation method which supports a Context parameter

func (*CloudantV1) GetCurrentThroughputInformation added in v0.0.27 

func (cloudant *CloudantV1) GetCurrentThroughputInformation(getCurrentThroughputInformationOptions *GetCurrentThroughputInformationOptions) (result *CurrentThroughputInformation, response *core.DetailedResponse, err error)

GetCurrentThroughputInformation : Retrieve the current provisioned throughput capacity consumption View the current consumption of provisioned throughput capacity for an IBM Cloudant instance. The current consumption shows the quantities of reads, writes, and global queries conducted against the instance for a given second.

func (*CloudantV1) GetCurrentThroughputInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetCurrentThroughputInformationWithContext(ctx context.Context, getCurrentThroughputInformationOptions *GetCurrentThroughputInformationOptions) (result *CurrentThroughputInformation, response *core.DetailedResponse, err error)

GetCurrentThroughputInformationWithContext is an alternate form of the GetCurrentThroughputInformation method which supports a Context parameter

func (*CloudantV1) GetDatabaseInformation 

func (cloudant *CloudantV1) GetDatabaseInformation(getDatabaseInformationOptions *GetDatabaseInformationOptions) (result *DatabaseInformation, response *core.DetailedResponse, err error)

GetDatabaseInformation : Retrieve information about a database

func (*CloudantV1) GetDatabaseInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDatabaseInformationWithContext(ctx context.Context, getDatabaseInformationOptions *GetDatabaseInformationOptions) (result *DatabaseInformation, response *core.DetailedResponse, err error)

GetDatabaseInformationWithContext is an alternate form of the GetDatabaseInformation method which supports a Context parameter

func (*CloudantV1) GetDbUpdates 

func (cloudant *CloudantV1) GetDbUpdates(getDbUpdatesOptions *GetDbUpdatesOptions) (result *DbUpdates, response *core.DetailedResponse, err error)

GetDbUpdates : Retrieve change events for all databases **This endpoint is not available in IBM Cloudant.**

Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order and might repeat changes. Polling modes for this method work like polling modes for the changes feed. Deprecated: this method is deprecated and may be removed in a future release.

func (*CloudantV1) GetDbUpdatesWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDbUpdatesWithContext(ctx context.Context, getDbUpdatesOptions *GetDbUpdatesOptions) (result *DbUpdates, response *core.DetailedResponse, err error)

GetDbUpdatesWithContext is an alternate form of the GetDbUpdates method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*CloudantV1) GetDesignDocument 

func (cloudant *CloudantV1) GetDesignDocument(getDesignDocumentOptions *GetDesignDocumentOptions) (result *DesignDocument, response *core.DetailedResponse, err error)

GetDesignDocument : Retrieve a design document Returns design document with the specified `doc_id` from the specified database. Unless you request a specific revision, the current revision of the design document is always returned.

func (*CloudantV1) GetDesignDocumentInformation 

func (cloudant *CloudantV1) GetDesignDocumentInformation(getDesignDocumentInformationOptions *GetDesignDocumentInformationOptions) (result *DesignDocumentInformation, response *core.DetailedResponse, err error)

GetDesignDocumentInformation : Retrieve information about a design document Retrieves information about the specified design document, including the index, index size, and current status of the design document and associated index information.

func (*CloudantV1) GetDesignDocumentInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDesignDocumentInformationWithContext(ctx context.Context, getDesignDocumentInformationOptions *GetDesignDocumentInformationOptions) (result *DesignDocumentInformation, response *core.DetailedResponse, err error)

GetDesignDocumentInformationWithContext is an alternate form of the GetDesignDocumentInformation method which supports a Context parameter

func (*CloudantV1) GetDesignDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDesignDocumentWithContext(ctx context.Context, getDesignDocumentOptions *GetDesignDocumentOptions) (result *DesignDocument, response *core.DetailedResponse, err error)

GetDesignDocumentWithContext is an alternate form of the GetDesignDocument method which supports a Context parameter

func (*CloudantV1) GetDocument 

func (cloudant *CloudantV1) GetDocument(getDocumentOptions *GetDocumentOptions) (result *Document, response *core.DetailedResponse, err error)

GetDocument : Retrieve a document Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

func (*CloudantV1) GetDocumentAsMixed 

func (cloudant *CloudantV1) GetDocumentAsMixed(getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsMixed : Retrieve a document as mixed Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

func (*CloudantV1) GetDocumentAsMixedWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDocumentAsMixedWithContext(ctx context.Context, getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsMixedWithContext is an alternate form of the GetDocumentAsMixed method which supports a Context parameter

func (*CloudantV1) GetDocumentAsRelated 

func (cloudant *CloudantV1) GetDocumentAsRelated(getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsRelated : Retrieve a document as related Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

func (*CloudantV1) GetDocumentAsRelatedWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDocumentAsRelatedWithContext(ctx context.Context, getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsRelatedWithContext is an alternate form of the GetDocumentAsRelated method which supports a Context parameter

func (*CloudantV1) GetDocumentAsStream 

func (cloudant *CloudantV1) GetDocumentAsStream(getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsStream : Retrieve a document as stream Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

func (*CloudantV1) GetDocumentAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDocumentAsStreamWithContext(ctx context.Context, getDocumentOptions *GetDocumentOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDocumentAsStreamWithContext is an alternate form of the GetDocumentAsStream method which supports a Context parameter

func (*CloudantV1) GetDocumentShardsInfo 

func (cloudant *CloudantV1) GetDocumentShardsInfo(getDocumentShardsInfoOptions *GetDocumentShardsInfoOptions) (result *DocumentShardInfo, response *core.DetailedResponse, err error)

GetDocumentShardsInfo : Retrieve shard information for a specific document Retrieves information about a specific shard where a particular document is stored, along with information about the nodes where that shard has a replica.

func (*CloudantV1) GetDocumentShardsInfoWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDocumentShardsInfoWithContext(ctx context.Context, getDocumentShardsInfoOptions *GetDocumentShardsInfoOptions) (result *DocumentShardInfo, response *core.DetailedResponse, err error)

GetDocumentShardsInfoWithContext is an alternate form of the GetDocumentShardsInfo method which supports a Context parameter

func (*CloudantV1) GetDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetDocumentWithContext(ctx context.Context, getDocumentOptions *GetDocumentOptions) (result *Document, response *core.DetailedResponse, err error)

GetDocumentWithContext is an alternate form of the GetDocument method which supports a Context parameter

func (*CloudantV1) GetEnableGzipCompression added in v0.0.27 

func (cloudant *CloudantV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*CloudantV1) GetIndexesInformation 

func (cloudant *CloudantV1) GetIndexesInformation(getIndexesInformationOptions *GetIndexesInformationOptions) (result *IndexesInformation, response *core.DetailedResponse, err error)

GetIndexesInformation : Retrieve information about all indexes When you make a GET request to `/db/_index`, you get a list of all indexes used by Cloudant Query in the database, including the primary index. In addition to the information available through this API, indexes are also stored in the `indexes` property of design documents.

func (*CloudantV1) GetIndexesInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetIndexesInformationWithContext(ctx context.Context, getIndexesInformationOptions *GetIndexesInformationOptions) (result *IndexesInformation, response *core.DetailedResponse, err error)

GetIndexesInformationWithContext is an alternate form of the GetIndexesInformation method which supports a Context parameter

func (*CloudantV1) GetLocalDocument 

func (cloudant *CloudantV1) GetLocalDocument(getLocalDocumentOptions *GetLocalDocumentOptions) (result *Document, response *core.DetailedResponse, err error)

GetLocalDocument : Retrieve a local document Retrieves the specified local document. The semantics are identical to accessing a standard document in the specified database, except that the document is not replicated.

func (*CloudantV1) GetLocalDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetLocalDocumentWithContext(ctx context.Context, getLocalDocumentOptions *GetLocalDocumentOptions) (result *Document, response *core.DetailedResponse, err error)

GetLocalDocumentWithContext is an alternate form of the GetLocalDocument method which supports a Context parameter

func (*CloudantV1) GetMembershipInformation 

func (cloudant *CloudantV1) GetMembershipInformation(getMembershipInformationOptions *GetMembershipInformationOptions) (result *MembershipInformation, response *core.DetailedResponse, err error)

GetMembershipInformation : Retrieve cluster membership information Displays the nodes that are part of the cluster as `cluster_nodes`. The field, `all_nodes`, displays all nodes this node knows about, including the ones that are part of the cluster. This endpoint is useful when you set up a cluster.

func (*CloudantV1) GetMembershipInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetMembershipInformationWithContext(ctx context.Context, getMembershipInformationOptions *GetMembershipInformationOptions) (result *MembershipInformation, response *core.DetailedResponse, err error)

GetMembershipInformationWithContext is an alternate form of the GetMembershipInformation method which supports a Context parameter

func (*CloudantV1) GetPartitionInformation 

func (cloudant *CloudantV1) GetPartitionInformation(getPartitionInformationOptions *GetPartitionInformationOptions) (result *PartitionInformation, response *core.DetailedResponse, err error)

GetPartitionInformation : Retrieve information about a database partition Given a partition key, return the database name, sizes, partition, doc count, and doc delete count.

func (*CloudantV1) GetPartitionInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetPartitionInformationWithContext(ctx context.Context, getPartitionInformationOptions *GetPartitionInformationOptions) (result *PartitionInformation, response *core.DetailedResponse, err error)

GetPartitionInformationWithContext is an alternate form of the GetPartitionInformation method which supports a Context parameter

func (*CloudantV1) GetReplicationDocument 

func (cloudant *CloudantV1) GetReplicationDocument(getReplicationDocumentOptions *GetReplicationDocumentOptions) (result *ReplicationDocument, response *core.DetailedResponse, err error)

GetReplicationDocument : Retrieve a replication document Retrieves a replication document from the `_replicator` database to view the configuration of the replication. The status of the replication is no longer recorded in the document but can be checked via the replication scheduler.

func (*CloudantV1) GetReplicationDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetReplicationDocumentWithContext(ctx context.Context, getReplicationDocumentOptions *GetReplicationDocumentOptions) (result *ReplicationDocument, response *core.DetailedResponse, err error)

GetReplicationDocumentWithContext is an alternate form of the GetReplicationDocument method which supports a Context parameter

func (*CloudantV1) GetSchedulerDocs 

func (cloudant *CloudantV1) GetSchedulerDocs(getSchedulerDocsOptions *GetSchedulerDocsOptions) (result *SchedulerDocsResult, response *core.DetailedResponse, err error)

GetSchedulerDocs : Retrieve replication scheduler documents Lists replication documents, including information about all documents, even the ones in a completed or failed state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and other information.

func (*CloudantV1) GetSchedulerDocsWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSchedulerDocsWithContext(ctx context.Context, getSchedulerDocsOptions *GetSchedulerDocsOptions) (result *SchedulerDocsResult, response *core.DetailedResponse, err error)

GetSchedulerDocsWithContext is an alternate form of the GetSchedulerDocs method which supports a Context parameter

func (*CloudantV1) GetSchedulerDocument 

func (cloudant *CloudantV1) GetSchedulerDocument(getSchedulerDocumentOptions *GetSchedulerDocumentOptions) (result *SchedulerDocument, response *core.DetailedResponse, err error)

GetSchedulerDocument : Retrieve a replication scheduler document Retrieves information about a replication document from the replicator database. The endpoint returns the document ID, database, replication ID, source and target, and other information.

func (*CloudantV1) GetSchedulerDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSchedulerDocumentWithContext(ctx context.Context, getSchedulerDocumentOptions *GetSchedulerDocumentOptions) (result *SchedulerDocument, response *core.DetailedResponse, err error)

GetSchedulerDocumentWithContext is an alternate form of the GetSchedulerDocument method which supports a Context parameter

func (*CloudantV1) GetSchedulerJob 

func (cloudant *CloudantV1) GetSchedulerJob(getSchedulerJobOptions *GetSchedulerJobOptions) (result *SchedulerJob, response *core.DetailedResponse, err error)

GetSchedulerJob : Retrieve a replication scheduler job Retrieves the state of a single replication task based on its replication ID.

func (*CloudantV1) GetSchedulerJobWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSchedulerJobWithContext(ctx context.Context, getSchedulerJobOptions *GetSchedulerJobOptions) (result *SchedulerJob, response *core.DetailedResponse, err error)

GetSchedulerJobWithContext is an alternate form of the GetSchedulerJob method which supports a Context parameter

func (*CloudantV1) GetSchedulerJobs 

func (cloudant *CloudantV1) GetSchedulerJobs(getSchedulerJobsOptions *GetSchedulerJobsOptions) (result *SchedulerJobsResult, response *core.DetailedResponse, err error)

GetSchedulerJobs : Retrieve replication scheduler jobs Retrieves information about replications that were created via `/_replicate` endpoint, as well as those created from replication documents. It doesn't include replications that completed or failed to start because replication documents were malformed. Each job description includes source and target information, replication ID, history of recent events, and other information.

func (*CloudantV1) GetSchedulerJobsWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSchedulerJobsWithContext(ctx context.Context, getSchedulerJobsOptions *GetSchedulerJobsOptions) (result *SchedulerJobsResult, response *core.DetailedResponse, err error)

GetSchedulerJobsWithContext is an alternate form of the GetSchedulerJobs method which supports a Context parameter

func (*CloudantV1) GetSearchInfo 

func (cloudant *CloudantV1) GetSearchInfo(getSearchInfoOptions *GetSearchInfoOptions) (result *SearchInfoResult, response *core.DetailedResponse, err error)

GetSearchInfo : Retrieve information about a search index Retrieve search index metadata information, such as the size of the index on disk.

func (*CloudantV1) GetSearchInfoWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSearchInfoWithContext(ctx context.Context, getSearchInfoOptions *GetSearchInfoOptions) (result *SearchInfoResult, response *core.DetailedResponse, err error)

GetSearchInfoWithContext is an alternate form of the GetSearchInfo method which supports a Context parameter

func (*CloudantV1) GetSecurity 

func (cloudant *CloudantV1) GetSecurity(getSecurityOptions *GetSecurityOptions) (result *Security, response *core.DetailedResponse, err error)

GetSecurity : Retrieve database permissions information See who has permission to read, write, and manage the database. The credentials you use to log in to the dashboard automatically include `_admin` permissions to all databases you create. Everyone and everything else, including users you share databases with and API keys you create, must be given a permission level explicitly.

func (*CloudantV1) GetSecurityWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSecurityWithContext(ctx context.Context, getSecurityOptions *GetSecurityOptions) (result *Security, response *core.DetailedResponse, err error)

GetSecurityWithContext is an alternate form of the GetSecurity method which supports a Context parameter

func (*CloudantV1) GetServerInformation 

func (cloudant *CloudantV1) GetServerInformation(getServerInformationOptions *GetServerInformationOptions) (result *ServerInformation, response *core.DetailedResponse, err error)

GetServerInformation : Retrieve server instance information When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response includes a JSON structure that contains information about the server, including a welcome message and the server's version.

**Tip:** The authentication for this endpoint is only enforced when using IAM.

func (*CloudantV1) GetServerInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetServerInformationWithContext(ctx context.Context, getServerInformationOptions *GetServerInformationOptions) (result *ServerInformation, response *core.DetailedResponse, err error)

GetServerInformationWithContext is an alternate form of the GetServerInformation method which supports a Context parameter

func (*CloudantV1) GetServiceURL added in v0.0.27 

func (cloudant *CloudantV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*CloudantV1) GetSessionInformation 

func (cloudant *CloudantV1) GetSessionInformation(getSessionInformationOptions *GetSessionInformationOptions) (result *SessionInformation, response *core.DetailedResponse, err error)

GetSessionInformation : Retrieve current session cookie information Retrieves information about the authenticated user's session.

func (*CloudantV1) GetSessionInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetSessionInformationWithContext(ctx context.Context, getSessionInformationOptions *GetSessionInformationOptions) (result *SessionInformation, response *core.DetailedResponse, err error)

GetSessionInformationWithContext is an alternate form of the GetSessionInformation method which supports a Context parameter

func (*CloudantV1) GetShardsInformation 

func (cloudant *CloudantV1) GetShardsInformation(getShardsInformationOptions *GetShardsInformationOptions) (result *ShardsInformation, response *core.DetailedResponse, err error)

GetShardsInformation : Retrieve shard information List each shard range and the corresponding replicas for a specified database.

func (*CloudantV1) GetShardsInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetShardsInformationWithContext(ctx context.Context, getShardsInformationOptions *GetShardsInformationOptions) (result *ShardsInformation, response *core.DetailedResponse, err error)

GetShardsInformationWithContext is an alternate form of the GetShardsInformation method which supports a Context parameter

func (*CloudantV1) GetUpInformation 

func (cloudant *CloudantV1) GetUpInformation(getUpInformationOptions *GetUpInformationOptions) (result *UpInformation, response *core.DetailedResponse, err error)

GetUpInformation : Retrieve information about whether the server is up Confirms that the server is up, running, and ready to respond to requests. If `maintenance_mode` is `true` or `nolb`, the endpoint returns a 404 response.

**Tip:** The authentication for this endpoint is only enforced when using IAM.

func (*CloudantV1) GetUpInformationWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetUpInformationWithContext(ctx context.Context, getUpInformationOptions *GetUpInformationOptions) (result *UpInformation, response *core.DetailedResponse, err error)

GetUpInformationWithContext is an alternate form of the GetUpInformation method which supports a Context parameter

func (*CloudantV1) GetUuids 

func (cloudant *CloudantV1) GetUuids(getUuidsOptions *GetUuidsOptions) (result *UuidsResult, response *core.DetailedResponse, err error)

GetUuids : Retrieve one or more UUIDs Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that provides a list of UUIDs.

**Tip:** The authentication for this endpoint is only enforced when using IAM.

func (*CloudantV1) GetUuidsWithContext added in v0.0.27 

func (cloudant *CloudantV1) GetUuidsWithContext(ctx context.Context, getUuidsOptions *GetUuidsOptions) (result *UuidsResult, response *core.DetailedResponse, err error)

GetUuidsWithContext is an alternate form of the GetUuids method which supports a Context parameter

func (*CloudantV1) HeadAttachment 

func (cloudant *CloudantV1) HeadAttachment(headAttachmentOptions *HeadAttachmentOptions) (response *core.DetailedResponse, err error)

HeadAttachment : Retrieve the HTTP headers for an attachment Returns the HTTP headers that contain a minimal amount of information about the specified attachment. This method supports the same query arguments as the `GET /{db}/{doc_id}/{attachment_name}` method, but only the header information (including attachment size, encoding, and the MD5 hash as an ETag), is returned.

func (*CloudantV1) HeadAttachmentWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadAttachmentWithContext(ctx context.Context, headAttachmentOptions *HeadAttachmentOptions) (response *core.DetailedResponse, err error)

HeadAttachmentWithContext is an alternate form of the HeadAttachment method which supports a Context parameter

func (*CloudantV1) HeadDatabase 

func (cloudant *CloudantV1) HeadDatabase(headDatabaseOptions *HeadDatabaseOptions) (response *core.DetailedResponse, err error)

HeadDatabase : Retrieve the HTTP headers for a database Returns the HTTP headers that contain a minimal amount of information about the specified database. Since the response body is empty, using the HEAD method is a lightweight way to check if the database exists or not.

func (*CloudantV1) HeadDatabaseWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadDatabaseWithContext(ctx context.Context, headDatabaseOptions *HeadDatabaseOptions) (response *core.DetailedResponse, err error)

HeadDatabaseWithContext is an alternate form of the HeadDatabase method which supports a Context parameter

func (*CloudantV1) HeadDesignDocument 

func (cloudant *CloudantV1) HeadDesignDocument(headDesignDocumentOptions *HeadDesignDocumentOptions) (response *core.DetailedResponse, err error)

HeadDesignDocument : Retrieve the HTTP headers for a design document This method supports the same query arguments as the `GET /{db}/_design/{ddoc}` method, but the results include only the header information (including design document size, and the revision as an ETag). The ETag header shows the current revision for the requested design document, and if you requested the design document in full, the Content-Length specifies the length of the data. If you add any of the query arguments, then the resulting HTTP headers correspond to what is returned for the equivalent GET request.

func (*CloudantV1) HeadDesignDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadDesignDocumentWithContext(ctx context.Context, headDesignDocumentOptions *HeadDesignDocumentOptions) (response *core.DetailedResponse, err error)

HeadDesignDocumentWithContext is an alternate form of the HeadDesignDocument method which supports a Context parameter

func (*CloudantV1) HeadDocument 

func (cloudant *CloudantV1) HeadDocument(headDocumentOptions *HeadDocumentOptions) (response *core.DetailedResponse, err error)

HeadDocument : Retrieve the HTTP headers for the document This method supports the same query arguments as the `GET /{db}/{docid}` method, but only the header information (including document size and the revision as an ETag) is returned. The ETag header shows the current revision for the requested document, and the Content-Length specifies the length of the data if the document was requested in full. Add any of the query arguments, then the resulting HTTP headers that correspond to it are returned.

func (*CloudantV1) HeadDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadDocumentWithContext(ctx context.Context, headDocumentOptions *HeadDocumentOptions) (response *core.DetailedResponse, err error)

HeadDocumentWithContext is an alternate form of the HeadDocument method which supports a Context parameter

func (*CloudantV1) HeadLocalDocument added in v0.0.29 

func (cloudant *CloudantV1) HeadLocalDocument(headLocalDocumentOptions *HeadLocalDocumentOptions) (response *core.DetailedResponse, err error)

HeadLocalDocument : Retrieve HTTP headers for a local document Retrieves the HTTP headers containing minimal amount of information about the specified local document. Since the response body is empty, using the HEAD method is a lightweight way to check if the local document exists or not.

func (*CloudantV1) HeadLocalDocumentWithContext added in v0.0.29 

func (cloudant *CloudantV1) HeadLocalDocumentWithContext(ctx context.Context, headLocalDocumentOptions *HeadLocalDocumentOptions) (response *core.DetailedResponse, err error)

HeadLocalDocumentWithContext is an alternate form of the HeadLocalDocument method which supports a Context parameter

func (*CloudantV1) HeadReplicationDocument 

func (cloudant *CloudantV1) HeadReplicationDocument(headReplicationDocumentOptions *HeadReplicationDocumentOptions) (response *core.DetailedResponse, err error)

HeadReplicationDocument : Retrieve the HTTP headers for a replication document Retrieves the HTTP headers containing minimal amount of information about the specified replication document from the `_replicator` database. The method supports the same query arguments as the `GET /_replicator/{doc_id}` method, but only headers like content length and the revision (ETag header) are returned.

func (*CloudantV1) HeadReplicationDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadReplicationDocumentWithContext(ctx context.Context, headReplicationDocumentOptions *HeadReplicationDocumentOptions) (response *core.DetailedResponse, err error)

HeadReplicationDocumentWithContext is an alternate form of the HeadReplicationDocument method which supports a Context parameter

func (*CloudantV1) HeadSchedulerDocument added in v0.0.29 

func (cloudant *CloudantV1) HeadSchedulerDocument(headSchedulerDocumentOptions *HeadSchedulerDocumentOptions) (response *core.DetailedResponse, err error)

HeadSchedulerDocument : Retrieve HTTP headers for a replication scheduler document Retrieves the HTTP headers containing minimal amount of information about the specified replication scheduler document. Since the response body is empty, using the HEAD method is a lightweight way to check if the replication scheduler document exists or not.

func (*CloudantV1) HeadSchedulerDocumentWithContext added in v0.0.29 

func (cloudant *CloudantV1) HeadSchedulerDocumentWithContext(ctx context.Context, headSchedulerDocumentOptions *HeadSchedulerDocumentOptions) (response *core.DetailedResponse, err error)

HeadSchedulerDocumentWithContext is an alternate form of the HeadSchedulerDocument method which supports a Context parameter

func (*CloudantV1) HeadSchedulerJob 

func (cloudant *CloudantV1) HeadSchedulerJob(headSchedulerJobOptions *HeadSchedulerJobOptions) (response *core.DetailedResponse, err error)

HeadSchedulerJob : Retrieve the HTTP headers for a replication scheduler job Returns the HTTP headers that contain a minimal amount of information about the specified replication task. Only the header information is returned.

func (*CloudantV1) HeadSchedulerJobWithContext added in v0.0.27 

func (cloudant *CloudantV1) HeadSchedulerJobWithContext(ctx context.Context, headSchedulerJobOptions *HeadSchedulerJobOptions) (response *core.DetailedResponse, err error)

HeadSchedulerJobWithContext is an alternate form of the HeadSchedulerJob method which supports a Context parameter

func (*CloudantV1) HeadUpInformation added in v0.0.29 

func (cloudant *CloudantV1) HeadUpInformation(headUpInformationOptions *HeadUpInformationOptions) (response *core.DetailedResponse, err error)

HeadUpInformation : Retrieve HTTP headers about whether the server is up Retrieves the HTTP headers about whether the server is up.

func (*CloudantV1) HeadUpInformationWithContext added in v0.0.29 

func (cloudant *CloudantV1) HeadUpInformationWithContext(ctx context.Context, headUpInformationOptions *HeadUpInformationOptions) (response *core.DetailedResponse, err error)

HeadUpInformationWithContext is an alternate form of the HeadUpInformation method which supports a Context parameter

func (*CloudantV1) NewActivityTrackerEvents added in v0.0.32 

func (*CloudantV1) NewActivityTrackerEvents(types []string) (_model *ActivityTrackerEvents, err error)

NewActivityTrackerEvents : Instantiate ActivityTrackerEvents (Generic Model Constructor)

func (*CloudantV1) NewBulkDocs added in v0.0.25 

func (*CloudantV1) NewBulkDocs(docs []Document) (_model *BulkDocs, err error)

NewBulkDocs : Instantiate BulkDocs (Generic Model Constructor)

func (*CloudantV1) NewBulkGetQueryDocument 

func (*CloudantV1) NewBulkGetQueryDocument(id string) (_model *BulkGetQueryDocument, err error)

NewBulkGetQueryDocument : Instantiate BulkGetQueryDocument (Generic Model Constructor)

func (*CloudantV1) NewDeleteAttachmentOptions 

func (*CloudantV1) NewDeleteAttachmentOptions(db string, docID string, attachmentName string) *DeleteAttachmentOptions

NewDeleteAttachmentOptions : Instantiate DeleteAttachmentOptions

func (*CloudantV1) NewDeleteDatabaseOptions 

func (*CloudantV1) NewDeleteDatabaseOptions(db string) *DeleteDatabaseOptions

NewDeleteDatabaseOptions : Instantiate DeleteDatabaseOptions

func (*CloudantV1) NewDeleteDesignDocumentOptions 

func (*CloudantV1) NewDeleteDesignDocumentOptions(db string, ddoc string) *DeleteDesignDocumentOptions

NewDeleteDesignDocumentOptions : Instantiate DeleteDesignDocumentOptions

func (*CloudantV1) NewDeleteDocumentOptions 

func (*CloudantV1) NewDeleteDocumentOptions(db string, docID string) *DeleteDocumentOptions

NewDeleteDocumentOptions : Instantiate DeleteDocumentOptions

func (*CloudantV1) NewDeleteIndexOptions 

func (*CloudantV1) NewDeleteIndexOptions(db string, ddoc string, typeVar string, index string) *DeleteIndexOptions

NewDeleteIndexOptions : Instantiate DeleteIndexOptions

func (*CloudantV1) NewDeleteLocalDocumentOptions 

func (*CloudantV1) NewDeleteLocalDocumentOptions(db string, docID string) *DeleteLocalDocumentOptions

NewDeleteLocalDocumentOptions : Instantiate DeleteLocalDocumentOptions

func (*CloudantV1) NewDeleteReplicationDocumentOptions 

func (*CloudantV1) NewDeleteReplicationDocumentOptions(docID string) *DeleteReplicationDocumentOptions

NewDeleteReplicationDocumentOptions : Instantiate DeleteReplicationDocumentOptions

func (*CloudantV1) NewDesignDocumentViewsMapReduce added in v0.0.27 

func (*CloudantV1) NewDesignDocumentViewsMapReduce(mapVar string) (_model *DesignDocumentViewsMapReduce, err error)

NewDesignDocumentViewsMapReduce : Instantiate DesignDocumentViewsMapReduce (Generic Model Constructor)

func (*CloudantV1) NewDocumentRevisionStatus added in v0.0.27 

func (*CloudantV1) NewDocumentRevisionStatus(rev string, status string) (_model *DocumentRevisionStatus, err error)

NewDocumentRevisionStatus : Instantiate DocumentRevisionStatus (Generic Model Constructor)

func (*CloudantV1) NewGetActiveTasksOptions 

func (*CloudantV1) NewGetActiveTasksOptions() *GetActiveTasksOptions

NewGetActiveTasksOptions : Instantiate GetActiveTasksOptions

func (*CloudantV1) NewGetActivityTrackerEventsOptions added in v0.0.32 

func (*CloudantV1) NewGetActivityTrackerEventsOptions() *GetActivityTrackerEventsOptions

NewGetActivityTrackerEventsOptions : Instantiate GetActivityTrackerEventsOptions

func (*CloudantV1) NewGetAllDbsOptions 

func (*CloudantV1) NewGetAllDbsOptions() *GetAllDbsOptions

NewGetAllDbsOptions : Instantiate GetAllDbsOptions

func (*CloudantV1) NewGetAttachmentOptions 

func (*CloudantV1) NewGetAttachmentOptions(db string, docID string, attachmentName string) *GetAttachmentOptions

NewGetAttachmentOptions : Instantiate GetAttachmentOptions

func (*CloudantV1) NewGetCapacityThroughputInformationOptions added in v0.0.27 

func (*CloudantV1) NewGetCapacityThroughputInformationOptions() *GetCapacityThroughputInformationOptions

NewGetCapacityThroughputInformationOptions : Instantiate GetCapacityThroughputInformationOptions

func (*CloudantV1) NewGetCorsInformationOptions 

func (*CloudantV1) NewGetCorsInformationOptions() *GetCorsInformationOptions

NewGetCorsInformationOptions : Instantiate GetCorsInformationOptions

func (*CloudantV1) NewGetCurrentThroughputInformationOptions added in v0.0.27 

func (*CloudantV1) NewGetCurrentThroughputInformationOptions() *GetCurrentThroughputInformationOptions

NewGetCurrentThroughputInformationOptions : Instantiate GetCurrentThroughputInformationOptions

func (*CloudantV1) NewGetDatabaseInformationOptions 

func (*CloudantV1) NewGetDatabaseInformationOptions(db string) *GetDatabaseInformationOptions

NewGetDatabaseInformationOptions : Instantiate GetDatabaseInformationOptions

func (*CloudantV1) NewGetDbUpdatesOptions 

func (*CloudantV1) NewGetDbUpdatesOptions() *GetDbUpdatesOptions

NewGetDbUpdatesOptions : Instantiate GetDbUpdatesOptions

func (*CloudantV1) NewGetDesignDocumentInformationOptions 

func (*CloudantV1) NewGetDesignDocumentInformationOptions(db string, ddoc string) *GetDesignDocumentInformationOptions

NewGetDesignDocumentInformationOptions : Instantiate GetDesignDocumentInformationOptions

func (*CloudantV1) NewGetDesignDocumentOptions 

func (*CloudantV1) NewGetDesignDocumentOptions(db string, ddoc string) *GetDesignDocumentOptions

NewGetDesignDocumentOptions : Instantiate GetDesignDocumentOptions

func (*CloudantV1) NewGetDocumentOptions 

func (*CloudantV1) NewGetDocumentOptions(db string, docID string) *GetDocumentOptions

NewGetDocumentOptions : Instantiate GetDocumentOptions

func (*CloudantV1) NewGetDocumentShardsInfoOptions 

func (*CloudantV1) NewGetDocumentShardsInfoOptions(db string, docID string) *GetDocumentShardsInfoOptions

NewGetDocumentShardsInfoOptions : Instantiate GetDocumentShardsInfoOptions

func (*CloudantV1) NewGetIndexesInformationOptions 

func (*CloudantV1) NewGetIndexesInformationOptions(db string) *GetIndexesInformationOptions

NewGetIndexesInformationOptions : Instantiate GetIndexesInformationOptions

func (*CloudantV1) NewGetLocalDocumentOptions 

func (*CloudantV1) NewGetLocalDocumentOptions(db string, docID string) *GetLocalDocumentOptions

NewGetLocalDocumentOptions : Instantiate GetLocalDocumentOptions

func (*CloudantV1) NewGetMembershipInformationOptions 

func (*CloudantV1) NewGetMembershipInformationOptions() *GetMembershipInformationOptions

NewGetMembershipInformationOptions : Instantiate GetMembershipInformationOptions

func (*CloudantV1) NewGetPartitionInformationOptions 

func (*CloudantV1) NewGetPartitionInformationOptions(db string, partitionKey string) *GetPartitionInformationOptions

NewGetPartitionInformationOptions : Instantiate GetPartitionInformationOptions

func (*CloudantV1) NewGetReplicationDocumentOptions 

func (*CloudantV1) NewGetReplicationDocumentOptions(docID string) *GetReplicationDocumentOptions

NewGetReplicationDocumentOptions : Instantiate GetReplicationDocumentOptions

func (*CloudantV1) NewGetSchedulerDocsOptions 

func (*CloudantV1) NewGetSchedulerDocsOptions() *GetSchedulerDocsOptions

NewGetSchedulerDocsOptions : Instantiate GetSchedulerDocsOptions

func (*CloudantV1) NewGetSchedulerDocumentOptions 

func (*CloudantV1) NewGetSchedulerDocumentOptions(docID string) *GetSchedulerDocumentOptions

NewGetSchedulerDocumentOptions : Instantiate GetSchedulerDocumentOptions

func (*CloudantV1) NewGetSchedulerJobOptions 

func (*CloudantV1) NewGetSchedulerJobOptions(jobID string) *GetSchedulerJobOptions

NewGetSchedulerJobOptions : Instantiate GetSchedulerJobOptions

func (*CloudantV1) NewGetSchedulerJobsOptions 

func (*CloudantV1) NewGetSchedulerJobsOptions() *GetSchedulerJobsOptions

NewGetSchedulerJobsOptions : Instantiate GetSchedulerJobsOptions

func (*CloudantV1) NewGetSearchInfoOptions 

func (*CloudantV1) NewGetSearchInfoOptions(db string, ddoc string, index string) *GetSearchInfoOptions

NewGetSearchInfoOptions : Instantiate GetSearchInfoOptions

func (*CloudantV1) NewGetSecurityOptions 

func (*CloudantV1) NewGetSecurityOptions(db string) *GetSecurityOptions

NewGetSecurityOptions : Instantiate GetSecurityOptions

func (*CloudantV1) NewGetServerInformationOptions 

func (*CloudantV1) NewGetServerInformationOptions() *GetServerInformationOptions

NewGetServerInformationOptions : Instantiate GetServerInformationOptions

func (*CloudantV1) NewGetSessionInformationOptions 

func (*CloudantV1) NewGetSessionInformationOptions() *GetSessionInformationOptions

NewGetSessionInformationOptions : Instantiate GetSessionInformationOptions

func (*CloudantV1) NewGetShardsInformationOptions 

func (*CloudantV1) NewGetShardsInformationOptions(db string) *GetShardsInformationOptions

NewGetShardsInformationOptions : Instantiate GetShardsInformationOptions

func (*CloudantV1) NewGetUpInformationOptions 

func (*CloudantV1) NewGetUpInformationOptions() *GetUpInformationOptions

NewGetUpInformationOptions : Instantiate GetUpInformationOptions

func (*CloudantV1) NewGetUuidsOptions 

func (*CloudantV1) NewGetUuidsOptions() *GetUuidsOptions

NewGetUuidsOptions : Instantiate GetUuidsOptions

func (*CloudantV1) NewHeadAttachmentOptions 

func (*CloudantV1) NewHeadAttachmentOptions(db string, docID string, attachmentName string) *HeadAttachmentOptions

NewHeadAttachmentOptions : Instantiate HeadAttachmentOptions

func (*CloudantV1) NewHeadDatabaseOptions 

func (*CloudantV1) NewHeadDatabaseOptions(db string) *HeadDatabaseOptions

NewHeadDatabaseOptions : Instantiate HeadDatabaseOptions

func (*CloudantV1) NewHeadDesignDocumentOptions 

func (*CloudantV1) NewHeadDesignDocumentOptions(db string, ddoc string) *HeadDesignDocumentOptions

NewHeadDesignDocumentOptions : Instantiate HeadDesignDocumentOptions

func (*CloudantV1) NewHeadDocumentOptions 

func (*CloudantV1) NewHeadDocumentOptions(db string, docID string) *HeadDocumentOptions

NewHeadDocumentOptions : Instantiate HeadDocumentOptions

func (*CloudantV1) NewHeadLocalDocumentOptions added in v0.0.29 

func (*CloudantV1) NewHeadLocalDocumentOptions(db string, docID string) *HeadLocalDocumentOptions

NewHeadLocalDocumentOptions : Instantiate HeadLocalDocumentOptions

func (*CloudantV1) NewHeadReplicationDocumentOptions 

func (*CloudantV1) NewHeadReplicationDocumentOptions(docID string) *HeadReplicationDocumentOptions

NewHeadReplicationDocumentOptions : Instantiate HeadReplicationDocumentOptions

func (*CloudantV1) NewHeadSchedulerDocumentOptions added in v0.0.29 

func (*CloudantV1) NewHeadSchedulerDocumentOptions(docID string) *HeadSchedulerDocumentOptions

NewHeadSchedulerDocumentOptions : Instantiate HeadSchedulerDocumentOptions

func (*CloudantV1) NewHeadSchedulerJobOptions 

func (*CloudantV1) NewHeadSchedulerJobOptions(jobID string) *HeadSchedulerJobOptions

NewHeadSchedulerJobOptions : Instantiate HeadSchedulerJobOptions

func (*CloudantV1) NewHeadUpInformationOptions added in v0.0.29 

func (*CloudantV1) NewHeadUpInformationOptions() *HeadUpInformationOptions

NewHeadUpInformationOptions : Instantiate HeadUpInformationOptions

func (*CloudantV1) NewPostActivityTrackerEventsOptions added in v0.0.32 

func (*CloudantV1) NewPostActivityTrackerEventsOptions(types []string) *PostActivityTrackerEventsOptions

NewPostActivityTrackerEventsOptions : Instantiate PostActivityTrackerEventsOptions

func (*CloudantV1) NewPostAllDocsOptions 

func (*CloudantV1) NewPostAllDocsOptions(db string) *PostAllDocsOptions

NewPostAllDocsOptions : Instantiate PostAllDocsOptions

func (*CloudantV1) NewPostAllDocsQueriesOptions 

func (*CloudantV1) NewPostAllDocsQueriesOptions(db string, queries []AllDocsQuery) *PostAllDocsQueriesOptions

NewPostAllDocsQueriesOptions : Instantiate PostAllDocsQueriesOptions

func (*CloudantV1) NewPostApiKeysOptions 

func (*CloudantV1) NewPostApiKeysOptions() *PostApiKeysOptions

NewPostApiKeysOptions : Instantiate PostApiKeysOptions

func (*CloudantV1) NewPostBulkDocsOptions 

func (*CloudantV1) NewPostBulkDocsOptions(db string) *PostBulkDocsOptions

NewPostBulkDocsOptions : Instantiate PostBulkDocsOptions

func (*CloudantV1) NewPostBulkGetOptions 

func (*CloudantV1) NewPostBulkGetOptions(db string, docs []BulkGetQueryDocument) *PostBulkGetOptions

NewPostBulkGetOptions : Instantiate PostBulkGetOptions

func (*CloudantV1) NewPostChangesOptions 

func (*CloudantV1) NewPostChangesOptions(db string) *PostChangesOptions

NewPostChangesOptions : Instantiate PostChangesOptions

func (*CloudantV1) NewPostDbsInfoOptions 

func (*CloudantV1) NewPostDbsInfoOptions(keys []string) *PostDbsInfoOptions

NewPostDbsInfoOptions : Instantiate PostDbsInfoOptions

func (*CloudantV1) NewPostDesignDocsOptions 

func (*CloudantV1) NewPostDesignDocsOptions(db string) *PostDesignDocsOptions

NewPostDesignDocsOptions : Instantiate PostDesignDocsOptions

func (*CloudantV1) NewPostDesignDocsQueriesOptions 

func (*CloudantV1) NewPostDesignDocsQueriesOptions(db string, queries []AllDocsQuery) *PostDesignDocsQueriesOptions

NewPostDesignDocsQueriesOptions : Instantiate PostDesignDocsQueriesOptions

func (*CloudantV1) NewPostDocumentOptions 

func (*CloudantV1) NewPostDocumentOptions(db string) *PostDocumentOptions

NewPostDocumentOptions : Instantiate PostDocumentOptions

func (*CloudantV1) NewPostExplainOptions 

func (*CloudantV1) NewPostExplainOptions(db string, selector map[string]interface{}) *PostExplainOptions

NewPostExplainOptions : Instantiate PostExplainOptions

func (*CloudantV1) NewPostFindOptions 

func (*CloudantV1) NewPostFindOptions(db string, selector map[string]interface{}) *PostFindOptions

NewPostFindOptions : Instantiate PostFindOptions

func (*CloudantV1) NewPostIndexOptions 

func (*CloudantV1) NewPostIndexOptions(db string, index *IndexDefinition) *PostIndexOptions

NewPostIndexOptions : Instantiate PostIndexOptions

func (*CloudantV1) NewPostPartitionAllDocsOptions 

func (*CloudantV1) NewPostPartitionAllDocsOptions(db string, partitionKey string) *PostPartitionAllDocsOptions

NewPostPartitionAllDocsOptions : Instantiate PostPartitionAllDocsOptions

func (*CloudantV1) NewPostPartitionExplainOptions added in v0.6.0 

func (*CloudantV1) NewPostPartitionExplainOptions(db string, partitionKey string, selector map[string]interface{}) *PostPartitionExplainOptions

NewPostPartitionExplainOptions : Instantiate PostPartitionExplainOptions

func (*CloudantV1) NewPostPartitionFindOptions 

func (*CloudantV1) NewPostPartitionFindOptions(db string, partitionKey string, selector map[string]interface{}) *PostPartitionFindOptions

NewPostPartitionFindOptions : Instantiate PostPartitionFindOptions

func (*CloudantV1) NewPostPartitionSearchOptions 

func (*CloudantV1) NewPostPartitionSearchOptions(db string, partitionKey string, ddoc string, index string, query string) *PostPartitionSearchOptions

NewPostPartitionSearchOptions : Instantiate PostPartitionSearchOptions

func (*CloudantV1) NewPostPartitionViewOptions 

func (*CloudantV1) NewPostPartitionViewOptions(db string, partitionKey string, ddoc string, view string) *PostPartitionViewOptions

NewPostPartitionViewOptions : Instantiate PostPartitionViewOptions

func (*CloudantV1) NewPostRevsDiffOptions 

func (*CloudantV1) NewPostRevsDiffOptions(db string, documentRevisions map[string][]string) *PostRevsDiffOptions

NewPostRevsDiffOptions : Instantiate PostRevsDiffOptions

func (*CloudantV1) NewPostSearchAnalyzeOptions 

func (*CloudantV1) NewPostSearchAnalyzeOptions(analyzer string, text string) *PostSearchAnalyzeOptions

NewPostSearchAnalyzeOptions : Instantiate PostSearchAnalyzeOptions

func (*CloudantV1) NewPostSearchOptions 

func (*CloudantV1) NewPostSearchOptions(db string, ddoc string, index string, query string) *PostSearchOptions

NewPostSearchOptions : Instantiate PostSearchOptions

func (*CloudantV1) NewPostViewOptions 

func (*CloudantV1) NewPostViewOptions(db string, ddoc string, view string) *PostViewOptions

NewPostViewOptions : Instantiate PostViewOptions

func (*CloudantV1) NewPostViewQueriesOptions 

func (*CloudantV1) NewPostViewQueriesOptions(db string, ddoc string, view string, queries []ViewQuery) *PostViewQueriesOptions

NewPostViewQueriesOptions : Instantiate PostViewQueriesOptions

func (*CloudantV1) NewPutAttachmentOptions 

func (*CloudantV1) NewPutAttachmentOptions(db string, docID string, attachmentName string, attachment io.ReadCloser, contentType string) *PutAttachmentOptions

NewPutAttachmentOptions : Instantiate PutAttachmentOptions

func (*CloudantV1) NewPutCapacityThroughputConfigurationOptions added in v0.0.32 

func (*CloudantV1) NewPutCapacityThroughputConfigurationOptions(blocks int64) *PutCapacityThroughputConfigurationOptions

NewPutCapacityThroughputConfigurationOptions : Instantiate PutCapacityThroughputConfigurationOptions

func (*CloudantV1) NewPutCloudantSecurityConfigurationOptions added in v0.0.24 

func (*CloudantV1) NewPutCloudantSecurityConfigurationOptions(db string, cloudant map[string][]string) *PutCloudantSecurityConfigurationOptions

NewPutCloudantSecurityConfigurationOptions : Instantiate PutCloudantSecurityConfigurationOptions

func (*CloudantV1) NewPutCorsConfigurationOptions 

func (*CloudantV1) NewPutCorsConfigurationOptions(origins []string) *PutCorsConfigurationOptions

NewPutCorsConfigurationOptions : Instantiate PutCorsConfigurationOptions

func (*CloudantV1) NewPutDatabaseOptions 

func (*CloudantV1) NewPutDatabaseOptions(db string) *PutDatabaseOptions

NewPutDatabaseOptions : Instantiate PutDatabaseOptions

func (*CloudantV1) NewPutDesignDocumentOptions 

func (*CloudantV1) NewPutDesignDocumentOptions(db string, ddoc string, designDocument *DesignDocument) *PutDesignDocumentOptions

NewPutDesignDocumentOptions : Instantiate PutDesignDocumentOptions

func (*CloudantV1) NewPutDocumentOptions 

func (*CloudantV1) NewPutDocumentOptions(db string, docID string) *PutDocumentOptions

NewPutDocumentOptions : Instantiate PutDocumentOptions

func (*CloudantV1) NewPutLocalDocumentOptions 

func (*CloudantV1) NewPutLocalDocumentOptions(db string, docID string) *PutLocalDocumentOptions

NewPutLocalDocumentOptions : Instantiate PutLocalDocumentOptions

func (*CloudantV1) NewPutReplicationDocumentOptions 

func (*CloudantV1) NewPutReplicationDocumentOptions(docID string, replicationDocument *ReplicationDocument) *PutReplicationDocumentOptions

NewPutReplicationDocumentOptions : Instantiate PutReplicationDocumentOptions

func (*CloudantV1) NewPutSecurityOptions 

func (*CloudantV1) NewPutSecurityOptions(db string) *PutSecurityOptions

NewPutSecurityOptions : Instantiate PutSecurityOptions

func (*CloudantV1) NewReplicationDatabase added in v0.0.27 

func (*CloudantV1) NewReplicationDatabase(url string) (_model *ReplicationDatabase, err error)

NewReplicationDatabase : Instantiate ReplicationDatabase (Generic Model Constructor)

func (*CloudantV1) NewReplicationDatabaseAuthBasic added in v0.0.38 

func (*CloudantV1) NewReplicationDatabaseAuthBasic(password string, username string) (_model *ReplicationDatabaseAuthBasic, err error)

NewReplicationDatabaseAuthBasic : Instantiate ReplicationDatabaseAuthBasic (Generic Model Constructor)

func (*CloudantV1) NewReplicationDatabaseAuthIam added in v0.0.25 

func (*CloudantV1) NewReplicationDatabaseAuthIam(apiKey string) (_model *ReplicationDatabaseAuthIam, err error)

NewReplicationDatabaseAuthIam : Instantiate ReplicationDatabaseAuthIam (Generic Model Constructor)

func (*CloudantV1) NewReplicationDocument added in v0.0.25 

func (*CloudantV1) NewReplicationDocument(source *ReplicationDatabase, target *ReplicationDatabase) (_model *ReplicationDocument, err error)

NewReplicationDocument : Instantiate ReplicationDocument (Generic Model Constructor)

func (*CloudantV1) NewRevisions added in v0.0.27 

func (*CloudantV1) NewRevisions(ids []string, start int64) (_model *Revisions, err error)

NewRevisions : Instantiate Revisions (Generic Model Constructor)

func (*CloudantV1) NewSearchIndexDefinition 

func (*CloudantV1) NewSearchIndexDefinition(index string) (_model *SearchIndexDefinition, err error)

NewSearchIndexDefinition : Instantiate SearchIndexDefinition (Generic Model Constructor)

func (*CloudantV1) NewUserContext added in v0.0.27 

func (*CloudantV1) NewUserContext(name string, roles []string) (_model *UserContext, err error)

NewUserContext : Instantiate UserContext (Generic Model Constructor)

func (*CloudantV1) PostActivityTrackerEvents added in v0.0.32 

func (cloudant *CloudantV1) PostActivityTrackerEvents(postActivityTrackerEventsOptions *PostActivityTrackerEventsOptions) (result *Ok, response *core.DetailedResponse, err error)

PostActivityTrackerEvents : Modify Activity Tracker events configuration Configure event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.

func (*CloudantV1) PostActivityTrackerEventsWithContext added in v0.0.32 

func (cloudant *CloudantV1) PostActivityTrackerEventsWithContext(ctx context.Context, postActivityTrackerEventsOptions *PostActivityTrackerEventsOptions) (result *Ok, response *core.DetailedResponse, err error)

PostActivityTrackerEventsWithContext is an alternate form of the PostActivityTrackerEvents method which supports a Context parameter

func (*CloudantV1) PostAllDocs 

func (cloudant *CloudantV1) PostAllDocs(postAllDocsOptions *PostAllDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostAllDocs : Query a list of all documents in a database Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.

func (*CloudantV1) PostAllDocsAsStream 

func (cloudant *CloudantV1) PostAllDocsAsStream(postAllDocsOptions *PostAllDocsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostAllDocsAsStream : Query a list of all documents in a database as stream Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.

func (*CloudantV1) PostAllDocsAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostAllDocsAsStreamWithContext(ctx context.Context, postAllDocsOptions *PostAllDocsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostAllDocsAsStreamWithContext is an alternate form of the PostAllDocsAsStream method which supports a Context parameter

func (*CloudantV1) PostAllDocsQueries 

func (cloudant *CloudantV1) PostAllDocsQueries(postAllDocsQueriesOptions *PostAllDocsQueriesOptions) (result *AllDocsQueriesResult, response *core.DetailedResponse, err error)

PostAllDocsQueries : Multi-query the list of all documents in a database Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single `_all_docs` request. This enables you to request multiple queries in a single request, in place of multiple `POST /{db}/_all_docs` requests.

func (*CloudantV1) PostAllDocsQueriesAsStream 

func (cloudant *CloudantV1) PostAllDocsQueriesAsStream(postAllDocsQueriesOptions *PostAllDocsQueriesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostAllDocsQueriesAsStream : Multi-query the list of all documents in a database as stream Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single `_all_docs` request. This enables you to request multiple queries in a single request, in place of multiple `POST /{db}/_all_docs` requests.

func (*CloudantV1) PostAllDocsQueriesAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostAllDocsQueriesAsStreamWithContext(ctx context.Context, postAllDocsQueriesOptions *PostAllDocsQueriesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostAllDocsQueriesAsStreamWithContext is an alternate form of the PostAllDocsQueriesAsStream method which supports a Context parameter

func (*CloudantV1) PostAllDocsQueriesWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostAllDocsQueriesWithContext(ctx context.Context, postAllDocsQueriesOptions *PostAllDocsQueriesOptions) (result *AllDocsQueriesResult, response *core.DetailedResponse, err error)

PostAllDocsQueriesWithContext is an alternate form of the PostAllDocsQueries method which supports a Context parameter

func (*CloudantV1) PostAllDocsWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostAllDocsWithContext(ctx context.Context, postAllDocsOptions *PostAllDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostAllDocsWithContext is an alternate form of the PostAllDocs method which supports a Context parameter

func (*CloudantV1) PostApiKeys 

func (cloudant *CloudantV1) PostApiKeys(postApiKeysOptions *PostApiKeysOptions) (result *ApiKeysResult, response *core.DetailedResponse, err error)

PostApiKeys : Generates API keys for apps or persons to enable database access Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant account for that person or application. An API key is a randomly generated username and password. The key is given the wanted access permissions for a database.

func (*CloudantV1) PostApiKeysWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostApiKeysWithContext(ctx context.Context, postApiKeysOptions *PostApiKeysOptions) (result *ApiKeysResult, response *core.DetailedResponse, err error)

PostApiKeysWithContext is an alternate form of the PostApiKeys method which supports a Context parameter

func (*CloudantV1) PostBulkDocs 

func (cloudant *CloudantV1) PostBulkDocs(postBulkDocsOptions *PostBulkDocsOptions) (result []DocumentResult, response *core.DetailedResponse, err error)

PostBulkDocs : Bulk modify multiple documents in a database The bulk document API allows you to create, update, and delete multiple documents at the same time within a single request. The basic operation is similar to creating, updating, or deleting a single document, except that you batch the document structure and information.

func (*CloudantV1) PostBulkDocsWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostBulkDocsWithContext(ctx context.Context, postBulkDocsOptions *PostBulkDocsOptions) (result []DocumentResult, response *core.DetailedResponse, err error)

PostBulkDocsWithContext is an alternate form of the PostBulkDocs method which supports a Context parameter

func (*CloudantV1) PostBulkGet 

func (cloudant *CloudantV1) PostBulkGet(postBulkGetOptions *PostBulkGetOptions) (result *BulkGetResult, response *core.DetailedResponse, err error)

PostBulkGet : Bulk query revision information for multiple documents Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

func (*CloudantV1) PostBulkGetAsMixed 

func (cloudant *CloudantV1) PostBulkGetAsMixed(postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsMixed : Bulk query revision information for multiple documents as mixed Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

func (*CloudantV1) PostBulkGetAsMixedWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostBulkGetAsMixedWithContext(ctx context.Context, postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsMixedWithContext is an alternate form of the PostBulkGetAsMixed method which supports a Context parameter

func (*CloudantV1) PostBulkGetAsRelated 

func (cloudant *CloudantV1) PostBulkGetAsRelated(postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsRelated : Bulk query revision information for multiple documents as related Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

func (*CloudantV1) PostBulkGetAsRelatedWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostBulkGetAsRelatedWithContext(ctx context.Context, postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsRelatedWithContext is an alternate form of the PostBulkGetAsRelated method which supports a Context parameter

func (*CloudantV1) PostBulkGetAsStream 

func (cloudant *CloudantV1) PostBulkGetAsStream(postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsStream : Bulk query revision information for multiple documents as stream Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

func (*CloudantV1) PostBulkGetAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostBulkGetAsStreamWithContext(ctx context.Context, postBulkGetOptions *PostBulkGetOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostBulkGetAsStreamWithContext is an alternate form of the PostBulkGetAsStream method which supports a Context parameter

func (*CloudantV1) PostBulkGetWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostBulkGetWithContext(ctx context.Context, postBulkGetOptions *PostBulkGetOptions) (result *BulkGetResult, response *core.DetailedResponse, err error)

PostBulkGetWithContext is an alternate form of the PostBulkGet method which supports a Context parameter

func (*CloudantV1) PostChanges 

func (cloudant *CloudantV1) PostChanges(postChangesOptions *PostChangesOptions) (result *ChangesResult, response *core.DetailedResponse, err error)

PostChanges : Query the database document changes feed Requests the database changes feed in the same way as `GET /{db}/_changes` does. It is widely used with the `filter` query parameter because it allows one to pass more information to the filter.

### Note

Before using the changes feed we recommend reading the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-faq-using-changes-feed) to understand the limitations and appropriate use cases.

func (*CloudantV1) PostChangesAsStream 

func (cloudant *CloudantV1) PostChangesAsStream(postChangesOptions *PostChangesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostChangesAsStream : Query the database document changes feed as stream Requests the database changes feed in the same way as `GET /{db}/_changes` does. It is widely used with the `filter` query parameter because it allows one to pass more information to the filter.

### Note

Before using the changes feed we recommend reading the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-faq-using-changes-feed) to understand the limitations and appropriate use cases.

func (*CloudantV1) PostChangesAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostChangesAsStreamWithContext(ctx context.Context, postChangesOptions *PostChangesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostChangesAsStreamWithContext is an alternate form of the PostChangesAsStream method which supports a Context parameter

func (*CloudantV1) PostChangesWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostChangesWithContext(ctx context.Context, postChangesOptions *PostChangesOptions) (result *ChangesResult, response *core.DetailedResponse, err error)

PostChangesWithContext is an alternate form of the PostChanges method which supports a Context parameter

func (*CloudantV1) PostDbsInfo 

func (cloudant *CloudantV1) PostDbsInfo(postDbsInfoOptions *PostDbsInfoOptions) (result []DbsInfoResult, response *core.DetailedResponse, err error)

PostDbsInfo : Query information about multiple databases This operation enables you to request information about multiple databases in a single request, instead of issuing multiple `GET /{db}` requests. It returns a list that contains an information object for each database specified in the request.

func (*CloudantV1) PostDbsInfoWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostDbsInfoWithContext(ctx context.Context, postDbsInfoOptions *PostDbsInfoOptions) (result []DbsInfoResult, response *core.DetailedResponse, err error)

PostDbsInfoWithContext is an alternate form of the PostDbsInfo method which supports a Context parameter

func (*CloudantV1) PostDesignDocs 

func (cloudant *CloudantV1) PostDesignDocs(postDesignDocsOptions *PostDesignDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostDesignDocs : Query a list of all design documents in a database Queries the index of all design document IDs. The results matching the request body parameters are returned in a JSON object, including a list of matching design documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all design documents in the database are returned. Optionally, the design document content or additional metadata can be included in the response.

func (*CloudantV1) PostDesignDocsQueries 

func (cloudant *CloudantV1) PostDesignDocsQueries(postDesignDocsQueriesOptions *PostDesignDocsQueriesOptions) (result *AllDocsQueriesResult, response *core.DetailedResponse, err error)

PostDesignDocsQueries : Multi-query the list of all design documents This operation runs multiple view queries of all design documents in the database. This operation enables you to request numerous queries in a single request, in place of multiple POST `/{db}/_design_docs` requests.

func (*CloudantV1) PostDesignDocsQueriesWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostDesignDocsQueriesWithContext(ctx context.Context, postDesignDocsQueriesOptions *PostDesignDocsQueriesOptions) (result *AllDocsQueriesResult, response *core.DetailedResponse, err error)

PostDesignDocsQueriesWithContext is an alternate form of the PostDesignDocsQueries method which supports a Context parameter

func (*CloudantV1) PostDesignDocsWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostDesignDocsWithContext(ctx context.Context, postDesignDocsOptions *PostDesignDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostDesignDocsWithContext is an alternate form of the PostDesignDocs method which supports a Context parameter

func (*CloudantV1) PostDocument 

func (cloudant *CloudantV1) PostDocument(postDocumentOptions *PostDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PostDocument : Create or modify a document in a database Creates or modifies a document in the specified database by using the supplied JSON document.

For creation, you may specify the document ID but you should not specify the revision. If you don't specify the document ID, then the server generates an ID for your document.

For modification, you must specify the document ID and a revision identifier in the JSON document.

If your document ID includes the `_local/` or `_design/` prefix, then this operation creates or modifies a local or a design document respectively.

func (*CloudantV1) PostDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostDocumentWithContext(ctx context.Context, postDocumentOptions *PostDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PostDocumentWithContext is an alternate form of the PostDocument method which supports a Context parameter

func (*CloudantV1) PostExplain 

func (cloudant *CloudantV1) PostExplain(postExplainOptions *PostExplainOptions) (result *ExplainResult, response *core.DetailedResponse, err error)

PostExplain : Retrieve information about which index is used for a query Shows which index is being used by the query. Parameters are the same as the [`_find` endpoint](#postfind).

func (*CloudantV1) PostExplainWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostExplainWithContext(ctx context.Context, postExplainOptions *PostExplainOptions) (result *ExplainResult, response *core.DetailedResponse, err error)

PostExplainWithContext is an alternate form of the PostExplain method which supports a Context parameter

func (*CloudantV1) PostFind 

func (cloudant *CloudantV1) PostFind(postFindOptions *PostFindOptions) (result *FindResult, response *core.DetailedResponse, err error)

PostFind : Query an index by using selector syntax Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint.

Queries without an appropriate backing index will fallback to using the built-in `_all_docs` index. This is not recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body will include a warning field recommending that an index is created.

func (*CloudantV1) PostFindAsStream 

func (cloudant *CloudantV1) PostFindAsStream(postFindOptions *PostFindOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostFindAsStream : Query an index by using selector syntax as stream Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint.

Queries without an appropriate backing index will fallback to using the built-in `_all_docs` index. This is not recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body will include a warning field recommending that an index is created.

func (*CloudantV1) PostFindAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostFindAsStreamWithContext(ctx context.Context, postFindOptions *PostFindOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostFindAsStreamWithContext is an alternate form of the PostFindAsStream method which supports a Context parameter

func (*CloudantV1) PostFindWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostFindWithContext(ctx context.Context, postFindOptions *PostFindOptions) (result *FindResult, response *core.DetailedResponse, err error)

PostFindWithContext is an alternate form of the PostFind method which supports a Context parameter

func (*CloudantV1) PostIndex 

func (cloudant *CloudantV1) PostIndex(postIndexOptions *PostIndexOptions) (result *IndexResult, response *core.DetailedResponse, err error)

PostIndex : Create a new index on a database Create a new index on a database.

func (*CloudantV1) PostIndexWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostIndexWithContext(ctx context.Context, postIndexOptions *PostIndexOptions) (result *IndexResult, response *core.DetailedResponse, err error)

PostIndexWithContext is an alternate form of the PostIndex method which supports a Context parameter

func (*CloudantV1) PostPartitionAllDocs 

func (cloudant *CloudantV1) PostPartitionAllDocs(postPartitionAllDocsOptions *PostPartitionAllDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostPartitionAllDocs : Query a list of all documents in a database partition Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.

func (*CloudantV1) PostPartitionAllDocsAsStream 

func (cloudant *CloudantV1) PostPartitionAllDocsAsStream(postPartitionAllDocsOptions *PostPartitionAllDocsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionAllDocsAsStream : Query a list of all documents in a database partition as stream Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.

func (*CloudantV1) PostPartitionAllDocsAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionAllDocsAsStreamWithContext(ctx context.Context, postPartitionAllDocsOptions *PostPartitionAllDocsOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionAllDocsAsStreamWithContext is an alternate form of the PostPartitionAllDocsAsStream method which supports a Context parameter

func (*CloudantV1) PostPartitionAllDocsWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionAllDocsWithContext(ctx context.Context, postPartitionAllDocsOptions *PostPartitionAllDocsOptions) (result *AllDocsResult, response *core.DetailedResponse, err error)

PostPartitionAllDocsWithContext is an alternate form of the PostPartitionAllDocs method which supports a Context parameter

func (*CloudantV1) PostPartitionExplain added in v0.6.0 

func (cloudant *CloudantV1) PostPartitionExplain(postPartitionExplainOptions *PostPartitionExplainOptions) (result *ExplainResult, response *core.DetailedResponse, err error)

PostPartitionExplain : Retrieve information about which partition index is used for a query Shows which index is being used by the query. Parameters are the same as the [`/{db}/_partition/{partition_key}/_find` endpoint](#postpartitionfind-queries).

func (*CloudantV1) PostPartitionExplainWithContext added in v0.6.0 

func (cloudant *CloudantV1) PostPartitionExplainWithContext(ctx context.Context, postPartitionExplainOptions *PostPartitionExplainOptions) (result *ExplainResult, response *core.DetailedResponse, err error)

PostPartitionExplainWithContext is an alternate form of the PostPartitionExplain method which supports a Context parameter

func (*CloudantV1) PostPartitionFind 

func (cloudant *CloudantV1) PostPartitionFind(postPartitionFindOptions *PostPartitionFindOptions) (result *FindResult, response *core.DetailedResponse, err error)

PostPartitionFind : Query a database partition index by using selector syntax Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint.

Queries without an appropriate backing index will fallback to using the built-in `_all_docs` index. This is not recommended because it has a noticeable performance impact causing a full scan of the partition with each request. In this case the response body will include a warning field recommending that an index is created.

func (*CloudantV1) PostPartitionFindAsStream 

func (cloudant *CloudantV1) PostPartitionFindAsStream(postPartitionFindOptions *PostPartitionFindOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionFindAsStream : Query a database partition index by using selector syntax as stream Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint.

Queries without an appropriate backing index will fallback to using the built-in `_all_docs` index. This is not recommended because it has a noticeable performance impact causing a full scan of the partition with each request. In this case the response body will include a warning field recommending that an index is created.

func (*CloudantV1) PostPartitionFindAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionFindAsStreamWithContext(ctx context.Context, postPartitionFindOptions *PostPartitionFindOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionFindAsStreamWithContext is an alternate form of the PostPartitionFindAsStream method which supports a Context parameter

func (*CloudantV1) PostPartitionFindWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionFindWithContext(ctx context.Context, postPartitionFindOptions *PostPartitionFindOptions) (result *FindResult, response *core.DetailedResponse, err error)

PostPartitionFindWithContext is an alternate form of the PostPartitionFind method which supports a Context parameter

func (*CloudantV1) PostPartitionSearch 

func (cloudant *CloudantV1) PostPartitionSearch(postPartitionSearchOptions *PostPartitionSearchOptions) (result *SearchResult, response *core.DetailedResponse, err error)

PostPartitionSearch : Query a database partition search index Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index.

func (*CloudantV1) PostPartitionSearchAsStream 

func (cloudant *CloudantV1) PostPartitionSearchAsStream(postPartitionSearchOptions *PostPartitionSearchOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionSearchAsStream : Query a database partition search index as stream Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index.

func (*CloudantV1) PostPartitionSearchAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionSearchAsStreamWithContext(ctx context.Context, postPartitionSearchOptions *PostPartitionSearchOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionSearchAsStreamWithContext is an alternate form of the PostPartitionSearchAsStream method which supports a Context parameter

func (*CloudantV1) PostPartitionSearchWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionSearchWithContext(ctx context.Context, postPartitionSearchOptions *PostPartitionSearchOptions) (result *SearchResult, response *core.DetailedResponse, err error)

PostPartitionSearchWithContext is an alternate form of the PostPartitionSearch method which supports a Context parameter

func (*CloudantV1) PostPartitionView 

func (cloudant *CloudantV1) PostPartitionView(postPartitionViewOptions *PostPartitionViewOptions) (result *ViewResult, response *core.DetailedResponse, err error)

PostPartitionView : Query a database partition MapReduce view function Runs the specified view function from the specified design document. Unlike `GET /{db}/_design/{ddoc}/_view/{view}` for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the `GET /{db}/_design/{ddoc}/_view/{view}` API.

func (*CloudantV1) PostPartitionViewAsStream 

func (cloudant *CloudantV1) PostPartitionViewAsStream(postPartitionViewOptions *PostPartitionViewOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionViewAsStream : Query a database partition MapReduce view function as stream Runs the specified view function from the specified design document. Unlike `GET /{db}/_design/{ddoc}/_view/{view}` for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the `GET /{db}/_design/{ddoc}/_view/{view}` API.

func (*CloudantV1) PostPartitionViewAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionViewAsStreamWithContext(ctx context.Context, postPartitionViewOptions *PostPartitionViewOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostPartitionViewAsStreamWithContext is an alternate form of the PostPartitionViewAsStream method which supports a Context parameter

func (*CloudantV1) PostPartitionViewWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostPartitionViewWithContext(ctx context.Context, postPartitionViewOptions *PostPartitionViewOptions) (result *ViewResult, response *core.DetailedResponse, err error)

PostPartitionViewWithContext is an alternate form of the PostPartitionView method which supports a Context parameter

func (*CloudantV1) PostRevsDiff 

func (cloudant *CloudantV1) PostRevsDiff(postRevsDiffOptions *PostRevsDiffOptions) (result map[string]RevsDiff, response *core.DetailedResponse, err error)

PostRevsDiff : Query the document revisions and possible ancestors missing from the database The replicator is the primary user of this operation. After receiving a set of new revision IDs from the source database, the replicator sends this set to the destination database's `_revs_diff` to find out which of them already exists there. It can then avoid fetching and sending already-known document bodies.

func (*CloudantV1) PostRevsDiffWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostRevsDiffWithContext(ctx context.Context, postRevsDiffOptions *PostRevsDiffOptions) (result map[string]RevsDiff, response *core.DetailedResponse, err error)

PostRevsDiffWithContext is an alternate form of the PostRevsDiff method which supports a Context parameter

func (*CloudantV1) PostSearch 

func (cloudant *CloudantV1) PostSearch(postSearchOptions *PostSearchOptions) (result *SearchResult, response *core.DetailedResponse, err error)

PostSearch : Query a search index Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.

func (*CloudantV1) PostSearchAnalyze 

func (cloudant *CloudantV1) PostSearchAnalyze(postSearchAnalyzeOptions *PostSearchAnalyzeOptions) (result *SearchAnalyzeResult, response *core.DetailedResponse, err error)

PostSearchAnalyze : Query tokenization of sample text Returns the results of analyzer tokenization of the provided sample text. This endpoint can be used for testing analyzer tokenization.

func (*CloudantV1) PostSearchAnalyzeWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostSearchAnalyzeWithContext(ctx context.Context, postSearchAnalyzeOptions *PostSearchAnalyzeOptions) (result *SearchAnalyzeResult, response *core.DetailedResponse, err error)

PostSearchAnalyzeWithContext is an alternate form of the PostSearchAnalyze method which supports a Context parameter

func (*CloudantV1) PostSearchAsStream 

func (cloudant *CloudantV1) PostSearchAsStream(postSearchOptions *PostSearchOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostSearchAsStream : Query a search index as stream Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.

func (*CloudantV1) PostSearchAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostSearchAsStreamWithContext(ctx context.Context, postSearchOptions *PostSearchOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostSearchAsStreamWithContext is an alternate form of the PostSearchAsStream method which supports a Context parameter

func (*CloudantV1) PostSearchWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostSearchWithContext(ctx context.Context, postSearchOptions *PostSearchOptions) (result *SearchResult, response *core.DetailedResponse, err error)

PostSearchWithContext is an alternate form of the PostSearch method which supports a Context parameter

func (*CloudantV1) PostView 

func (cloudant *CloudantV1) PostView(postViewOptions *PostViewOptions) (result *ViewResult, response *core.DetailedResponse, err error)

PostView : Query a MapReduce view This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.

func (*CloudantV1) PostViewAsStream 

func (cloudant *CloudantV1) PostViewAsStream(postViewOptions *PostViewOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostViewAsStream : Query a MapReduce view as stream This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.

func (*CloudantV1) PostViewAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostViewAsStreamWithContext(ctx context.Context, postViewOptions *PostViewOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostViewAsStreamWithContext is an alternate form of the PostViewAsStream method which supports a Context parameter

func (*CloudantV1) PostViewQueries 

func (cloudant *CloudantV1) PostViewQueries(postViewQueriesOptions *PostViewQueriesOptions) (result *ViewQueriesResult, response *core.DetailedResponse, err error)

PostViewQueries : Multi-query a MapReduce view This operation runs multiple specified view queries against the view function from the specified design document.

func (*CloudantV1) PostViewQueriesAsStream 

func (cloudant *CloudantV1) PostViewQueriesAsStream(postViewQueriesOptions *PostViewQueriesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostViewQueriesAsStream : Multi-query a MapReduce view as stream This operation runs multiple specified view queries against the view function from the specified design document.

func (*CloudantV1) PostViewQueriesAsStreamWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostViewQueriesAsStreamWithContext(ctx context.Context, postViewQueriesOptions *PostViewQueriesOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

PostViewQueriesAsStreamWithContext is an alternate form of the PostViewQueriesAsStream method which supports a Context parameter

func (*CloudantV1) PostViewQueriesWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostViewQueriesWithContext(ctx context.Context, postViewQueriesOptions *PostViewQueriesOptions) (result *ViewQueriesResult, response *core.DetailedResponse, err error)

PostViewQueriesWithContext is an alternate form of the PostViewQueries method which supports a Context parameter

func (*CloudantV1) PostViewWithContext added in v0.0.27 

func (cloudant *CloudantV1) PostViewWithContext(ctx context.Context, postViewOptions *PostViewOptions) (result *ViewResult, response *core.DetailedResponse, err error)

PostViewWithContext is an alternate form of the PostView method which supports a Context parameter

func (*CloudantV1) PutAttachment 

func (cloudant *CloudantV1) PutAttachment(putAttachmentOptions *PutAttachmentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutAttachment : Create or modify an attachment Uploads the supplied content as an attachment to the specified document. The attachment name that you provide must be a URL encoded string. You must supply the Content-Type header, and for an existing document, you must also supply either the `rev` query argument or the `If-Match` HTTP header. If you omit the revision, a new, otherwise empty, document is created with the provided attachment, or a conflict occurs. If the uploaded attachment uses an existing attachment name in the remote database, it updates the corresponding stored content of the database. Since you must supply the revision information to add an attachment to the document, this serves as validation to update the existing attachment.

func (*CloudantV1) PutAttachmentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutAttachmentWithContext(ctx context.Context, putAttachmentOptions *PutAttachmentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutAttachmentWithContext is an alternate form of the PutAttachment method which supports a Context parameter

func (*CloudantV1) PutCapacityThroughputConfiguration added in v0.0.32 

func (cloudant *CloudantV1) PutCapacityThroughputConfiguration(putCapacityThroughputConfigurationOptions *PutCapacityThroughputConfigurationOptions) (result *CapacityThroughputInformation, response *core.DetailedResponse, err error)

PutCapacityThroughputConfiguration : Update the target provisioned throughput capacity Sets the target provisioned throughput capacity for an IBM Cloudant instance. When target capacity is changed, the current capacity asynchronously changes to meet the target capacity.

func (*CloudantV1) PutCapacityThroughputConfigurationWithContext added in v0.0.32 

func (cloudant *CloudantV1) PutCapacityThroughputConfigurationWithContext(ctx context.Context, putCapacityThroughputConfigurationOptions *PutCapacityThroughputConfigurationOptions) (result *CapacityThroughputInformation, response *core.DetailedResponse, err error)

PutCapacityThroughputConfigurationWithContext is an alternate form of the PutCapacityThroughputConfiguration method which supports a Context parameter

func (*CloudantV1) PutCloudantSecurityConfiguration added in v0.0.24 

func (cloudant *CloudantV1) PutCloudantSecurityConfiguration(putCloudantSecurityConfigurationOptions *PutCloudantSecurityConfigurationOptions) (result *Ok, response *core.DetailedResponse, err error)

PutCloudantSecurityConfiguration : Modify only Cloudant related database permissions Modify only Cloudant related permissions to database. Be careful: by removing an API key from the list, you remove the API key from the list of users that have access to the database.

### Note about nobody role

The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the `nobody` user has the role `_reader`.

func (*CloudantV1) PutCloudantSecurityConfigurationWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutCloudantSecurityConfigurationWithContext(ctx context.Context, putCloudantSecurityConfigurationOptions *PutCloudantSecurityConfigurationOptions) (result *Ok, response *core.DetailedResponse, err error)

PutCloudantSecurityConfigurationWithContext is an alternate form of the PutCloudantSecurityConfiguration method which supports a Context parameter

func (*CloudantV1) PutCorsConfiguration 

func (cloudant *CloudantV1) PutCorsConfiguration(putCorsConfigurationOptions *PutCorsConfigurationOptions) (result *Ok, response *core.DetailedResponse, err error)

PutCorsConfiguration : Modify CORS configuration Sets the CORS configuration. The configuration applies to all databases and all account level endpoints in your account.

func (*CloudantV1) PutCorsConfigurationWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutCorsConfigurationWithContext(ctx context.Context, putCorsConfigurationOptions *PutCorsConfigurationOptions) (result *Ok, response *core.DetailedResponse, err error)

PutCorsConfigurationWithContext is an alternate form of the PutCorsConfiguration method which supports a Context parameter

func (*CloudantV1) PutDatabase 

func (cloudant *CloudantV1) PutDatabase(putDatabaseOptions *PutDatabaseOptions) (result *Ok, response *core.DetailedResponse, err error)

PutDatabase : Create a database

func (*CloudantV1) PutDatabaseWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutDatabaseWithContext(ctx context.Context, putDatabaseOptions *PutDatabaseOptions) (result *Ok, response *core.DetailedResponse, err error)

PutDatabaseWithContext is an alternate form of the PutDatabase method which supports a Context parameter

func (*CloudantV1) PutDesignDocument 

func (cloudant *CloudantV1) PutDesignDocument(putDesignDocumentOptions *PutDesignDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutDesignDocument : Create or modify a design document The PUT method creates a new named design document, or creates a new revision of the existing design document.

func (*CloudantV1) PutDesignDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutDesignDocumentWithContext(ctx context.Context, putDesignDocumentOptions *PutDesignDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutDesignDocumentWithContext is an alternate form of the PutDesignDocument method which supports a Context parameter

func (*CloudantV1) PutDocument 

func (cloudant *CloudantV1) PutDocument(putDocumentOptions *PutDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutDocument : Create or modify a document Creates or modifies a document in the specified database.

For creation, you must specify the document ID but you should not specify the revision.

For modification, you must specify the document ID and a revision identifier.

func (*CloudantV1) PutDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutDocumentWithContext(ctx context.Context, putDocumentOptions *PutDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutDocumentWithContext is an alternate form of the PutDocument method which supports a Context parameter

func (*CloudantV1) PutLocalDocument 

func (cloudant *CloudantV1) PutLocalDocument(putLocalDocumentOptions *PutLocalDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutLocalDocument : Create or modify a local document Stores the specified local document. The semantics are identical to storing a standard document in the specified database, except that the document is not replicated.

func (*CloudantV1) PutLocalDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutLocalDocumentWithContext(ctx context.Context, putLocalDocumentOptions *PutLocalDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutLocalDocumentWithContext is an alternate form of the PutLocalDocument method which supports a Context parameter

func (*CloudantV1) PutReplicationDocument 

func (cloudant *CloudantV1) PutReplicationDocument(putReplicationDocumentOptions *PutReplicationDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutReplicationDocument : Create or modify a replication using a replication document Creates or modifies a document in the `_replicator` database to start a new replication or to edit an existing replication.

func (*CloudantV1) PutReplicationDocumentWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutReplicationDocumentWithContext(ctx context.Context, putReplicationDocumentOptions *PutReplicationDocumentOptions) (result *DocumentResult, response *core.DetailedResponse, err error)

PutReplicationDocumentWithContext is an alternate form of the PutReplicationDocument method which supports a Context parameter

func (*CloudantV1) PutSecurity 

func (cloudant *CloudantV1) PutSecurity(putSecurityOptions *PutSecurityOptions) (result *Ok, response *core.DetailedResponse, err error)

PutSecurity : Modify database permissions Modify who has permission to read, write, or manage a database. This endpoint can be used to modify both Cloudant and CouchDB related permissions. Be careful: by removing a Cloudant API key, a member or an admin from the list of users that have access permissions, you remove it from the list of users that have access to the database.

### Note about nobody role

The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the `nobody` user has the role `_reader`.

func (*CloudantV1) PutSecurityWithContext added in v0.0.27 

func (cloudant *CloudantV1) PutSecurityWithContext(ctx context.Context, putSecurityOptions *PutSecurityOptions) (result *Ok, response *core.DetailedResponse, err error)

PutSecurityWithContext is an alternate form of the PutSecurity method which supports a Context parameter

func (*CloudantV1) SetDefaultHeaders added in v0.0.28 

func (cloudant *CloudantV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*CloudantV1) SetEnableGzipCompression added in v0.0.27 

func (cloudant *CloudantV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*CloudantV1) SetServiceURL 

func (cloudant *CloudantV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type CloudantV1Options 

type CloudantV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

CloudantV1Options : Service options

type ContentInformationSizes 

type ContentInformationSizes struct {
	// The active size of the content, in bytes.
	Active *int64 `json:"active" validate:"required"`

	// The total uncompressed size of the content, in bytes.
	External *int64 `json:"external" validate:"required"`

	// The total size of the content as stored on disk, in bytes.
	File *int64 `json:"file" validate:"required"`
}

ContentInformationSizes : Schema for size information of content.

type CorsInformation added in v0.0.27 

type CorsInformation struct {
	// Boolean value to allow authentication credentials. If set to true, browser requests must be done by using
	// withCredentials = true.
	AllowCredentials *bool `json:"allow_credentials" validate:"required"`

	// Boolean value to turn CORS on and off.
	EnableCors *bool `json:"enable_cors" validate:"required"`

	// An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It
	// is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify
	// all subdomains used.
	Origins []string `json:"origins" validate:"required"`
}

CorsInformation : Schema for information about the CORS configuration.

type CurrentThroughputInformation added in v0.0.27 

type CurrentThroughputInformation struct {
	// Detailed information about current consumption.
	Throughput *CurrentThroughputInformationThroughput `json:"throughput" validate:"required"`
}

CurrentThroughputInformation : Schema for information about current consumption of a provisioned throughput capacity.

type CurrentThroughputInformationThroughput added in v0.0.27 

type CurrentThroughputInformationThroughput struct {
	// Number of global queries conducted against the instance for a given second.
	Query *int64 `json:"query" validate:"required"`

	// Number of reads conducted against the instance for a given second.
	Read *int64 `json:"read" validate:"required"`

	// Number of writes conducted against the instance for a given second.
	Write *int64 `json:"write" validate:"required"`
}

CurrentThroughputInformationThroughput : Detailed information about current consumption.

type DatabaseInformation 

type DatabaseInformation struct {
	// Schema for database cluster information.
	Cluster *DatabaseInformationCluster `json:"cluster" validate:"required"`

	// An opaque string that describes the committed state of the database.
	CommittedUpdateSeq *string `json:"committed_update_seq,omitempty"`

	// True if the database compaction routine is operating on this database.
	CompactRunning *bool `json:"compact_running" validate:"required"`

	// An opaque string that describes the compaction state of the database.
	CompactedSeq *string `json:"compacted_seq,omitempty"`

	// The name of the database.
	DbName *string `json:"db_name" validate:"required"`

	// The version of the physical format used for the data when it is stored on disk.
	DiskFormatVersion *int64 `json:"disk_format_version" validate:"required"`

	// A count of the documents in the specified database.
	DocCount *int64 `json:"doc_count" validate:"required"`

	// Number of deleted documents.
	DocDelCount *int64 `json:"doc_del_count" validate:"required"`

	// The engine used for the database.
	Engine *string `json:"engine,omitempty"`

	// Schema for database properties.
	Props *DatabaseInformationProps `json:"props" validate:"required"`

	// Schema for size information of content.
	Sizes *ContentInformationSizes `json:"sizes" validate:"required"`

	// An opaque string that describes the state of the database. Do not rely on this string for counting the number of
	// updates.
	UpdateSeq *string `json:"update_seq" validate:"required"`

	// The UUID of the database.
	UUID *string `json:"uuid,omitempty"`

	// Information about database's partitioned indexes.
	PartitionedIndexes *PartitionedIndexesInformation `json:"partitioned_indexes,omitempty"`
}

DatabaseInformation : Schema for information about a database.

type DatabaseInformationCluster 

type DatabaseInformationCluster struct {
	// Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it cannot
	// be changed by the user.
	N *int64 `json:"n" validate:"required"`

	// Schema for the number of shards in a database. Each shard is a partition of the hash value range.
	Q *int64 `json:"q" validate:"required"`

	// Read quorum. The number of consistent copies of a document that need to be read before a successful reply.
	R *int64 `json:"r" validate:"required"`

	// Write quorum. The number of copies of a document that need to be written before a successful reply.
	W *int64 `json:"w" validate:"required"`
}

DatabaseInformationCluster : Schema for database cluster information.

type DatabaseInformationProps 

type DatabaseInformationProps struct {
	// The value is `true` for a partitioned database.
	Partitioned *bool `json:"partitioned,omitempty"`
}

DatabaseInformationProps : Schema for database properties.

type DbEvent 

type DbEvent struct {
	// Database name.
	DbName *string `json:"db_name" validate:"required"`

	// Sequence number.
	Seq *string `json:"seq" validate:"required"`

	// A database event.
	Type *string `json:"type" validate:"required"`
}

DbEvent : Schema for a database change event.

type DbUpdates 

type DbUpdates struct {
	// Last sequence number.
	LastSeq *string `json:"last_seq" validate:"required"`

	// results.
	Results []DbEvent `json:"results" validate:"required"`
}

DbUpdates : Schema for database updates.

type DbsInfoResult 

type DbsInfoResult struct {
	// The name of the error.
	Error *string `json:"error,omitempty"`

	// Schema for information about a database.
	Info *DatabaseInformation `json:"info,omitempty"`

	// Database name.
	Key *string `json:"key" validate:"required"`
}

DbsInfoResult : Schema for database information keyed by database name.

type DeleteAttachmentOptions 

type DeleteAttachmentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Path parameter to specify the attachment name.
	AttachmentName *string `json:"attachment_name" validate:"required,ne="`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAttachmentOptions : The DeleteAttachment options.

func (*DeleteAttachmentOptions) SetAttachmentName 

func (_options *DeleteAttachmentOptions) SetAttachmentName(attachmentName string) *DeleteAttachmentOptions

SetAttachmentName : Allow user to set AttachmentName

func (*DeleteAttachmentOptions) SetBatch 

func (_options *DeleteAttachmentOptions) SetBatch(batch string) *DeleteAttachmentOptions

SetBatch : Allow user to set Batch

func (*DeleteAttachmentOptions) SetDb 

func (_options *DeleteAttachmentOptions) SetDb(db string) *DeleteAttachmentOptions

SetDb : Allow user to set Db

func (*DeleteAttachmentOptions) SetDocID 

func (_options *DeleteAttachmentOptions) SetDocID(docID string) *DeleteAttachmentOptions

SetDocID : Allow user to set DocID

func (*DeleteAttachmentOptions) SetHeaders 

func (options *DeleteAttachmentOptions) SetHeaders(param map[string]string) *DeleteAttachmentOptions

SetHeaders : Allow user to set Headers

func (*DeleteAttachmentOptions) SetIfMatch 

func (_options *DeleteAttachmentOptions) SetIfMatch(ifMatch string) *DeleteAttachmentOptions

SetIfMatch : Allow user to set IfMatch

func (*DeleteAttachmentOptions) SetRev 

func (_options *DeleteAttachmentOptions) SetRev(rev string) *DeleteAttachmentOptions

SetRev : Allow user to set Rev

type DeleteDatabaseOptions 

type DeleteDatabaseOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDatabaseOptions : The DeleteDatabase options.

func (*DeleteDatabaseOptions) SetDb 

func (_options *DeleteDatabaseOptions) SetDb(db string) *DeleteDatabaseOptions

SetDb : Allow user to set Db

func (*DeleteDatabaseOptions) SetHeaders 

func (options *DeleteDatabaseOptions) SetHeaders(param map[string]string) *DeleteDatabaseOptions

SetHeaders : Allow user to set Headers

type DeleteDesignDocumentOptions 

type DeleteDesignDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDesignDocumentOptions : The DeleteDesignDocument options.

func (*DeleteDesignDocumentOptions) SetBatch 

func (_options *DeleteDesignDocumentOptions) SetBatch(batch string) *DeleteDesignDocumentOptions

SetBatch : Allow user to set Batch

func (*DeleteDesignDocumentOptions) SetDb 

func (_options *DeleteDesignDocumentOptions) SetDb(db string) *DeleteDesignDocumentOptions

SetDb : Allow user to set Db

func (*DeleteDesignDocumentOptions) SetDdoc 

func (_options *DeleteDesignDocumentOptions) SetDdoc(ddoc string) *DeleteDesignDocumentOptions

SetDdoc : Allow user to set Ddoc

func (*DeleteDesignDocumentOptions) SetHeaders 

func (options *DeleteDesignDocumentOptions) SetHeaders(param map[string]string) *DeleteDesignDocumentOptions

SetHeaders : Allow user to set Headers

func (*DeleteDesignDocumentOptions) SetIfMatch 

func (_options *DeleteDesignDocumentOptions) SetIfMatch(ifMatch string) *DeleteDesignDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*DeleteDesignDocumentOptions) SetRev 

func (_options *DeleteDesignDocumentOptions) SetRev(rev string) *DeleteDesignDocumentOptions

SetRev : Allow user to set Rev

type DeleteDocumentOptions 

type DeleteDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDocumentOptions : The DeleteDocument options.

func (*DeleteDocumentOptions) SetBatch 

func (_options *DeleteDocumentOptions) SetBatch(batch string) *DeleteDocumentOptions

SetBatch : Allow user to set Batch

func (*DeleteDocumentOptions) SetDb 

func (_options *DeleteDocumentOptions) SetDb(db string) *DeleteDocumentOptions

SetDb : Allow user to set Db

func (*DeleteDocumentOptions) SetDocID 

func (_options *DeleteDocumentOptions) SetDocID(docID string) *DeleteDocumentOptions

SetDocID : Allow user to set DocID

func (*DeleteDocumentOptions) SetHeaders 

func (options *DeleteDocumentOptions) SetHeaders(param map[string]string) *DeleteDocumentOptions

SetHeaders : Allow user to set Headers

func (*DeleteDocumentOptions) SetIfMatch 

func (_options *DeleteDocumentOptions) SetIfMatch(ifMatch string) *DeleteDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*DeleteDocumentOptions) SetRev 

func (_options *DeleteDocumentOptions) SetRev(rev string) *DeleteDocumentOptions

SetRev : Allow user to set Rev

type DeleteIndexOptions 

type DeleteIndexOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the index type.
	Type *string `json:"type" validate:"required,ne="`

	// Path parameter to specify the index name.
	Index *string `json:"index" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteIndexOptions : The DeleteIndex options.

func (*DeleteIndexOptions) SetDb 

func (_options *DeleteIndexOptions) SetDb(db string) *DeleteIndexOptions

SetDb : Allow user to set Db

func (*DeleteIndexOptions) SetDdoc 

func (_options *DeleteIndexOptions) SetDdoc(ddoc string) *DeleteIndexOptions

SetDdoc : Allow user to set Ddoc

func (*DeleteIndexOptions) SetHeaders 

func (options *DeleteIndexOptions) SetHeaders(param map[string]string) *DeleteIndexOptions

SetHeaders : Allow user to set Headers

func (*DeleteIndexOptions) SetIndex 

func (_options *DeleteIndexOptions) SetIndex(index string) *DeleteIndexOptions

SetIndex : Allow user to set Index

func (*DeleteIndexOptions) SetType 

func (_options *DeleteIndexOptions) SetType(typeVar string) *DeleteIndexOptions

SetType : Allow user to set Type

type DeleteLocalDocumentOptions 

type DeleteLocalDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteLocalDocumentOptions : The DeleteLocalDocument options.

func (*DeleteLocalDocumentOptions) SetBatch 

func (_options *DeleteLocalDocumentOptions) SetBatch(batch string) *DeleteLocalDocumentOptions

SetBatch : Allow user to set Batch

func (*DeleteLocalDocumentOptions) SetDb 

func (_options *DeleteLocalDocumentOptions) SetDb(db string) *DeleteLocalDocumentOptions

SetDb : Allow user to set Db

func (*DeleteLocalDocumentOptions) SetDocID 

func (_options *DeleteLocalDocumentOptions) SetDocID(docID string) *DeleteLocalDocumentOptions

SetDocID : Allow user to set DocID

func (*DeleteLocalDocumentOptions) SetHeaders 

func (options *DeleteLocalDocumentOptions) SetHeaders(param map[string]string) *DeleteLocalDocumentOptions

SetHeaders : Allow user to set Headers

type DeleteReplicationDocumentOptions 

type DeleteReplicationDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteReplicationDocumentOptions : The DeleteReplicationDocument options.

func (*DeleteReplicationDocumentOptions) SetBatch 

func (_options *DeleteReplicationDocumentOptions) SetBatch(batch string) *DeleteReplicationDocumentOptions

SetBatch : Allow user to set Batch

func (*DeleteReplicationDocumentOptions) SetDocID 

func (_options *DeleteReplicationDocumentOptions) SetDocID(docID string) *DeleteReplicationDocumentOptions

SetDocID : Allow user to set DocID

func (*DeleteReplicationDocumentOptions) SetHeaders 

func (options *DeleteReplicationDocumentOptions) SetHeaders(param map[string]string) *DeleteReplicationDocumentOptions

SetHeaders : Allow user to set Headers

func (*DeleteReplicationDocumentOptions) SetIfMatch 

func (_options *DeleteReplicationDocumentOptions) SetIfMatch(ifMatch string) *DeleteReplicationDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*DeleteReplicationDocumentOptions) SetRev 

func (_options *DeleteReplicationDocumentOptions) SetRev(rev string) *DeleteReplicationDocumentOptions

SetRev : Allow user to set Rev

type DesignDocument 

type DesignDocument struct {
	// Schema for a map of attachment name to attachment metadata.
	Attachments map[string]Attachment `json:"_attachments,omitempty"`

	// Schema for a list of document revision identifiers.
	Conflicts []string `json:"_conflicts,omitempty"`

	// Deletion flag. Available if document was removed.
	Deleted *bool `json:"_deleted,omitempty"`

	// Schema for a list of document revision identifiers.
	DeletedConflicts []string `json:"_deleted_conflicts,omitempty"`

	// Document ID.
	ID *string `json:"_id,omitempty"`

	// Document's update sequence in current database. Available if requested with local_seq=true query parameter.
	LocalSeq *string `json:"_local_seq,omitempty"`

	// Schema for a document revision identifier.
	Rev *string `json:"_rev,omitempty"`

	// Schema for list of revision information.
	Revisions *Revisions `json:"_revisions,omitempty"`

	// Schema for a list of objects with information about local revisions and their status.
	RevsInfo []DocumentRevisionStatus `json:"_revs_info,omitempty"`

	// Indicates whether to automatically build indexes defined in this design document.
	Autoupdate *bool `json:"autoupdate,omitempty"`

	// Schema for filter functions definition. This schema is a map where keys are the names of the filter functions and
	// values are the function definition in string format.
	//
	// Filter function formats, or filters the changes feed that pass filter rules. The function takes 2 parameters:
	//
	//   * `doc`: The document that is being processed.
	//   * `req`: A Request JavaScript object with these properties:
	//
	//     * `body` - string, Request body data as string.
	//       If the request method is GET this field contains the value
	//       `"undefined"`.
	//       If the method is DELETE or HEAD the value is `""` (empty string).
	//     * `cookie` - Cookies object.
	//     * `form` - Form Data object, contains the decoded body as key-value
	//       pairs if the Content-Type header was
	//       application/x-www-form-urlencoded.
	//     * `headers` - Request Headers object.
	//     * `id` - string, requested document id if it was specified
	//       or null otherwise.
	//     * `info` - Database Information object,
	//       see `DatabaseInformation`.
	//     * `method` - string or an array of chars, request method.
	//       String value is a method as one of: HEAD, GET, POST, PUT,
	//       DELETE, OPTIONS, TRACE, COPY. For not supported methods
	//       it will be represented as an array of char codes e.g. for VIEW
	//       it will be 86,73,69,87.
	//     * `path` - array of strings, requested path sections.
	//     * `peer` - string, request source IP address.
	//     * `query` - string, URL query parameters object. Note that multiple
	//       keys are not supported and the last key value suppresses others.
	//     * `requested_path` - array of strings,
	//       actual requested path section.
	//     * `raw_path` - string, raw requested path.
	//     * `userCtx`: User Context Object, containing information about the
	//       user writing the document (if present), see the `UserContext`.
	//     * `secObj`: Security Object, with lists of database security roles,
	//       see the `SecurityObject`.
	//     * `uuid` - string, generated UUID by a specified algorithm in the
	//       config file.
	//
	// Filter functions must return true if a document passed all the rules.
	Filters map[string]string `json:"filters,omitempty"`

	// Search (text) index function definitions.
	Indexes map[string]SearchIndexDefinition `json:"indexes,omitempty"`

	// Defines Query Server key to process design document functions.
	Language *string `json:"language,omitempty"`

	// Schema for design document options.
	Options *DesignDocumentOptions `json:"options,omitempty"`

	// Validate document update function can be used to prevent invalid or unauthorized document update requests from being
	// stored. Validation functions typically examine the structure of the new document to ensure that required fields are
	// present and to verify that the requesting user should be allowed to make changes to the document properties. When a
	// write request is received for a given database, the validation function in each design document in that database is
	// called in an unspecified order. If any of the validation functions throw an error, the write will not succeed.
	//
	// The validation function can abort the pending document write by throwing one of two error objects:
	//
	// “`
	// // user is not authorized to make the change but may re-authenticate throw({ unauthorized: 'Error message here.' });
	//
	// // change is not allowed throw({ forbidden: 'Error message here.' });
	// “`
	//
	// The function takes 4 parameters:
	//
	//   * `newDoc` - New version of document that will be stored
	//     from the update request.
	//   * `oldDoc` - Previous version of document that is already stored.
	//   * `userCtx` - User Context Object, containing information about the
	//     user writing the document (if present), see the `UserContext`.
	//   * `secObj` - Security Object, with lists of database security roles,
	//     see the `SecurityObject`.
	ValidateDocUpdate *string `json:"validate_doc_update,omitempty"`

	// Schema for design document views.
	Views map[string]DesignDocumentViewsMapReduce `json:"views,omitempty"`
	// contains filtered or unexported fields
}

DesignDocument : Schema for a design document.

func (*DesignDocument) GetProperties 

func (o *DesignDocument) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of DesignDocument

func (*DesignDocument) GetProperty 

func (o *DesignDocument) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of DesignDocument

func (*DesignDocument) MarshalJSON 

func (o *DesignDocument) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of DesignDocument

func (*DesignDocument) SetProperties added in v0.0.37 

func (o *DesignDocument) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of DesignDocument

func (*DesignDocument) SetProperty 

func (o *DesignDocument) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of DesignDocument

type DesignDocumentInformation 

type DesignDocumentInformation struct {
	// name.
	Name *string `json:"name" validate:"required"`

	// View index information.
	ViewIndex *DesignDocumentViewIndex `json:"view_index" validate:"required"`
}

DesignDocumentInformation : Schema for information about a design document.

type DesignDocumentOptions 

type DesignDocumentOptions struct {
	// Whether this design document describes partitioned or global indexes.
	Partitioned *bool `json:"partitioned,omitempty"`
}

DesignDocumentOptions : Schema for design document options.

type DesignDocumentViewIndex added in v0.0.24 

type DesignDocumentViewIndex struct {
	// List of collator versions. If there are multiple entries this implies a libicu upgrade has occurred but compaction
	// has not run yet.
	CollatorVersions []string `json:"collator_versions" validate:"required"`

	// Indicates whether a compaction routine is currently running on the view.
	CompactRunning *bool `json:"compact_running" validate:"required"`

	// Language for the defined views.
	Language *string `json:"language" validate:"required"`

	// MD5 signature of the views for the design document.
	Signature *string `json:"signature" validate:"required"`

	// Schema for size information of content.
	Sizes *ContentInformationSizes `json:"sizes" validate:"required"`

	// Indicates if the view is currently being updated.
	UpdaterRunning *bool `json:"updater_running" validate:"required"`

	// Schema for an ability to tell if view is up-to-date without querying it.
	UpdatesPending *UpdatesPending `json:"updates_pending" validate:"required"`

	// Number of clients waiting on views from this design document.
	WaitingClients *int64 `json:"waiting_clients" validate:"required"`

	// Indicates if there are outstanding commits to the underlying database that need to processed.
	WaitingCommit *bool `json:"waiting_commit" validate:"required"`
}

DesignDocumentViewIndex : View index information.

type DesignDocumentViewsMapReduce 

type DesignDocumentViewsMapReduce struct {
	// JavaScript map function as a string.
	Map *string `json:"map" validate:"required"`

	// JavaScript reduce function as a string.
	Reduce *string `json:"reduce,omitempty"`
}

DesignDocumentViewsMapReduce : Schema for view functions definition.

type DocsResultRow 

type DocsResultRow struct {
	// The cause of the error (if available).
	CausedBy *string `json:"caused_by,omitempty"`

	// The name of the error.
	Error *string `json:"error,omitempty"`

	// The reason the error occurred (if available).
	Reason *string `json:"reason,omitempty"`

	// Schema for a document.
	Doc *Document `json:"doc,omitempty"`

	// id.
	ID *string `json:"id,omitempty"`

	// Document ID.
	Key *string `json:"key" validate:"required"`

	// Value of built-in `/_all_docs` style view.
	Value *DocsResultRowValue `json:"value,omitempty"`
}

DocsResultRow : Schema for a row of document information in a DocsResult.

type DocsResultRowValue 

type DocsResultRowValue struct {
	// If `true` then the document is deleted. Not present for undeleted documents.
	Deleted *bool `json:"deleted,omitempty"`

	// Schema for a document revision identifier.
	Rev *string `json:"rev" validate:"required"`
}

DocsResultRowValue : Value of built-in `/_all_docs` style view.

type Document 

type Document struct {
	// Schema for a map of attachment name to attachment metadata.
	Attachments map[string]Attachment `json:"_attachments,omitempty"`

	// Schema for a list of document revision identifiers.
	Conflicts []string `json:"_conflicts,omitempty"`

	// Deletion flag. Available if document was removed.
	Deleted *bool `json:"_deleted,omitempty"`

	// Schema for a list of document revision identifiers.
	DeletedConflicts []string `json:"_deleted_conflicts,omitempty"`

	// Document ID.
	ID *string `json:"_id,omitempty"`

	// Document's update sequence in current database. Available if requested with local_seq=true query parameter.
	LocalSeq *string `json:"_local_seq,omitempty"`

	// Schema for a document revision identifier.
	Rev *string `json:"_rev,omitempty"`

	// Schema for list of revision information.
	Revisions *Revisions `json:"_revisions,omitempty"`

	// Schema for a list of objects with information about local revisions and their status.
	RevsInfo []DocumentRevisionStatus `json:"_revs_info,omitempty"`
	// contains filtered or unexported fields
}

Document : Schema for a document.

func (*Document) GetProperties 

func (o *Document) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Document

func (*Document) GetProperty 

func (o *Document) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of Document

func (*Document) MarshalJSON 

func (o *Document) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of Document

func (*Document) SetProperties added in v0.0.37 

func (o *Document) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of Document

func (*Document) SetProperty 

func (o *Document) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of Document

type DocumentResult 

type DocumentResult struct {
	// Schema for a document ID.
	ID *string `json:"id" validate:"required"`

	// Schema for a document revision identifier.
	Rev *string `json:"rev,omitempty"`

	// ok.
	Ok *bool `json:"ok,omitempty"`

	// The cause of the error (if available).
	CausedBy *string `json:"caused_by,omitempty"`

	// The name of the error.
	Error *string `json:"error,omitempty"`

	// The reason the error occurred (if available).
	Reason *string `json:"reason,omitempty"`
}

DocumentResult : Schema for the result of a document modification.

type DocumentRevisionStatus 

type DocumentRevisionStatus struct {
	// Schema for a document revision identifier.
	Rev *string `json:"rev" validate:"required"`

	// Status of the revision. May be one of: - `available`: Revision is available for retrieving with rev query parameter
	// - `missing`: Revision is not available - `deleted`: Revision belongs to deleted document.
	Status *string `json:"status" validate:"required"`
}

DocumentRevisionStatus : Schema for information about revisions and their status.

type DocumentShardInfo 

type DocumentShardInfo struct {
	// List of nodes serving a replica of the shard.
	Nodes []string `json:"nodes" validate:"required"`

	// The shard range in which the document is stored.
	Range *string `json:"range" validate:"required"`
}

DocumentShardInfo : Schema for document shard information.

type ExecutionStats 

type ExecutionStats struct {
	// Time to execute the query.
	ExecutionTimeMs *float64 `json:"execution_time_ms" validate:"required"`

	// Number of results returned.
	ResultsReturned *int64 `json:"results_returned" validate:"required"`

	// Number of documents fetched from the index.
	TotalDocsExamined *int64 `json:"total_docs_examined" validate:"required"`

	// Number of rows scanned in the index.
	TotalKeysExamined *int64 `json:"total_keys_examined" validate:"required"`

	// Number of documents fetched from the primary index with the specified read quorum.
	TotalQuorumDocsExamined *int64 `json:"total_quorum_docs_examined" validate:"required"`
}

ExecutionStats : Schema for find query execution statistics.

type ExplainResult 

type ExplainResult struct {
	// When `true`, the query is answered using the index only and no documents are fetched.
	Covering *bool `json:"covering" validate:"required"`

	// Name of database.
	Dbname *string `json:"dbname" validate:"required"`

	// Fields that were requested to be projected from the document. If no fields were requested to be projected this will
	// be empty and all fields will be returned.
	Fields []string `json:"fields" validate:"required"`

	// Schema for information about an index.
	Index *IndexInformation `json:"index" validate:"required"`

	// The used maximum number of results returned.
	Limit *int64 `json:"limit" validate:"required"`

	// Arguments passed to the underlying view.
	Mrargs *ExplainResultMrArgs `json:"mrargs,omitempty"`

	// Options used for the request.
	Opts *ExplainResultOpts `json:"opts" validate:"required"`

	// Schema for any JSON type.
	Partitioned interface{} `json:"partitioned,omitempty"`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector" validate:"required"`

	// Skip parameter used.
	Skip *int64 `json:"skip" validate:"required"`
}

ExplainResult : Schema for information about the index used for a find query.

type ExplainResultMrArgs added in v0.6.0 

type ExplainResultMrArgs struct {
	// Schema for any JSON type.
	Conflicts interface{} `json:"conflicts,omitempty"`

	// Direction parameter passed to the underlying view.
	Direction *string `json:"direction,omitempty"`

	// Schema for any JSON type.
	EndKey interface{} `json:"end_key,omitempty"`

	// A parameter that specifies whether to include the full content of the documents in the response in the underlying
	// view.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Partition parameter passed to the underlying view.
	Partition *string `json:"partition,omitempty"`

	// A parameter that specifies returning only documents that match any of the specified keys in the underlying view.
	Reduce *bool `json:"reduce,omitempty"`

	// A parameter that specifies whether the view results should be returned form a "stable" set of shards passed to the
	// underlying view.
	Stable *bool `json:"stable,omitempty"`

	// Schema for any JSON type.
	StartKey interface{} `json:"start_key,omitempty"`

	// Schema for any JSON type.
	Update interface{} `json:"update,omitempty"`

	// The type of the underlying view.
	ViewType *string `json:"view_type,omitempty"`
}

ExplainResultMrArgs : Arguments passed to the underlying view.

type ExplainResultOpts added in v0.6.0 

type ExplainResultOpts struct {
	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark" validate:"required"`

	// Conflicts used in the request query.
	Conflicts *bool `json:"conflicts" validate:"required"`

	// Execution statistics used in the request query.
	ExecutionStats *bool `json:"execution_stats" validate:"required"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields" validate:"required"`

	// Limit used in the request query.
	Limit *int64 `json:"limit" validate:"required"`

	// On which database partition the request was used. If it was not used on a database partition, it returns with `""`.
	Partition *string `json:"partition" validate:"required"`

	// The read quorum that is needed for the result.
	R *int64 `json:"r" validate:"required"`

	// Skip used in the request query.
	Skip *int64 `json:"skip" validate:"required"`

	// Schema for any JSON type.
	Sort interface{} `json:"sort" validate:"required"`

	// Stable used in the request query.
	Stable *bool `json:"stable" validate:"required"`

	// Stale used in the request query.
	// Deprecated: this field is deprecated and may be removed in a future release.
	Stale *bool `json:"stale" validate:"required"`

	// Update used in the request query.
	Update *bool `json:"update" validate:"required"`

	// Use index used in the request query.
	UseIndex []string `json:"use_index" validate:"required"`
}

ExplainResultOpts : Options used for the request.

type FindResult 

type FindResult struct {
	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark" validate:"required"`

	// Documents matching the selector.
	Docs []Document `json:"docs" validate:"required"`

	// Schema for find query execution statistics.
	ExecutionStats *ExecutionStats `json:"execution_stats,omitempty"`

	// warning.
	Warning *string `json:"warning,omitempty"`
}

FindResult : Schema for the result of a query find operation.

type GetActiveTasksOptions 

type GetActiveTasksOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetActiveTasksOptions : The GetActiveTasks options.

func (*GetActiveTasksOptions) SetHeaders 

func (options *GetActiveTasksOptions) SetHeaders(param map[string]string) *GetActiveTasksOptions

SetHeaders : Allow user to set Headers

type GetActivityTrackerEventsOptions added in v0.0.32 

type GetActivityTrackerEventsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetActivityTrackerEventsOptions : The GetActivityTrackerEvents options.

func (*GetActivityTrackerEventsOptions) SetHeaders added in v0.0.32 

func (options *GetActivityTrackerEventsOptions) SetHeaders(param map[string]string) *GetActivityTrackerEventsOptions

SetHeaders : Allow user to set Headers

type GetAllDbsOptions 

type GetAllDbsOptions struct {
	// Query parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Query parameter to specify to stop returning records when the specified key is reached. String representation of any
	// JSON type that matches the key type emitted by the view function.
	EndKey *string `json:"end_key,omitempty"`

	// Query parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Query parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Query parameter to specify to start returning records from the specified key. String representation of any JSON type
	// that matches the key type emitted by the view function.
	StartKey *string `json:"start_key,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAllDbsOptions : The GetAllDbs options.

func (*GetAllDbsOptions) SetDescending 

func (_options *GetAllDbsOptions) SetDescending(descending bool) *GetAllDbsOptions

SetDescending : Allow user to set Descending

func (*GetAllDbsOptions) SetEndKey added in v0.1.0 

func (_options *GetAllDbsOptions) SetEndKey(endKey string) *GetAllDbsOptions

SetEndKey : Allow user to set EndKey

func (*GetAllDbsOptions) SetHeaders 

func (options *GetAllDbsOptions) SetHeaders(param map[string]string) *GetAllDbsOptions

SetHeaders : Allow user to set Headers

func (*GetAllDbsOptions) SetLimit 

func (_options *GetAllDbsOptions) SetLimit(limit int64) *GetAllDbsOptions

SetLimit : Allow user to set Limit

func (*GetAllDbsOptions) SetSkip 

func (_options *GetAllDbsOptions) SetSkip(skip int64) *GetAllDbsOptions

SetSkip : Allow user to set Skip

func (*GetAllDbsOptions) SetStartKey added in v0.1.0 

func (_options *GetAllDbsOptions) SetStartKey(startKey string) *GetAllDbsOptions

SetStartKey : Allow user to set StartKey

type GetAttachmentOptions 

type GetAttachmentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Path parameter to specify the attachment name.
	AttachmentName *string `json:"attachment_name" validate:"required,ne="`

	// The type of the response:  or *_/_*.
	Accept *string `json:"Accept,omitempty"`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Header parameter to specify the byte range for a request. This allows the implementation of resumable downloads and
	// skippable streams. This is available for all attachments inside CouchDB.
	Range *string `json:"Range,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAttachmentOptions : The GetAttachment options.

func (*GetAttachmentOptions) SetAccept 

func (_options *GetAttachmentOptions) SetAccept(accept string) *GetAttachmentOptions

SetAccept : Allow user to set Accept

func (*GetAttachmentOptions) SetAttachmentName 

func (_options *GetAttachmentOptions) SetAttachmentName(attachmentName string) *GetAttachmentOptions

SetAttachmentName : Allow user to set AttachmentName

func (*GetAttachmentOptions) SetDb 

func (_options *GetAttachmentOptions) SetDb(db string) *GetAttachmentOptions

SetDb : Allow user to set Db

func (*GetAttachmentOptions) SetDocID 

func (_options *GetAttachmentOptions) SetDocID(docID string) *GetAttachmentOptions

SetDocID : Allow user to set DocID

func (*GetAttachmentOptions) SetHeaders 

func (options *GetAttachmentOptions) SetHeaders(param map[string]string) *GetAttachmentOptions

SetHeaders : Allow user to set Headers

func (*GetAttachmentOptions) SetIfMatch 

func (_options *GetAttachmentOptions) SetIfMatch(ifMatch string) *GetAttachmentOptions

SetIfMatch : Allow user to set IfMatch

func (*GetAttachmentOptions) SetIfNoneMatch 

func (_options *GetAttachmentOptions) SetIfNoneMatch(ifNoneMatch string) *GetAttachmentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*GetAttachmentOptions) SetRange 

func (_options *GetAttachmentOptions) SetRange(rangeVar string) *GetAttachmentOptions

SetRange : Allow user to set Range

func (*GetAttachmentOptions) SetRev 

func (_options *GetAttachmentOptions) SetRev(rev string) *GetAttachmentOptions

SetRev : Allow user to set Rev

type GetCapacityThroughputInformationOptions added in v0.0.27 

type GetCapacityThroughputInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCapacityThroughputInformationOptions : The GetCapacityThroughputInformation options.

func (*GetCapacityThroughputInformationOptions) SetHeaders added in v0.0.27 

func (options *GetCapacityThroughputInformationOptions) SetHeaders(param map[string]string) *GetCapacityThroughputInformationOptions

SetHeaders : Allow user to set Headers

type GetCorsInformationOptions 

type GetCorsInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCorsInformationOptions : The GetCorsInformation options.

func (*GetCorsInformationOptions) SetHeaders 

func (options *GetCorsInformationOptions) SetHeaders(param map[string]string) *GetCorsInformationOptions

SetHeaders : Allow user to set Headers

type GetCurrentThroughputInformationOptions added in v0.0.27 

type GetCurrentThroughputInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCurrentThroughputInformationOptions : The GetCurrentThroughputInformation options.

func (*GetCurrentThroughputInformationOptions) SetHeaders added in v0.0.27 

func (options *GetCurrentThroughputInformationOptions) SetHeaders(param map[string]string) *GetCurrentThroughputInformationOptions

SetHeaders : Allow user to set Headers

type GetDatabaseInformationOptions 

type GetDatabaseInformationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDatabaseInformationOptions : The GetDatabaseInformation options.

func (*GetDatabaseInformationOptions) SetDb 

func (_options *GetDatabaseInformationOptions) SetDb(db string) *GetDatabaseInformationOptions

SetDb : Allow user to set Db

func (*GetDatabaseInformationOptions) SetHeaders 

func (options *GetDatabaseInformationOptions) SetHeaders(param map[string]string) *GetDatabaseInformationOptions

SetHeaders : Allow user to set Headers

type GetDbUpdatesOptions 

type GetDbUpdatesOptions struct {
	// Query parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Query parameter to specify the changes feed type.
	Feed *string `json:"feed,omitempty"`

	// Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off by
	// default and only applicable for
	// `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true`
	// to use a value of `60000`.
	//
	// **Note:** Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an
	// environment where idle network connections may break, `heartbeat` is not suitable as a keepalive mechanism. Instead,
	// consider one of the following options:
	//   * Use the `timeout` parameter with a value that is compatible with your network environment.
	//   * Switch to scheduled usage of one of the non-continuous changes feed types
	//     (`normal` or `longpoll`).
	//   * Use TCP keepalive.
	Heartbeat *int64 `json:"heartbeat,omitempty"`

	// Query parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Query parameter to specify the maximum period in milliseconds to wait for a change before the response is sent, even
	// if there are no results. Only applicable for `longpoll` or `continuous` feeds. Default value is specified by
	// `httpd/changes_timeout` configuration option. Note that `60000` value is also the default maximum timeout to prevent
	// undetected dead connections.
	Timeout *int64 `json:"timeout,omitempty"`

	// Query parameter to specify to start the results from the change immediately after the given update sequence. Can be
	// a valid update sequence or `now` value. Default is `0` i.e. all changes.
	Since *string `json:"since,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDbUpdatesOptions : The GetDbUpdates options.

func (*GetDbUpdatesOptions) SetDescending added in v0.7.3 

func (_options *GetDbUpdatesOptions) SetDescending(descending bool) *GetDbUpdatesOptions

SetDescending : Allow user to set Descending

func (*GetDbUpdatesOptions) SetFeed 

func (_options *GetDbUpdatesOptions) SetFeed(feed string) *GetDbUpdatesOptions

SetFeed : Allow user to set Feed

func (*GetDbUpdatesOptions) SetHeaders 

func (options *GetDbUpdatesOptions) SetHeaders(param map[string]string) *GetDbUpdatesOptions

SetHeaders : Allow user to set Headers

func (*GetDbUpdatesOptions) SetHeartbeat 

func (_options *GetDbUpdatesOptions) SetHeartbeat(heartbeat int64) *GetDbUpdatesOptions

SetHeartbeat : Allow user to set Heartbeat

func (*GetDbUpdatesOptions) SetLimit added in v0.7.3 

func (_options *GetDbUpdatesOptions) SetLimit(limit int64) *GetDbUpdatesOptions

SetLimit : Allow user to set Limit

func (*GetDbUpdatesOptions) SetSince 

func (_options *GetDbUpdatesOptions) SetSince(since string) *GetDbUpdatesOptions

SetSince : Allow user to set Since

func (*GetDbUpdatesOptions) SetTimeout 

func (_options *GetDbUpdatesOptions) SetTimeout(timeout int64) *GetDbUpdatesOptions

SetTimeout : Allow user to set Timeout

type GetDesignDocumentInformationOptions 

type GetDesignDocumentInformationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDesignDocumentInformationOptions : The GetDesignDocumentInformation options.

func (*GetDesignDocumentInformationOptions) SetDb 

func (_options *GetDesignDocumentInformationOptions) SetDb(db string) *GetDesignDocumentInformationOptions

SetDb : Allow user to set Db

func (*GetDesignDocumentInformationOptions) SetDdoc 

func (_options *GetDesignDocumentInformationOptions) SetDdoc(ddoc string) *GetDesignDocumentInformationOptions

SetDdoc : Allow user to set Ddoc

func (*GetDesignDocumentInformationOptions) SetHeaders 

func (options *GetDesignDocumentInformationOptions) SetHeaders(param map[string]string) *GetDesignDocumentInformationOptions

SetHeaders : Allow user to set Headers

type GetDesignDocumentOptions 

type GetDesignDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
	// when `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Query parameter to specify whether to include a list of deleted conflicted revisions in the `_deleted_conflicts`
	// property of the returned document.
	DeletedConflicts *bool `json:"deleted_conflicts,omitempty"`

	// Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
	Latest *bool `json:"latest,omitempty"`

	// Query parameter to specify whether to include the last update sequence for the document.
	LocalSeq *bool `json:"local_seq,omitempty"`

	// Query parameter to specify whether to include document meta information. Acts the same as specifying all of the
	// conflicts, deleted_conflicts and open_revs query parameters.
	Meta *bool `json:"meta,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Query parameter to specify whether to include a list of all known document revisions.
	Revs *bool `json:"revs,omitempty"`

	// Query parameter to specify whether to includes detailed information for all known document revisions.
	RevsInfo *bool `json:"revs_info,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDesignDocumentOptions : The GetDesignDocument options.

func (*GetDesignDocumentOptions) SetAttEncodingInfo 

func (_options *GetDesignDocumentOptions) SetAttEncodingInfo(attEncodingInfo bool) *GetDesignDocumentOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*GetDesignDocumentOptions) SetAttachments 

func (_options *GetDesignDocumentOptions) SetAttachments(attachments bool) *GetDesignDocumentOptions

SetAttachments : Allow user to set Attachments

func (*GetDesignDocumentOptions) SetConflicts 

func (_options *GetDesignDocumentOptions) SetConflicts(conflicts bool) *GetDesignDocumentOptions

SetConflicts : Allow user to set Conflicts

func (*GetDesignDocumentOptions) SetDb 

func (_options *GetDesignDocumentOptions) SetDb(db string) *GetDesignDocumentOptions

SetDb : Allow user to set Db

func (*GetDesignDocumentOptions) SetDdoc 

func (_options *GetDesignDocumentOptions) SetDdoc(ddoc string) *GetDesignDocumentOptions

SetDdoc : Allow user to set Ddoc

func (*GetDesignDocumentOptions) SetDeletedConflicts 

func (_options *GetDesignDocumentOptions) SetDeletedConflicts(deletedConflicts bool) *GetDesignDocumentOptions

SetDeletedConflicts : Allow user to set DeletedConflicts

func (*GetDesignDocumentOptions) SetHeaders 

func (options *GetDesignDocumentOptions) SetHeaders(param map[string]string) *GetDesignDocumentOptions

SetHeaders : Allow user to set Headers

func (*GetDesignDocumentOptions) SetIfNoneMatch 

func (_options *GetDesignDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *GetDesignDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*GetDesignDocumentOptions) SetLatest 

func (_options *GetDesignDocumentOptions) SetLatest(latest bool) *GetDesignDocumentOptions

SetLatest : Allow user to set Latest

func (*GetDesignDocumentOptions) SetLocalSeq 

func (_options *GetDesignDocumentOptions) SetLocalSeq(localSeq bool) *GetDesignDocumentOptions

SetLocalSeq : Allow user to set LocalSeq

func (*GetDesignDocumentOptions) SetMeta 

func (_options *GetDesignDocumentOptions) SetMeta(meta bool) *GetDesignDocumentOptions

SetMeta : Allow user to set Meta

func (*GetDesignDocumentOptions) SetRev 

func (_options *GetDesignDocumentOptions) SetRev(rev string) *GetDesignDocumentOptions

SetRev : Allow user to set Rev

func (*GetDesignDocumentOptions) SetRevs 

func (_options *GetDesignDocumentOptions) SetRevs(revs bool) *GetDesignDocumentOptions

SetRevs : Allow user to set Revs

func (*GetDesignDocumentOptions) SetRevsInfo 

func (_options *GetDesignDocumentOptions) SetRevsInfo(revsInfo bool) *GetDesignDocumentOptions

SetRevsInfo : Allow user to set RevsInfo

type GetDocumentOptions 

type GetDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
	// when `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Query parameter to specify whether to include a list of deleted conflicted revisions in the `_deleted_conflicts`
	// property of the returned document.
	DeletedConflicts *bool `json:"deleted_conflicts,omitempty"`

	// Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
	Latest *bool `json:"latest,omitempty"`

	// Query parameter to specify whether to include the last update sequence for the document.
	LocalSeq *bool `json:"local_seq,omitempty"`

	// Query parameter to specify whether to include document meta information. Acts the same as specifying all of the
	// conflicts, deleted_conflicts and open_revs query parameters.
	Meta *bool `json:"meta,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Query parameter to specify whether to include a list of all known document revisions.
	Revs *bool `json:"revs,omitempty"`

	// Query parameter to specify whether to includes detailed information for all known document revisions.
	RevsInfo *bool `json:"revs_info,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDocumentOptions : The GetDocument options.

func (*GetDocumentOptions) SetAttEncodingInfo 

func (_options *GetDocumentOptions) SetAttEncodingInfo(attEncodingInfo bool) *GetDocumentOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*GetDocumentOptions) SetAttachments 

func (_options *GetDocumentOptions) SetAttachments(attachments bool) *GetDocumentOptions

SetAttachments : Allow user to set Attachments

func (*GetDocumentOptions) SetConflicts 

func (_options *GetDocumentOptions) SetConflicts(conflicts bool) *GetDocumentOptions

SetConflicts : Allow user to set Conflicts

func (*GetDocumentOptions) SetDb 

func (_options *GetDocumentOptions) SetDb(db string) *GetDocumentOptions

SetDb : Allow user to set Db

func (*GetDocumentOptions) SetDeletedConflicts 

func (_options *GetDocumentOptions) SetDeletedConflicts(deletedConflicts bool) *GetDocumentOptions

SetDeletedConflicts : Allow user to set DeletedConflicts

func (*GetDocumentOptions) SetDocID 

func (_options *GetDocumentOptions) SetDocID(docID string) *GetDocumentOptions

SetDocID : Allow user to set DocID

func (*GetDocumentOptions) SetHeaders 

func (options *GetDocumentOptions) SetHeaders(param map[string]string) *GetDocumentOptions

SetHeaders : Allow user to set Headers

func (*GetDocumentOptions) SetIfNoneMatch 

func (_options *GetDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *GetDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*GetDocumentOptions) SetLatest 

func (_options *GetDocumentOptions) SetLatest(latest bool) *GetDocumentOptions

SetLatest : Allow user to set Latest

func (*GetDocumentOptions) SetLocalSeq 

func (_options *GetDocumentOptions) SetLocalSeq(localSeq bool) *GetDocumentOptions

SetLocalSeq : Allow user to set LocalSeq

func (*GetDocumentOptions) SetMeta 

func (_options *GetDocumentOptions) SetMeta(meta bool) *GetDocumentOptions

SetMeta : Allow user to set Meta

func (*GetDocumentOptions) SetRev 

func (_options *GetDocumentOptions) SetRev(rev string) *GetDocumentOptions

SetRev : Allow user to set Rev

func (*GetDocumentOptions) SetRevs 

func (_options *GetDocumentOptions) SetRevs(revs bool) *GetDocumentOptions

SetRevs : Allow user to set Revs

func (*GetDocumentOptions) SetRevsInfo 

func (_options *GetDocumentOptions) SetRevsInfo(revsInfo bool) *GetDocumentOptions

SetRevsInfo : Allow user to set RevsInfo

type GetDocumentShardsInfoOptions 

type GetDocumentShardsInfoOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDocumentShardsInfoOptions : The GetDocumentShardsInfo options.

func (*GetDocumentShardsInfoOptions) SetDb 

func (_options *GetDocumentShardsInfoOptions) SetDb(db string) *GetDocumentShardsInfoOptions

SetDb : Allow user to set Db

func (*GetDocumentShardsInfoOptions) SetDocID 

func (_options *GetDocumentShardsInfoOptions) SetDocID(docID string) *GetDocumentShardsInfoOptions

SetDocID : Allow user to set DocID

func (*GetDocumentShardsInfoOptions) SetHeaders 

func (options *GetDocumentShardsInfoOptions) SetHeaders(param map[string]string) *GetDocumentShardsInfoOptions

SetHeaders : Allow user to set Headers

type GetIndexesInformationOptions 

type GetIndexesInformationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetIndexesInformationOptions : The GetIndexesInformation options.

func (*GetIndexesInformationOptions) SetDb 

func (_options *GetIndexesInformationOptions) SetDb(db string) *GetIndexesInformationOptions

SetDb : Allow user to set Db

func (*GetIndexesInformationOptions) SetHeaders 

func (options *GetIndexesInformationOptions) SetHeaders(param map[string]string) *GetIndexesInformationOptions

SetHeaders : Allow user to set Headers

type GetLocalDocumentOptions 

type GetLocalDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.
	Accept *string `json:"Accept,omitempty"`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to include the last update sequence for the document.
	LocalSeq *bool `json:"local_seq,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLocalDocumentOptions : The GetLocalDocument options.

func (*GetLocalDocumentOptions) SetAccept 

func (_options *GetLocalDocumentOptions) SetAccept(accept string) *GetLocalDocumentOptions

SetAccept : Allow user to set Accept

func (*GetLocalDocumentOptions) SetAttEncodingInfo 

func (_options *GetLocalDocumentOptions) SetAttEncodingInfo(attEncodingInfo bool) *GetLocalDocumentOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*GetLocalDocumentOptions) SetAttachments 

func (_options *GetLocalDocumentOptions) SetAttachments(attachments bool) *GetLocalDocumentOptions

SetAttachments : Allow user to set Attachments

func (*GetLocalDocumentOptions) SetDb 

func (_options *GetLocalDocumentOptions) SetDb(db string) *GetLocalDocumentOptions

SetDb : Allow user to set Db

func (*GetLocalDocumentOptions) SetDocID 

func (_options *GetLocalDocumentOptions) SetDocID(docID string) *GetLocalDocumentOptions

SetDocID : Allow user to set DocID

func (*GetLocalDocumentOptions) SetHeaders 

func (options *GetLocalDocumentOptions) SetHeaders(param map[string]string) *GetLocalDocumentOptions

SetHeaders : Allow user to set Headers

func (*GetLocalDocumentOptions) SetIfNoneMatch 

func (_options *GetLocalDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *GetLocalDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*GetLocalDocumentOptions) SetLocalSeq 

func (_options *GetLocalDocumentOptions) SetLocalSeq(localSeq bool) *GetLocalDocumentOptions

SetLocalSeq : Allow user to set LocalSeq

type GetMembershipInformationOptions 

type GetMembershipInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetMembershipInformationOptions : The GetMembershipInformation options.

func (*GetMembershipInformationOptions) SetHeaders 

func (options *GetMembershipInformationOptions) SetHeaders(param map[string]string) *GetMembershipInformationOptions

SetHeaders : Allow user to set Headers

type GetPartitionInformationOptions 

type GetPartitionInformationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetPartitionInformationOptions : The GetPartitionInformation options.

func (*GetPartitionInformationOptions) SetDb 

func (_options *GetPartitionInformationOptions) SetDb(db string) *GetPartitionInformationOptions

SetDb : Allow user to set Db

func (*GetPartitionInformationOptions) SetHeaders 

func (options *GetPartitionInformationOptions) SetHeaders(param map[string]string) *GetPartitionInformationOptions

SetHeaders : Allow user to set Headers

func (*GetPartitionInformationOptions) SetPartitionKey 

func (_options *GetPartitionInformationOptions) SetPartitionKey(partitionKey string) *GetPartitionInformationOptions

SetPartitionKey : Allow user to set PartitionKey

type GetReplicationDocumentOptions 

type GetReplicationDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
	// when `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Query parameter to specify whether to include a list of deleted conflicted revisions in the `_deleted_conflicts`
	// property of the returned document.
	DeletedConflicts *bool `json:"deleted_conflicts,omitempty"`

	// Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
	Latest *bool `json:"latest,omitempty"`

	// Query parameter to specify whether to include the last update sequence for the document.
	LocalSeq *bool `json:"local_seq,omitempty"`

	// Query parameter to specify whether to include document meta information. Acts the same as specifying all of the
	// conflicts, deleted_conflicts and open_revs query parameters.
	Meta *bool `json:"meta,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Query parameter to specify whether to include a list of all known document revisions.
	Revs *bool `json:"revs,omitempty"`

	// Query parameter to specify whether to includes detailed information for all known document revisions.
	RevsInfo *bool `json:"revs_info,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetReplicationDocumentOptions : The GetReplicationDocument options.

func (*GetReplicationDocumentOptions) SetAttEncodingInfo 

func (_options *GetReplicationDocumentOptions) SetAttEncodingInfo(attEncodingInfo bool) *GetReplicationDocumentOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*GetReplicationDocumentOptions) SetAttachments 

func (_options *GetReplicationDocumentOptions) SetAttachments(attachments bool) *GetReplicationDocumentOptions

SetAttachments : Allow user to set Attachments

func (*GetReplicationDocumentOptions) SetConflicts 

func (_options *GetReplicationDocumentOptions) SetConflicts(conflicts bool) *GetReplicationDocumentOptions

SetConflicts : Allow user to set Conflicts

func (*GetReplicationDocumentOptions) SetDeletedConflicts 

func (_options *GetReplicationDocumentOptions) SetDeletedConflicts(deletedConflicts bool) *GetReplicationDocumentOptions

SetDeletedConflicts : Allow user to set DeletedConflicts

func (*GetReplicationDocumentOptions) SetDocID 

func (_options *GetReplicationDocumentOptions) SetDocID(docID string) *GetReplicationDocumentOptions

SetDocID : Allow user to set DocID

func (*GetReplicationDocumentOptions) SetHeaders 

func (options *GetReplicationDocumentOptions) SetHeaders(param map[string]string) *GetReplicationDocumentOptions

SetHeaders : Allow user to set Headers

func (*GetReplicationDocumentOptions) SetIfNoneMatch 

func (_options *GetReplicationDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *GetReplicationDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*GetReplicationDocumentOptions) SetLatest 

func (_options *GetReplicationDocumentOptions) SetLatest(latest bool) *GetReplicationDocumentOptions

SetLatest : Allow user to set Latest

func (*GetReplicationDocumentOptions) SetLocalSeq 

func (_options *GetReplicationDocumentOptions) SetLocalSeq(localSeq bool) *GetReplicationDocumentOptions

SetLocalSeq : Allow user to set LocalSeq

func (*GetReplicationDocumentOptions) SetMeta 

func (_options *GetReplicationDocumentOptions) SetMeta(meta bool) *GetReplicationDocumentOptions

SetMeta : Allow user to set Meta

func (*GetReplicationDocumentOptions) SetRev 

func (_options *GetReplicationDocumentOptions) SetRev(rev string) *GetReplicationDocumentOptions

SetRev : Allow user to set Rev

func (*GetReplicationDocumentOptions) SetRevs 

func (_options *GetReplicationDocumentOptions) SetRevs(revs bool) *GetReplicationDocumentOptions

SetRevs : Allow user to set Revs

func (*GetReplicationDocumentOptions) SetRevsInfo 

func (_options *GetReplicationDocumentOptions) SetRevsInfo(revsInfo bool) *GetReplicationDocumentOptions

SetRevsInfo : Allow user to set RevsInfo

type GetSchedulerDocsOptions 

type GetSchedulerDocsOptions struct {
	// Query parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Query parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Query parameter to include only replication documents in the specified states. String must be a comma-delimited
	// string.
	States []string `json:"states,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSchedulerDocsOptions : The GetSchedulerDocs options.

func (*GetSchedulerDocsOptions) SetHeaders 

func (options *GetSchedulerDocsOptions) SetHeaders(param map[string]string) *GetSchedulerDocsOptions

SetHeaders : Allow user to set Headers

func (*GetSchedulerDocsOptions) SetLimit 

func (_options *GetSchedulerDocsOptions) SetLimit(limit int64) *GetSchedulerDocsOptions

SetLimit : Allow user to set Limit

func (*GetSchedulerDocsOptions) SetSkip 

func (_options *GetSchedulerDocsOptions) SetSkip(skip int64) *GetSchedulerDocsOptions

SetSkip : Allow user to set Skip

func (*GetSchedulerDocsOptions) SetStates 

func (_options *GetSchedulerDocsOptions) SetStates(states []string) *GetSchedulerDocsOptions

SetStates : Allow user to set States

type GetSchedulerDocumentOptions 

type GetSchedulerDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSchedulerDocumentOptions : The GetSchedulerDocument options.

func (*GetSchedulerDocumentOptions) SetDocID 

func (_options *GetSchedulerDocumentOptions) SetDocID(docID string) *GetSchedulerDocumentOptions

SetDocID : Allow user to set DocID

func (*GetSchedulerDocumentOptions) SetHeaders 

func (options *GetSchedulerDocumentOptions) SetHeaders(param map[string]string) *GetSchedulerDocumentOptions

SetHeaders : Allow user to set Headers

type GetSchedulerJobOptions 

type GetSchedulerJobOptions struct {
	// Path parameter to specify the replication job id.
	JobID *string `json:"job_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSchedulerJobOptions : The GetSchedulerJob options.

func (*GetSchedulerJobOptions) SetHeaders 

func (options *GetSchedulerJobOptions) SetHeaders(param map[string]string) *GetSchedulerJobOptions

SetHeaders : Allow user to set Headers

func (*GetSchedulerJobOptions) SetJobID 

func (_options *GetSchedulerJobOptions) SetJobID(jobID string) *GetSchedulerJobOptions

SetJobID : Allow user to set JobID

type GetSchedulerJobsOptions 

type GetSchedulerJobsOptions struct {
	// Query parameter to specify the number of returned jobs to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Query parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSchedulerJobsOptions : The GetSchedulerJobs options.

func (*GetSchedulerJobsOptions) SetHeaders 

func (options *GetSchedulerJobsOptions) SetHeaders(param map[string]string) *GetSchedulerJobsOptions

SetHeaders : Allow user to set Headers

func (*GetSchedulerJobsOptions) SetLimit 

func (_options *GetSchedulerJobsOptions) SetLimit(limit int64) *GetSchedulerJobsOptions

SetLimit : Allow user to set Limit

func (*GetSchedulerJobsOptions) SetSkip 

func (_options *GetSchedulerJobsOptions) SetSkip(skip int64) *GetSchedulerJobsOptions

SetSkip : Allow user to set Skip

type GetSearchInfoOptions 

type GetSearchInfoOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the index name.
	Index *string `json:"index" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSearchInfoOptions : The GetSearchInfo options.

func (*GetSearchInfoOptions) SetDb 

func (_options *GetSearchInfoOptions) SetDb(db string) *GetSearchInfoOptions

SetDb : Allow user to set Db

func (*GetSearchInfoOptions) SetDdoc 

func (_options *GetSearchInfoOptions) SetDdoc(ddoc string) *GetSearchInfoOptions

SetDdoc : Allow user to set Ddoc

func (*GetSearchInfoOptions) SetHeaders 

func (options *GetSearchInfoOptions) SetHeaders(param map[string]string) *GetSearchInfoOptions

SetHeaders : Allow user to set Headers

func (*GetSearchInfoOptions) SetIndex 

func (_options *GetSearchInfoOptions) SetIndex(index string) *GetSearchInfoOptions

SetIndex : Allow user to set Index

type GetSecurityOptions 

type GetSecurityOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecurityOptions : The GetSecurity options.

func (*GetSecurityOptions) SetDb 

func (_options *GetSecurityOptions) SetDb(db string) *GetSecurityOptions

SetDb : Allow user to set Db

func (*GetSecurityOptions) SetHeaders 

func (options *GetSecurityOptions) SetHeaders(param map[string]string) *GetSecurityOptions

SetHeaders : Allow user to set Headers

type GetServerInformationOptions 

type GetServerInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetServerInformationOptions : The GetServerInformation options.

func (*GetServerInformationOptions) SetHeaders 

func (options *GetServerInformationOptions) SetHeaders(param map[string]string) *GetServerInformationOptions

SetHeaders : Allow user to set Headers

type GetSessionInformationOptions 

type GetSessionInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSessionInformationOptions : The GetSessionInformation options.

func (*GetSessionInformationOptions) SetHeaders 

func (options *GetSessionInformationOptions) SetHeaders(param map[string]string) *GetSessionInformationOptions

SetHeaders : Allow user to set Headers

type GetShardsInformationOptions 

type GetShardsInformationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetShardsInformationOptions : The GetShardsInformation options.

func (*GetShardsInformationOptions) SetDb 

func (_options *GetShardsInformationOptions) SetDb(db string) *GetShardsInformationOptions

SetDb : Allow user to set Db

func (*GetShardsInformationOptions) SetHeaders 

func (options *GetShardsInformationOptions) SetHeaders(param map[string]string) *GetShardsInformationOptions

SetHeaders : Allow user to set Headers

type GetUpInformationOptions 

type GetUpInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetUpInformationOptions : The GetUpInformation options.

func (*GetUpInformationOptions) SetHeaders 

func (options *GetUpInformationOptions) SetHeaders(param map[string]string) *GetUpInformationOptions

SetHeaders : Allow user to set Headers

type GetUuidsOptions 

type GetUuidsOptions struct {
	// Query parameter to specify the number of UUIDs to return.
	Count *int64 `json:"count,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetUuidsOptions : The GetUuids options.

func (*GetUuidsOptions) SetCount 

func (_options *GetUuidsOptions) SetCount(count int64) *GetUuidsOptions

SetCount : Allow user to set Count

func (*GetUuidsOptions) SetHeaders 

func (options *GetUuidsOptions) SetHeaders(param map[string]string) *GetUuidsOptions

SetHeaders : Allow user to set Headers

type HeadAttachmentOptions 

type HeadAttachmentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Path parameter to specify the attachment name.
	AttachmentName *string `json:"attachment_name" validate:"required,ne="`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadAttachmentOptions : The HeadAttachment options.

func (*HeadAttachmentOptions) SetAttachmentName 

func (_options *HeadAttachmentOptions) SetAttachmentName(attachmentName string) *HeadAttachmentOptions

SetAttachmentName : Allow user to set AttachmentName

func (*HeadAttachmentOptions) SetDb 

func (_options *HeadAttachmentOptions) SetDb(db string) *HeadAttachmentOptions

SetDb : Allow user to set Db

func (*HeadAttachmentOptions) SetDocID 

func (_options *HeadAttachmentOptions) SetDocID(docID string) *HeadAttachmentOptions

SetDocID : Allow user to set DocID

func (*HeadAttachmentOptions) SetHeaders 

func (options *HeadAttachmentOptions) SetHeaders(param map[string]string) *HeadAttachmentOptions

SetHeaders : Allow user to set Headers

func (*HeadAttachmentOptions) SetIfMatch 

func (_options *HeadAttachmentOptions) SetIfMatch(ifMatch string) *HeadAttachmentOptions

SetIfMatch : Allow user to set IfMatch

func (*HeadAttachmentOptions) SetIfNoneMatch 

func (_options *HeadAttachmentOptions) SetIfNoneMatch(ifNoneMatch string) *HeadAttachmentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*HeadAttachmentOptions) SetRev 

func (_options *HeadAttachmentOptions) SetRev(rev string) *HeadAttachmentOptions

SetRev : Allow user to set Rev

type HeadDatabaseOptions 

type HeadDatabaseOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadDatabaseOptions : The HeadDatabase options.

func (*HeadDatabaseOptions) SetDb 

func (_options *HeadDatabaseOptions) SetDb(db string) *HeadDatabaseOptions

SetDb : Allow user to set Db

func (*HeadDatabaseOptions) SetHeaders 

func (options *HeadDatabaseOptions) SetHeaders(param map[string]string) *HeadDatabaseOptions

SetHeaders : Allow user to set Headers

type HeadDesignDocumentOptions 

type HeadDesignDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadDesignDocumentOptions : The HeadDesignDocument options.

func (*HeadDesignDocumentOptions) SetDb 

func (_options *HeadDesignDocumentOptions) SetDb(db string) *HeadDesignDocumentOptions

SetDb : Allow user to set Db

func (*HeadDesignDocumentOptions) SetDdoc 

func (_options *HeadDesignDocumentOptions) SetDdoc(ddoc string) *HeadDesignDocumentOptions

SetDdoc : Allow user to set Ddoc

func (*HeadDesignDocumentOptions) SetHeaders 

func (options *HeadDesignDocumentOptions) SetHeaders(param map[string]string) *HeadDesignDocumentOptions

SetHeaders : Allow user to set Headers

func (*HeadDesignDocumentOptions) SetIfNoneMatch 

func (_options *HeadDesignDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *HeadDesignDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

type HeadDocumentOptions 

type HeadDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
	Latest *bool `json:"latest,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadDocumentOptions : The HeadDocument options.

func (*HeadDocumentOptions) SetDb 

func (_options *HeadDocumentOptions) SetDb(db string) *HeadDocumentOptions

SetDb : Allow user to set Db

func (*HeadDocumentOptions) SetDocID 

func (_options *HeadDocumentOptions) SetDocID(docID string) *HeadDocumentOptions

SetDocID : Allow user to set DocID

func (*HeadDocumentOptions) SetHeaders 

func (options *HeadDocumentOptions) SetHeaders(param map[string]string) *HeadDocumentOptions

SetHeaders : Allow user to set Headers

func (*HeadDocumentOptions) SetIfNoneMatch 

func (_options *HeadDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *HeadDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

func (*HeadDocumentOptions) SetLatest 

func (_options *HeadDocumentOptions) SetLatest(latest bool) *HeadDocumentOptions

SetLatest : Allow user to set Latest

func (*HeadDocumentOptions) SetRev 

func (_options *HeadDocumentOptions) SetRev(rev string) *HeadDocumentOptions

SetRev : Allow user to set Rev

type HeadLocalDocumentOptions added in v0.0.29 

type HeadLocalDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadLocalDocumentOptions : The HeadLocalDocument options.

func (*HeadLocalDocumentOptions) SetDb added in v0.0.29 

func (_options *HeadLocalDocumentOptions) SetDb(db string) *HeadLocalDocumentOptions

SetDb : Allow user to set Db

func (*HeadLocalDocumentOptions) SetDocID added in v0.0.29 

func (_options *HeadLocalDocumentOptions) SetDocID(docID string) *HeadLocalDocumentOptions

SetDocID : Allow user to set DocID

func (*HeadLocalDocumentOptions) SetHeaders added in v0.0.29 

func (options *HeadLocalDocumentOptions) SetHeaders(param map[string]string) *HeadLocalDocumentOptions

SetHeaders : Allow user to set Headers

func (*HeadLocalDocumentOptions) SetIfNoneMatch added in v0.0.29 

func (_options *HeadLocalDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *HeadLocalDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

type HeadReplicationDocumentOptions 

type HeadReplicationDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Header parameter to specify a double quoted document revision token for cache control.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadReplicationDocumentOptions : The HeadReplicationDocument options.

func (*HeadReplicationDocumentOptions) SetDocID 

func (_options *HeadReplicationDocumentOptions) SetDocID(docID string) *HeadReplicationDocumentOptions

SetDocID : Allow user to set DocID

func (*HeadReplicationDocumentOptions) SetHeaders 

func (options *HeadReplicationDocumentOptions) SetHeaders(param map[string]string) *HeadReplicationDocumentOptions

SetHeaders : Allow user to set Headers

func (*HeadReplicationDocumentOptions) SetIfNoneMatch 

func (_options *HeadReplicationDocumentOptions) SetIfNoneMatch(ifNoneMatch string) *HeadReplicationDocumentOptions

SetIfNoneMatch : Allow user to set IfNoneMatch

type HeadSchedulerDocumentOptions added in v0.0.29 

type HeadSchedulerDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadSchedulerDocumentOptions : The HeadSchedulerDocument options.

func (*HeadSchedulerDocumentOptions) SetDocID added in v0.0.29 

func (_options *HeadSchedulerDocumentOptions) SetDocID(docID string) *HeadSchedulerDocumentOptions

SetDocID : Allow user to set DocID

func (*HeadSchedulerDocumentOptions) SetHeaders added in v0.0.29 

func (options *HeadSchedulerDocumentOptions) SetHeaders(param map[string]string) *HeadSchedulerDocumentOptions

SetHeaders : Allow user to set Headers

type HeadSchedulerJobOptions 

type HeadSchedulerJobOptions struct {
	// Path parameter to specify the replication job id.
	JobID *string `json:"job_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadSchedulerJobOptions : The HeadSchedulerJob options.

func (*HeadSchedulerJobOptions) SetHeaders 

func (options *HeadSchedulerJobOptions) SetHeaders(param map[string]string) *HeadSchedulerJobOptions

SetHeaders : Allow user to set Headers

func (*HeadSchedulerJobOptions) SetJobID 

func (_options *HeadSchedulerJobOptions) SetJobID(jobID string) *HeadSchedulerJobOptions

SetJobID : Allow user to set JobID

type HeadUpInformationOptions added in v0.0.29 

type HeadUpInformationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

HeadUpInformationOptions : The HeadUpInformation options.

func (*HeadUpInformationOptions) SetHeaders added in v0.0.29 

func (options *HeadUpInformationOptions) SetHeaders(param map[string]string) *HeadUpInformationOptions

SetHeaders : Allow user to set Headers

type IndexDefinition 

type IndexDefinition struct {
	// Schema for a full text search analyzer.
	DefaultAnalyzer *Analyzer `json:"default_analyzer,omitempty"`

	// Schema for the text index default field configuration. The default field is used to index the text of all fields
	// within a document for use with the `$text` operator.
	DefaultField *IndexTextOperatorDefaultField `json:"default_field,omitempty"`

	// List of field objects to index.  Nested fields are also allowed, e.g. `person.name`.
	//
	// For "json" type indexes each object is a mapping of field name to sort direction (asc or desc).
	//
	// For "text" type indexes each object has a `name` property of the field name and a `type` property of the field type
	// (string, number, or boolean).
	Fields []IndexField `json:"fields,omitempty"`

	// Whether to scan every document for arrays and store the length for each array found. Set the index_array_lengths
	// field to false if:
	// * You do not need to know the length of an array. * You do not use the `$size` operator. * The documents in your
	// database are complex, or not completely under your control. As a result, it is difficult to estimate the impact of
	// the extra processing that is needed to determine and store the arrays lengths.
	IndexArrayLengths *bool `json:"index_array_lengths,omitempty"`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	PartialFilterSelector map[string]interface{} `json:"partial_filter_selector,omitempty"`
}

IndexDefinition : Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration properties that do not apply to `json` indexes, these are: * `default_analyzer` - the default text analyzer to use * `default_field` - whether to index the text in all document fields and what analyzer to use for that purpose.

type IndexField 

type IndexField struct {
	// Name of the field.
	Name *string `json:"name,omitempty"`

	// The type of the named field.
	Type *string `json:"type,omitempty"`
	// contains filtered or unexported fields
}

IndexField : Schema for indexed fields for use with declarative JSON query.

func (*IndexField) GetProperties 

func (o *IndexField) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of IndexField

func (*IndexField) GetProperty 

func (o *IndexField) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of IndexField

func (*IndexField) MarshalJSON 

func (o *IndexField) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of IndexField

func (*IndexField) SetProperties added in v0.0.37 

func (o *IndexField) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of IndexField

func (*IndexField) SetProperty 

func (o *IndexField) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of IndexField

type IndexInformation 

type IndexInformation struct {
	// Design document ID including a `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required"`

	// Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration
	// properties that do not apply to `json` indexes, these are:
	// * `default_analyzer` - the default text analyzer to use * `default_field` - whether to index the text in all
	// document fields and what analyzer to use for that purpose.
	Def *IndexDefinition `json:"def" validate:"required"`

	// Index name.
	Name *string `json:"name" validate:"required"`

	// Indicates if index is partitioned.
	Partitioned *bool `json:"partitioned,omitempty"`

	// Schema for the type of an index.
	Type *string `json:"type" validate:"required"`
}

IndexInformation : Schema for information about an index.

type IndexResult 

type IndexResult struct {
	// Id of the design document the index was created in.
	ID *string `json:"id" validate:"required"`

	// Name of the index created.
	Name *string `json:"name" validate:"required"`

	// Flag to show whether the index was created or one already exists.
	Result *string `json:"result" validate:"required"`
}

IndexResult : Schema for the result of creating an index.

type IndexTextOperatorDefaultField 

type IndexTextOperatorDefaultField struct {
	// Schema for a full text search analyzer.
	Analyzer *Analyzer `json:"analyzer,omitempty"`

	// Whether or not the default_field is enabled.
	Enabled *bool `json:"enabled,omitempty"`
}

IndexTextOperatorDefaultField : Schema for the text index default field configuration. The default field is used to index the text of all fields within a document for use with the `$text` operator.

type IndexesInformation 

type IndexesInformation struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// Indexes.
	Indexes []IndexInformation `json:"indexes" validate:"required"`
}

IndexesInformation : Schema for information about the indexes in a database.

type MembershipInformation 

type MembershipInformation struct {
	// List of nodes this node knows about, including the ones that are part of the cluster.
	AllNodes []string `json:"all_nodes" validate:"required"`

	// All cluster nodes.
	ClusterNodes []string `json:"cluster_nodes" validate:"required"`
}

MembershipInformation : Schema for information about known nodes and cluster membership.

type Ok 

type Ok struct {
	// ok.
	Ok *bool `json:"ok,omitempty"`
}

Ok : Schema for an OK result.

type PartitionInformation 

type PartitionInformation struct {
	// The name of the database.
	DbName *string `json:"db_name" validate:"required"`

	// A count of the documents in the specified database partition.
	DocCount *int64 `json:"doc_count" validate:"required"`

	// Number of deleted documents.
	DocDelCount *int64 `json:"doc_del_count" validate:"required"`

	// The name of the partition in the database.
	Partition *string `json:"partition" validate:"required"`

	// Schema for information about the partition index count and limit in a database.
	PartitionedIndexes *PartitionInformationIndexes `json:"partitioned_indexes,omitempty"`

	// The size of active and external data, in bytes.
	Sizes *PartitionInformationSizes `json:"sizes" validate:"required"`
}

PartitionInformation : Schema for information about a database partition.

type PartitionInformationIndexes 

type PartitionInformationIndexes struct {
	// Total count of the partitioned indexes.
	Count *int64 `json:"count,omitempty"`

	// The count breakdown of partitioned indexes.
	Indexes *PartitionInformationIndexesIndexes `json:"indexes,omitempty"`

	// The partitioned index limit.
	Limit *int64 `json:"limit,omitempty"`
}

PartitionInformationIndexes : Schema for information about the partition index count and limit in a database.

type PartitionInformationIndexesIndexes 

type PartitionInformationIndexesIndexes struct {
	// Number of partitioned search indexes.
	Search *int64 `json:"search,omitempty"`

	// Number of partitioned view indexes.
	View *int64 `json:"view,omitempty"`
}

PartitionInformationIndexesIndexes : The count breakdown of partitioned indexes.

type PartitionInformationSizes 

type PartitionInformationSizes struct {
	// The size of live data inside the database, in bytes.
	Active *int64 `json:"active,omitempty"`

	// The uncompressed size of database contents in bytes.
	External *int64 `json:"external,omitempty"`
}

PartitionInformationSizes : The size of active and external data, in bytes.

type PartitionedIndexesDetailedInformation added in v0.6.0 

type PartitionedIndexesDetailedInformation struct {
	// Number of partitioned indexes of search type.
	Search *int64 `json:"search,omitempty"`

	// Number of partitioned indexes of view type.
	View *int64 `json:"view,omitempty"`
}

PartitionedIndexesDetailedInformation : Number of partitioned indexes by type.

type PartitionedIndexesInformation added in v0.6.0 

type PartitionedIndexesInformation struct {
	// Total number of partitioned indexes in the database.
	Count *int64 `json:"count,omitempty"`

	// Number of partitioned indexes by type.
	Indexes *PartitionedIndexesDetailedInformation `json:"indexes,omitempty"`

	// Maximum allowed number of partitioned indexes in the database.
	Limit *int64 `json:"limit,omitempty"`
}

PartitionedIndexesInformation : Information about database's partitioned indexes.

type PostActivityTrackerEventsOptions added in v0.0.32 

type PostActivityTrackerEventsOptions struct {
	// An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.
	// "management" is a required element of this array.
	Types []string `json:"types" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostActivityTrackerEventsOptions : The PostActivityTrackerEvents options.

func (*PostActivityTrackerEventsOptions) SetHeaders added in v0.0.32 

func (options *PostActivityTrackerEventsOptions) SetHeaders(param map[string]string) *PostActivityTrackerEventsOptions

SetHeaders : Allow user to set Headers

func (*PostActivityTrackerEventsOptions) SetTypes added in v0.0.32 

func (_options *PostActivityTrackerEventsOptions) SetTypes(types []string) *PostActivityTrackerEventsOptions

SetTypes : Allow user to set Types

type PostAllDocsOptions 

type PostAllDocsOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for a document ID.
	EndKey *string `json:"end_key,omitempty"`

	// Schema for a document ID.
	Key *string `json:"key,omitempty"`

	// Schema for a list of document IDs.
	Keys []string `json:"keys,omitempty"`

	// Schema for a document ID.
	StartKey *string `json:"start_key,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostAllDocsOptions : The PostAllDocs options.

func (*PostAllDocsOptions) SetAttEncodingInfo 

func (_options *PostAllDocsOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostAllDocsOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostAllDocsOptions) SetAttachments 

func (_options *PostAllDocsOptions) SetAttachments(attachments bool) *PostAllDocsOptions

SetAttachments : Allow user to set Attachments

func (*PostAllDocsOptions) SetConflicts 

func (_options *PostAllDocsOptions) SetConflicts(conflicts bool) *PostAllDocsOptions

SetConflicts : Allow user to set Conflicts

func (*PostAllDocsOptions) SetDb 

func (_options *PostAllDocsOptions) SetDb(db string) *PostAllDocsOptions

SetDb : Allow user to set Db

func (*PostAllDocsOptions) SetDescending 

func (_options *PostAllDocsOptions) SetDescending(descending bool) *PostAllDocsOptions

SetDescending : Allow user to set Descending

func (*PostAllDocsOptions) SetEndKey added in v0.1.0 

func (_options *PostAllDocsOptions) SetEndKey(endKey string) *PostAllDocsOptions

SetEndKey : Allow user to set EndKey

func (*PostAllDocsOptions) SetHeaders 

func (options *PostAllDocsOptions) SetHeaders(param map[string]string) *PostAllDocsOptions

SetHeaders : Allow user to set Headers

func (*PostAllDocsOptions) SetIncludeDocs 

func (_options *PostAllDocsOptions) SetIncludeDocs(includeDocs bool) *PostAllDocsOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostAllDocsOptions) SetInclusiveEnd 

func (_options *PostAllDocsOptions) SetInclusiveEnd(inclusiveEnd bool) *PostAllDocsOptions

SetInclusiveEnd : Allow user to set InclusiveEnd

func (*PostAllDocsOptions) SetKey 

func (_options *PostAllDocsOptions) SetKey(key string) *PostAllDocsOptions

SetKey : Allow user to set Key

func (*PostAllDocsOptions) SetKeys 

func (_options *PostAllDocsOptions) SetKeys(keys []string) *PostAllDocsOptions

SetKeys : Allow user to set Keys

func (*PostAllDocsOptions) SetLimit 

func (_options *PostAllDocsOptions) SetLimit(limit int64) *PostAllDocsOptions

SetLimit : Allow user to set Limit

func (*PostAllDocsOptions) SetSkip 

func (_options *PostAllDocsOptions) SetSkip(skip int64) *PostAllDocsOptions

SetSkip : Allow user to set Skip

func (*PostAllDocsOptions) SetStartKey added in v0.1.0 

func (_options *PostAllDocsOptions) SetStartKey(startKey string) *PostAllDocsOptions

SetStartKey : Allow user to set StartKey

func (*PostAllDocsOptions) SetUpdateSeq 

func (_options *PostAllDocsOptions) SetUpdateSeq(updateSeq bool) *PostAllDocsOptions

SetUpdateSeq : Allow user to set UpdateSeq

type PostAllDocsQueriesOptions 

type PostAllDocsQueriesOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// An array of query objects with fields for the parameters of each individual view query to be executed. The field
	// names and their meaning are the same as the query parameters of a regular `/_all_docs` request.
	Queries []AllDocsQuery `json:"queries" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostAllDocsQueriesOptions : The PostAllDocsQueries options.

func (*PostAllDocsQueriesOptions) SetDb 

func (_options *PostAllDocsQueriesOptions) SetDb(db string) *PostAllDocsQueriesOptions

SetDb : Allow user to set Db

func (*PostAllDocsQueriesOptions) SetHeaders 

func (options *PostAllDocsQueriesOptions) SetHeaders(param map[string]string) *PostAllDocsQueriesOptions

SetHeaders : Allow user to set Headers

func (*PostAllDocsQueriesOptions) SetQueries 

func (_options *PostAllDocsQueriesOptions) SetQueries(queries []AllDocsQuery) *PostAllDocsQueriesOptions

SetQueries : Allow user to set Queries

type PostApiKeysOptions 

type PostApiKeysOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostApiKeysOptions : The PostApiKeys options.

func (*PostApiKeysOptions) SetHeaders 

func (options *PostApiKeysOptions) SetHeaders(param map[string]string) *PostApiKeysOptions

SetHeaders : Allow user to set Headers

type PostBulkDocsOptions 

type PostBulkDocsOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// HTTP request body for postBulkDocs.
	BulkDocs *BulkDocs `json:"bulkDocs,omitempty"`

	// HTTP request body for postBulkDocs.
	Body io.ReadCloser `json:"body,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostBulkDocsOptions : The PostBulkDocs options.

func (*PostBulkDocsOptions) SetBody 

func (_options *PostBulkDocsOptions) SetBody(body io.ReadCloser) *PostBulkDocsOptions

SetBody : Allow user to set Body

func (*PostBulkDocsOptions) SetBulkDocs 

func (_options *PostBulkDocsOptions) SetBulkDocs(bulkDocs *BulkDocs) *PostBulkDocsOptions

SetBulkDocs : Allow user to set BulkDocs

func (*PostBulkDocsOptions) SetDb 

func (_options *PostBulkDocsOptions) SetDb(db string) *PostBulkDocsOptions

SetDb : Allow user to set Db

func (*PostBulkDocsOptions) SetHeaders 

func (options *PostBulkDocsOptions) SetHeaders(param map[string]string) *PostBulkDocsOptions

SetHeaders : Allow user to set Headers

type PostBulkGetOptions 

type PostBulkGetOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// List of document items to get in bulk.
	Docs []BulkGetQueryDocument `json:"docs" validate:"required"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
	Latest *bool `json:"latest,omitempty"`

	// Query parameter to specify whether to include a list of all known document revisions.
	Revs *bool `json:"revs,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostBulkGetOptions : The PostBulkGet options.

func (*PostBulkGetOptions) SetAttEncodingInfo 

func (_options *PostBulkGetOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostBulkGetOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostBulkGetOptions) SetAttachments 

func (_options *PostBulkGetOptions) SetAttachments(attachments bool) *PostBulkGetOptions

SetAttachments : Allow user to set Attachments

func (*PostBulkGetOptions) SetDb 

func (_options *PostBulkGetOptions) SetDb(db string) *PostBulkGetOptions

SetDb : Allow user to set Db

func (*PostBulkGetOptions) SetDocs 

func (_options *PostBulkGetOptions) SetDocs(docs []BulkGetQueryDocument) *PostBulkGetOptions

SetDocs : Allow user to set Docs

func (*PostBulkGetOptions) SetHeaders 

func (options *PostBulkGetOptions) SetHeaders(param map[string]string) *PostBulkGetOptions

SetHeaders : Allow user to set Headers

func (*PostBulkGetOptions) SetLatest 

func (_options *PostBulkGetOptions) SetLatest(latest bool) *PostBulkGetOptions

SetLatest : Allow user to set Latest

func (*PostBulkGetOptions) SetRevs 

func (_options *PostBulkGetOptions) SetRevs(revs bool) *PostBulkGetOptions

SetRevs : Allow user to set Revs

type PostChangesOptions 

type PostChangesOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Schema for a list of document IDs.
	DocIds []string `json:"doc_ids,omitempty"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields,omitempty"`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector,omitempty"`

	// Header parameter to specify the ID of the last events received by the server on a previous connection. Overrides
	// `since` query parameter.
	LastEventID *string `json:"Last-Event-ID,omitempty"`

	// Query parameter to specify whether to include the encoding information in attachment stubs if the particular
	// attachment is compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Query parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
	// when `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Query parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Query parameter to specify the changes feed type.
	Feed *string `json:"feed,omitempty"`

	// Query parameter to specify a filter function from a design document that will filter the changes stream emitting
	// only filtered events. For example: `design_doc/filtername`.
	//
	// Additionally, some keywords are reserved for built-in filters:
	//
	//   * `_design` - Returns only changes to design documents.
	//   * `_doc_ids` - Returns changes for documents with an ID matching one specified in
	//       `doc_ids` request body parameter.
	//   * `_selector` - Returns changes for documents that match the `selector`
	//       request body parameter. The selector syntax is the same as used for
	//       `_find`.
	//   * `_view` - Returns changes for documents that match an existing map
	//       function in the view specified by the query parameter `view`.
	Filter *string `json:"filter,omitempty"`

	// Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off by
	// default and only applicable for
	// `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true`
	// to use a value of `60000`.
	//
	// **Note:** Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an
	// environment where idle network connections may break, `heartbeat` is not suitable as a keepalive mechanism. Instead,
	// consider one of the following options:
	//   * Use the `timeout` parameter with a value that is compatible with your network environment.
	//   * Switch to scheduled usage of one of the non-continuous changes feed types
	//     (`normal` or `longpoll`).
	//   * Use TCP keepalive.
	Heartbeat *int64 `json:"heartbeat,omitempty"`

	// Query parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Query parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Query parameter to specify that the update seq should only be calculated with every Nth result returned. When
	// fetching changes in a batch, setting <code>seq_interval=&lt;batch size&gt;</code>, where &lt;batch size&gt; is the
	// number of results requested per batch, load can be reduced on the source database as computing the seq value across
	// many shards (especially in highly-sharded databases) is expensive.
	SeqInterval *int64 `json:"seq_interval,omitempty"`

	// Query parameter to specify to start the results from the change immediately after the given update sequence. Can be
	// a valid update sequence or `now` value. Default is `0` i.e. all changes.
	Since *string `json:"since,omitempty"`

	// Query parameter to specify how many revisions are returned in the changes array. The default, `main_only`, will only
	// return the current "winning" revision; all_docs will return all leaf revisions (including conflicts and deleted
	// former conflicts).
	Style *string `json:"style,omitempty"`

	// Query parameter to specify the maximum period in milliseconds to wait for a change before the response is sent, even
	// if there are no results. Only applicable for `longpoll` or `continuous` feeds. Default value is specified by
	// `httpd/changes_timeout` configuration option. Note that `60000` value is also the default maximum timeout to prevent
	// undetected dead connections.
	Timeout *int64 `json:"timeout,omitempty"`

	// Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function emits
	// at least one record for them.
	View *string `json:"view,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostChangesOptions : The PostChanges options.

func (*PostChangesOptions) SetAttEncodingInfo 

func (_options *PostChangesOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostChangesOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostChangesOptions) SetAttachments 

func (_options *PostChangesOptions) SetAttachments(attachments bool) *PostChangesOptions

SetAttachments : Allow user to set Attachments

func (*PostChangesOptions) SetConflicts 

func (_options *PostChangesOptions) SetConflicts(conflicts bool) *PostChangesOptions

SetConflicts : Allow user to set Conflicts

func (*PostChangesOptions) SetDb 

func (_options *PostChangesOptions) SetDb(db string) *PostChangesOptions

SetDb : Allow user to set Db

func (*PostChangesOptions) SetDescending 

func (_options *PostChangesOptions) SetDescending(descending bool) *PostChangesOptions

SetDescending : Allow user to set Descending

func (*PostChangesOptions) SetDocIds 

func (_options *PostChangesOptions) SetDocIds(docIds []string) *PostChangesOptions

SetDocIds : Allow user to set DocIds

func (*PostChangesOptions) SetFeed 

func (_options *PostChangesOptions) SetFeed(feed string) *PostChangesOptions

SetFeed : Allow user to set Feed

func (*PostChangesOptions) SetFields added in v0.0.24 

func (_options *PostChangesOptions) SetFields(fields []string) *PostChangesOptions

SetFields : Allow user to set Fields

func (*PostChangesOptions) SetFilter 

func (_options *PostChangesOptions) SetFilter(filter string) *PostChangesOptions

SetFilter : Allow user to set Filter

func (*PostChangesOptions) SetHeaders 

func (options *PostChangesOptions) SetHeaders(param map[string]string) *PostChangesOptions

SetHeaders : Allow user to set Headers

func (*PostChangesOptions) SetHeartbeat 

func (_options *PostChangesOptions) SetHeartbeat(heartbeat int64) *PostChangesOptions

SetHeartbeat : Allow user to set Heartbeat

func (*PostChangesOptions) SetIncludeDocs 

func (_options *PostChangesOptions) SetIncludeDocs(includeDocs bool) *PostChangesOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostChangesOptions) SetLastEventID 

func (_options *PostChangesOptions) SetLastEventID(lastEventID string) *PostChangesOptions

SetLastEventID : Allow user to set LastEventID

func (*PostChangesOptions) SetLimit 

func (_options *PostChangesOptions) SetLimit(limit int64) *PostChangesOptions

SetLimit : Allow user to set Limit

func (*PostChangesOptions) SetSelector 

func (_options *PostChangesOptions) SetSelector(selector map[string]interface{}) *PostChangesOptions

SetSelector : Allow user to set Selector

func (*PostChangesOptions) SetSeqInterval 

func (_options *PostChangesOptions) SetSeqInterval(seqInterval int64) *PostChangesOptions

SetSeqInterval : Allow user to set SeqInterval

func (*PostChangesOptions) SetSince 

func (_options *PostChangesOptions) SetSince(since string) *PostChangesOptions

SetSince : Allow user to set Since

func (*PostChangesOptions) SetStyle 

func (_options *PostChangesOptions) SetStyle(style string) *PostChangesOptions

SetStyle : Allow user to set Style

func (*PostChangesOptions) SetTimeout 

func (_options *PostChangesOptions) SetTimeout(timeout int64) *PostChangesOptions

SetTimeout : Allow user to set Timeout

func (*PostChangesOptions) SetView 

func (_options *PostChangesOptions) SetView(view string) *PostChangesOptions

SetView : Allow user to set View

type PostDbsInfoOptions 

type PostDbsInfoOptions struct {
	// A list of database names.
	Keys []string `json:"keys" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostDbsInfoOptions : The PostDbsInfo options.

func (*PostDbsInfoOptions) SetHeaders 

func (options *PostDbsInfoOptions) SetHeaders(param map[string]string) *PostDbsInfoOptions

SetHeaders : Allow user to set Headers

func (*PostDbsInfoOptions) SetKeys 

func (_options *PostDbsInfoOptions) SetKeys(keys []string) *PostDbsInfoOptions

SetKeys : Allow user to set Keys

type PostDesignDocsOptions 

type PostDesignDocsOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// The type of the response: application/json or application/octet-stream.
	Accept *string `json:"Accept,omitempty"`

	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for a document ID.
	EndKey *string `json:"end_key,omitempty"`

	// Schema for a document ID.
	Key *string `json:"key,omitempty"`

	// Schema for a list of document IDs.
	Keys []string `json:"keys,omitempty"`

	// Schema for a document ID.
	StartKey *string `json:"start_key,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostDesignDocsOptions : The PostDesignDocs options.

func (*PostDesignDocsOptions) SetAccept 

func (_options *PostDesignDocsOptions) SetAccept(accept string) *PostDesignDocsOptions

SetAccept : Allow user to set Accept

func (*PostDesignDocsOptions) SetAttEncodingInfo 

func (_options *PostDesignDocsOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostDesignDocsOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostDesignDocsOptions) SetAttachments 

func (_options *PostDesignDocsOptions) SetAttachments(attachments bool) *PostDesignDocsOptions

SetAttachments : Allow user to set Attachments

func (*PostDesignDocsOptions) SetConflicts 

func (_options *PostDesignDocsOptions) SetConflicts(conflicts bool) *PostDesignDocsOptions

SetConflicts : Allow user to set Conflicts

func (*PostDesignDocsOptions) SetDb 

func (_options *PostDesignDocsOptions) SetDb(db string) *PostDesignDocsOptions

SetDb : Allow user to set Db

func (*PostDesignDocsOptions) SetDescending 

func (_options *PostDesignDocsOptions) SetDescending(descending bool) *PostDesignDocsOptions

SetDescending : Allow user to set Descending

func (*PostDesignDocsOptions) SetEndKey added in v0.1.0 

func (_options *PostDesignDocsOptions) SetEndKey(endKey string) *PostDesignDocsOptions

SetEndKey : Allow user to set EndKey

func (*PostDesignDocsOptions) SetHeaders 

func (options *PostDesignDocsOptions) SetHeaders(param map[string]string) *PostDesignDocsOptions

SetHeaders : Allow user to set Headers

func (*PostDesignDocsOptions) SetIncludeDocs 

func (_options *PostDesignDocsOptions) SetIncludeDocs(includeDocs bool) *PostDesignDocsOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostDesignDocsOptions) SetInclusiveEnd 

func (_options *PostDesignDocsOptions) SetInclusiveEnd(inclusiveEnd bool) *PostDesignDocsOptions

SetInclusiveEnd : Allow user to set InclusiveEnd

func (*PostDesignDocsOptions) SetKey 

func (_options *PostDesignDocsOptions) SetKey(key string) *PostDesignDocsOptions

SetKey : Allow user to set Key

func (*PostDesignDocsOptions) SetKeys 

func (_options *PostDesignDocsOptions) SetKeys(keys []string) *PostDesignDocsOptions

SetKeys : Allow user to set Keys

func (*PostDesignDocsOptions) SetLimit 

func (_options *PostDesignDocsOptions) SetLimit(limit int64) *PostDesignDocsOptions

SetLimit : Allow user to set Limit

func (*PostDesignDocsOptions) SetSkip 

func (_options *PostDesignDocsOptions) SetSkip(skip int64) *PostDesignDocsOptions

SetSkip : Allow user to set Skip

func (*PostDesignDocsOptions) SetStartKey added in v0.1.0 

func (_options *PostDesignDocsOptions) SetStartKey(startKey string) *PostDesignDocsOptions

SetStartKey : Allow user to set StartKey

func (*PostDesignDocsOptions) SetUpdateSeq 

func (_options *PostDesignDocsOptions) SetUpdateSeq(updateSeq bool) *PostDesignDocsOptions

SetUpdateSeq : Allow user to set UpdateSeq

type PostDesignDocsQueriesOptions 

type PostDesignDocsQueriesOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// An array of query objects with fields for the parameters of each individual view query to be executed. The field
	// names and their meaning are the same as the query parameters of a regular `/_all_docs` request.
	Queries []AllDocsQuery `json:"queries" validate:"required"`

	// The type of the response: application/json or application/octet-stream.
	Accept *string `json:"Accept,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostDesignDocsQueriesOptions : The PostDesignDocsQueries options.

func (*PostDesignDocsQueriesOptions) SetAccept 

func (_options *PostDesignDocsQueriesOptions) SetAccept(accept string) *PostDesignDocsQueriesOptions

SetAccept : Allow user to set Accept

func (*PostDesignDocsQueriesOptions) SetDb 

func (_options *PostDesignDocsQueriesOptions) SetDb(db string) *PostDesignDocsQueriesOptions

SetDb : Allow user to set Db

func (*PostDesignDocsQueriesOptions) SetHeaders 

func (options *PostDesignDocsQueriesOptions) SetHeaders(param map[string]string) *PostDesignDocsQueriesOptions

SetHeaders : Allow user to set Headers

func (*PostDesignDocsQueriesOptions) SetQueries 

func (_options *PostDesignDocsQueriesOptions) SetQueries(queries []AllDocsQuery) *PostDesignDocsQueriesOptions

SetQueries : Allow user to set Queries

type PostDocumentOptions 

type PostDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// HTTP request body for Document operations.
	Document *Document `json:"document,omitempty"`

	// HTTP request body for Document operations.
	Body io.ReadCloser `json:"body,omitempty"`

	// The type of the input.
	ContentType *string `json:"Content-Type,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostDocumentOptions : The PostDocument options.

func (*PostDocumentOptions) SetBatch 

func (_options *PostDocumentOptions) SetBatch(batch string) *PostDocumentOptions

SetBatch : Allow user to set Batch

func (*PostDocumentOptions) SetBody 

func (_options *PostDocumentOptions) SetBody(body io.ReadCloser) *PostDocumentOptions

SetBody : Allow user to set Body

func (*PostDocumentOptions) SetContentType 

func (_options *PostDocumentOptions) SetContentType(contentType string) *PostDocumentOptions

SetContentType : Allow user to set ContentType

func (*PostDocumentOptions) SetDb 

func (_options *PostDocumentOptions) SetDb(db string) *PostDocumentOptions

SetDb : Allow user to set Db

func (*PostDocumentOptions) SetDocument 

func (_options *PostDocumentOptions) SetDocument(document *Document) *PostDocumentOptions

SetDocument : Allow user to set Document

func (*PostDocumentOptions) SetHeaders 

func (options *PostDocumentOptions) SetHeaders(param map[string]string) *PostDocumentOptions

SetHeaders : Allow user to set Headers

type PostExplainOptions 

type PostExplainOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// A boolean value that indicates whether or not to include information about existing conflicts in the document.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Use this option to find information about the query that was run. This information includes total key lookups, total
	// document lookups (when `include_docs=true` is used), and total quorum document lookups (when each document replica
	// is fetched).
	ExecutionStats *bool `json:"execution_stats,omitempty"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields,omitempty"`

	// Maximum number of results returned. The `type: text` indexes are limited to 200 results when queried.
	Limit *int64 `json:"limit,omitempty"`

	// Skip the first 'n' results, where 'n' is the value that is specified.
	Skip *int64 `json:"skip,omitempty"`

	// The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The first
	// field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of sort.
	// The field can be any field, using dotted notation if desired for sub-document fields.
	//
	// For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]`
	//
	// When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the
	// same order and each object in the sort array has a single key or at least one of the sort fields is included in the
	// selector. All sorting fields must use the same sort direction, either all ascending or all descending.
	Sort []map[string]string `json:"sort,omitempty"`

	// Whether or not the view results should be returned from a "stable" set of shards.
	Stable *bool `json:"stable,omitempty"`

	// Whether to update the index prior to returning the result.
	Update *string `json:"update,omitempty"`

	// Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant Query
	// algorithm to find the best index.
	UseIndex []string `json:"use_index,omitempty"`

	// The read quorum that is needed for the result. The value defaults to 1, in which case the document that was found in
	// the index is returned. If set to a higher value, each document is read from at least that many replicas before it is
	// returned in the results. The request will take more time than using only the document that is stored locally with
	// the index.
	R *int64 `json:"r,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostExplainOptions : The PostExplain options.

func (*PostExplainOptions) SetBookmark 

func (_options *PostExplainOptions) SetBookmark(bookmark string) *PostExplainOptions

SetBookmark : Allow user to set Bookmark

func (*PostExplainOptions) SetConflicts 

func (_options *PostExplainOptions) SetConflicts(conflicts bool) *PostExplainOptions

SetConflicts : Allow user to set Conflicts

func (*PostExplainOptions) SetDb 

func (_options *PostExplainOptions) SetDb(db string) *PostExplainOptions

SetDb : Allow user to set Db

func (*PostExplainOptions) SetExecutionStats 

func (_options *PostExplainOptions) SetExecutionStats(executionStats bool) *PostExplainOptions

SetExecutionStats : Allow user to set ExecutionStats

func (*PostExplainOptions) SetFields 

func (_options *PostExplainOptions) SetFields(fields []string) *PostExplainOptions

SetFields : Allow user to set Fields

func (*PostExplainOptions) SetHeaders 

func (options *PostExplainOptions) SetHeaders(param map[string]string) *PostExplainOptions

SetHeaders : Allow user to set Headers

func (*PostExplainOptions) SetLimit 

func (_options *PostExplainOptions) SetLimit(limit int64) *PostExplainOptions

SetLimit : Allow user to set Limit

func (*PostExplainOptions) SetR 

func (_options *PostExplainOptions) SetR(r int64) *PostExplainOptions

SetR : Allow user to set R

func (*PostExplainOptions) SetSelector 

func (_options *PostExplainOptions) SetSelector(selector map[string]interface{}) *PostExplainOptions

SetSelector : Allow user to set Selector

func (*PostExplainOptions) SetSkip 

func (_options *PostExplainOptions) SetSkip(skip int64) *PostExplainOptions

SetSkip : Allow user to set Skip

func (*PostExplainOptions) SetSort 

func (_options *PostExplainOptions) SetSort(sort []map[string]string) *PostExplainOptions

SetSort : Allow user to set Sort

func (*PostExplainOptions) SetStable 

func (_options *PostExplainOptions) SetStable(stable bool) *PostExplainOptions

SetStable : Allow user to set Stable

func (*PostExplainOptions) SetUpdate 

func (_options *PostExplainOptions) SetUpdate(update string) *PostExplainOptions

SetUpdate : Allow user to set Update

func (*PostExplainOptions) SetUseIndex 

func (_options *PostExplainOptions) SetUseIndex(useIndex []string) *PostExplainOptions

SetUseIndex : Allow user to set UseIndex

type PostFindOptions 

type PostFindOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// A boolean value that indicates whether or not to include information about existing conflicts in the document.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Use this option to find information about the query that was run. This information includes total key lookups, total
	// document lookups (when `include_docs=true` is used), and total quorum document lookups (when each document replica
	// is fetched).
	ExecutionStats *bool `json:"execution_stats,omitempty"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields,omitempty"`

	// Maximum number of results returned. The `type: text` indexes are limited to 200 results when queried.
	Limit *int64 `json:"limit,omitempty"`

	// Skip the first 'n' results, where 'n' is the value that is specified.
	Skip *int64 `json:"skip,omitempty"`

	// The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The first
	// field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of sort.
	// The field can be any field, using dotted notation if desired for sub-document fields.
	//
	// For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]`
	//
	// When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the
	// same order and each object in the sort array has a single key or at least one of the sort fields is included in the
	// selector. All sorting fields must use the same sort direction, either all ascending or all descending.
	Sort []map[string]string `json:"sort,omitempty"`

	// Whether or not the view results should be returned from a "stable" set of shards.
	Stable *bool `json:"stable,omitempty"`

	// Whether to update the index prior to returning the result.
	Update *string `json:"update,omitempty"`

	// Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant Query
	// algorithm to find the best index.
	UseIndex []string `json:"use_index,omitempty"`

	// The read quorum that is needed for the result. The value defaults to 1, in which case the document that was found in
	// the index is returned. If set to a higher value, each document is read from at least that many replicas before it is
	// returned in the results. The request will take more time than using only the document that is stored locally with
	// the index.
	R *int64 `json:"r,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostFindOptions : The PostFind options.

func (*PostFindOptions) SetBookmark 

func (_options *PostFindOptions) SetBookmark(bookmark string) *PostFindOptions

SetBookmark : Allow user to set Bookmark

func (*PostFindOptions) SetConflicts 

func (_options *PostFindOptions) SetConflicts(conflicts bool) *PostFindOptions

SetConflicts : Allow user to set Conflicts

func (*PostFindOptions) SetDb 

func (_options *PostFindOptions) SetDb(db string) *PostFindOptions

SetDb : Allow user to set Db

func (*PostFindOptions) SetExecutionStats 

func (_options *PostFindOptions) SetExecutionStats(executionStats bool) *PostFindOptions

SetExecutionStats : Allow user to set ExecutionStats

func (*PostFindOptions) SetFields 

func (_options *PostFindOptions) SetFields(fields []string) *PostFindOptions

SetFields : Allow user to set Fields

func (*PostFindOptions) SetHeaders 

func (options *PostFindOptions) SetHeaders(param map[string]string) *PostFindOptions

SetHeaders : Allow user to set Headers

func (*PostFindOptions) SetLimit 

func (_options *PostFindOptions) SetLimit(limit int64) *PostFindOptions

SetLimit : Allow user to set Limit

func (*PostFindOptions) SetR 

func (_options *PostFindOptions) SetR(r int64) *PostFindOptions

SetR : Allow user to set R

func (*PostFindOptions) SetSelector 

func (_options *PostFindOptions) SetSelector(selector map[string]interface{}) *PostFindOptions

SetSelector : Allow user to set Selector

func (*PostFindOptions) SetSkip 

func (_options *PostFindOptions) SetSkip(skip int64) *PostFindOptions

SetSkip : Allow user to set Skip

func (*PostFindOptions) SetSort 

func (_options *PostFindOptions) SetSort(sort []map[string]string) *PostFindOptions

SetSort : Allow user to set Sort

func (*PostFindOptions) SetStable 

func (_options *PostFindOptions) SetStable(stable bool) *PostFindOptions

SetStable : Allow user to set Stable

func (*PostFindOptions) SetUpdate 

func (_options *PostFindOptions) SetUpdate(update string) *PostFindOptions

SetUpdate : Allow user to set Update

func (*PostFindOptions) SetUseIndex 

func (_options *PostFindOptions) SetUseIndex(useIndex []string) *PostFindOptions

SetUseIndex : Allow user to set UseIndex

type PostIndexOptions 

type PostIndexOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration
	// properties that do not apply to `json` indexes, these are:
	// * `default_analyzer` - the default text analyzer to use * `default_field` - whether to index the text in all
	// document fields and what analyzer to use for that purpose.
	Index *IndexDefinition `json:"index" validate:"required"`

	// Specifies the design document name in which the index will be created. The design document name is the design
	// document ID excluding the `_design/` prefix.
	Ddoc *string `json:"ddoc,omitempty"`

	// name.
	Name *string `json:"name,omitempty"`

	// The default value is `true` for databases with `partitioned: true` and `false` otherwise. For databases with
	// `partitioned: false` if this option is specified the value must be `false`.
	Partitioned *bool `json:"partitioned,omitempty"`

	// Schema for the type of an index.
	Type *string `json:"type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostIndexOptions : The PostIndex options.

func (*PostIndexOptions) SetDb 

func (_options *PostIndexOptions) SetDb(db string) *PostIndexOptions

SetDb : Allow user to set Db

func (*PostIndexOptions) SetDdoc 

func (_options *PostIndexOptions) SetDdoc(ddoc string) *PostIndexOptions

SetDdoc : Allow user to set Ddoc

func (*PostIndexOptions) SetHeaders 

func (options *PostIndexOptions) SetHeaders(param map[string]string) *PostIndexOptions

SetHeaders : Allow user to set Headers

func (*PostIndexOptions) SetIndex 

func (_options *PostIndexOptions) SetIndex(index *IndexDefinition) *PostIndexOptions

SetIndex : Allow user to set Index

func (*PostIndexOptions) SetName 

func (_options *PostIndexOptions) SetName(name string) *PostIndexOptions

SetName : Allow user to set Name

func (*PostIndexOptions) SetPartitioned 

func (_options *PostIndexOptions) SetPartitioned(partitioned bool) *PostIndexOptions

SetPartitioned : Allow user to set Partitioned

func (*PostIndexOptions) SetType 

func (_options *PostIndexOptions) SetType(typeVar string) *PostIndexOptions

SetType : Allow user to set Type

type PostPartitionAllDocsOptions 

type PostPartitionAllDocsOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for a document ID.
	EndKey *string `json:"end_key,omitempty"`

	// Schema for a document ID.
	Key *string `json:"key,omitempty"`

	// Schema for a list of document IDs.
	Keys []string `json:"keys,omitempty"`

	// Schema for a document ID.
	StartKey *string `json:"start_key,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostPartitionAllDocsOptions : The PostPartitionAllDocs options.

func (*PostPartitionAllDocsOptions) SetAttEncodingInfo 

func (_options *PostPartitionAllDocsOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostPartitionAllDocsOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostPartitionAllDocsOptions) SetAttachments 

func (_options *PostPartitionAllDocsOptions) SetAttachments(attachments bool) *PostPartitionAllDocsOptions

SetAttachments : Allow user to set Attachments

func (*PostPartitionAllDocsOptions) SetConflicts 

func (_options *PostPartitionAllDocsOptions) SetConflicts(conflicts bool) *PostPartitionAllDocsOptions

SetConflicts : Allow user to set Conflicts

func (*PostPartitionAllDocsOptions) SetDb 

func (_options *PostPartitionAllDocsOptions) SetDb(db string) *PostPartitionAllDocsOptions

SetDb : Allow user to set Db

func (*PostPartitionAllDocsOptions) SetDescending 

func (_options *PostPartitionAllDocsOptions) SetDescending(descending bool) *PostPartitionAllDocsOptions

SetDescending : Allow user to set Descending

func (*PostPartitionAllDocsOptions) SetEndKey added in v0.1.0 

func (_options *PostPartitionAllDocsOptions) SetEndKey(endKey string) *PostPartitionAllDocsOptions

SetEndKey : Allow user to set EndKey

func (*PostPartitionAllDocsOptions) SetHeaders 

func (options *PostPartitionAllDocsOptions) SetHeaders(param map[string]string) *PostPartitionAllDocsOptions

SetHeaders : Allow user to set Headers

func (*PostPartitionAllDocsOptions) SetIncludeDocs 

func (_options *PostPartitionAllDocsOptions) SetIncludeDocs(includeDocs bool) *PostPartitionAllDocsOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostPartitionAllDocsOptions) SetInclusiveEnd 

func (_options *PostPartitionAllDocsOptions) SetInclusiveEnd(inclusiveEnd bool) *PostPartitionAllDocsOptions

SetInclusiveEnd : Allow user to set InclusiveEnd

func (*PostPartitionAllDocsOptions) SetKey 

func (_options *PostPartitionAllDocsOptions) SetKey(key string) *PostPartitionAllDocsOptions

SetKey : Allow user to set Key

func (*PostPartitionAllDocsOptions) SetKeys 

func (_options *PostPartitionAllDocsOptions) SetKeys(keys []string) *PostPartitionAllDocsOptions

SetKeys : Allow user to set Keys

func (*PostPartitionAllDocsOptions) SetLimit 

func (_options *PostPartitionAllDocsOptions) SetLimit(limit int64) *PostPartitionAllDocsOptions

SetLimit : Allow user to set Limit

func (*PostPartitionAllDocsOptions) SetPartitionKey 

func (_options *PostPartitionAllDocsOptions) SetPartitionKey(partitionKey string) *PostPartitionAllDocsOptions

SetPartitionKey : Allow user to set PartitionKey

func (*PostPartitionAllDocsOptions) SetSkip 

func (_options *PostPartitionAllDocsOptions) SetSkip(skip int64) *PostPartitionAllDocsOptions

SetSkip : Allow user to set Skip

func (*PostPartitionAllDocsOptions) SetStartKey added in v0.1.0 

func (_options *PostPartitionAllDocsOptions) SetStartKey(startKey string) *PostPartitionAllDocsOptions

SetStartKey : Allow user to set StartKey

func (*PostPartitionAllDocsOptions) SetUpdateSeq 

func (_options *PostPartitionAllDocsOptions) SetUpdateSeq(updateSeq bool) *PostPartitionAllDocsOptions

SetUpdateSeq : Allow user to set UpdateSeq

type PostPartitionExplainOptions added in v0.6.0 

type PostPartitionExplainOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// A boolean value that indicates whether or not to include information about existing conflicts in the document.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Use this option to find information about the query that was run. This information includes total key lookups, total
	// document lookups (when `include_docs=true` is used), and total quorum document lookups (when each document replica
	// is fetched).
	ExecutionStats *bool `json:"execution_stats,omitempty"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields,omitempty"`

	// Maximum number of results returned. The `type: text` indexes are limited to 200 results when queried.
	Limit *int64 `json:"limit,omitempty"`

	// Skip the first 'n' results, where 'n' is the value that is specified.
	Skip *int64 `json:"skip,omitempty"`

	// The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The first
	// field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of sort.
	// The field can be any field, using dotted notation if desired for sub-document fields.
	//
	// For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]`
	//
	// When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the
	// same order and each object in the sort array has a single key or at least one of the sort fields is included in the
	// selector. All sorting fields must use the same sort direction, either all ascending or all descending.
	Sort []map[string]string `json:"sort,omitempty"`

	// Whether or not the view results should be returned from a "stable" set of shards.
	Stable *bool `json:"stable,omitempty"`

	// Whether to update the index prior to returning the result.
	Update *string `json:"update,omitempty"`

	// Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant Query
	// algorithm to find the best index.
	UseIndex []string `json:"use_index,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostPartitionExplainOptions : The PostPartitionExplain options.

func (*PostPartitionExplainOptions) SetBookmark added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetBookmark(bookmark string) *PostPartitionExplainOptions

SetBookmark : Allow user to set Bookmark

func (*PostPartitionExplainOptions) SetConflicts added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetConflicts(conflicts bool) *PostPartitionExplainOptions

SetConflicts : Allow user to set Conflicts

func (*PostPartitionExplainOptions) SetDb added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetDb(db string) *PostPartitionExplainOptions

SetDb : Allow user to set Db

func (*PostPartitionExplainOptions) SetExecutionStats added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetExecutionStats(executionStats bool) *PostPartitionExplainOptions

SetExecutionStats : Allow user to set ExecutionStats

func (*PostPartitionExplainOptions) SetFields added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetFields(fields []string) *PostPartitionExplainOptions

SetFields : Allow user to set Fields

func (*PostPartitionExplainOptions) SetHeaders added in v0.6.0 

func (options *PostPartitionExplainOptions) SetHeaders(param map[string]string) *PostPartitionExplainOptions

SetHeaders : Allow user to set Headers

func (*PostPartitionExplainOptions) SetLimit added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetLimit(limit int64) *PostPartitionExplainOptions

SetLimit : Allow user to set Limit

func (*PostPartitionExplainOptions) SetPartitionKey added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetPartitionKey(partitionKey string) *PostPartitionExplainOptions

SetPartitionKey : Allow user to set PartitionKey

func (*PostPartitionExplainOptions) SetSelector added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetSelector(selector map[string]interface{}) *PostPartitionExplainOptions

SetSelector : Allow user to set Selector

func (*PostPartitionExplainOptions) SetSkip added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetSkip(skip int64) *PostPartitionExplainOptions

SetSkip : Allow user to set Skip

func (*PostPartitionExplainOptions) SetSort added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetSort(sort []map[string]string) *PostPartitionExplainOptions

SetSort : Allow user to set Sort

func (*PostPartitionExplainOptions) SetStable added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetStable(stable bool) *PostPartitionExplainOptions

SetStable : Allow user to set Stable

func (*PostPartitionExplainOptions) SetUpdate added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetUpdate(update string) *PostPartitionExplainOptions

SetUpdate : Allow user to set Update

func (*PostPartitionExplainOptions) SetUseIndex added in v0.6.0 

func (_options *PostPartitionExplainOptions) SetUseIndex(useIndex []string) *PostPartitionExplainOptions

SetUseIndex : Allow user to set UseIndex

type PostPartitionFindOptions 

type PostPartitionFindOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// A boolean value that indicates whether or not to include information about existing conflicts in the document.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Use this option to find information about the query that was run. This information includes total key lookups, total
	// document lookups (when `include_docs=true` is used), and total quorum document lookups (when each document replica
	// is fetched).
	ExecutionStats *bool `json:"execution_stats,omitempty"`

	// JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If
	// it is omitted or empty, the entire document is returned.
	Fields []string `json:"fields,omitempty"`

	// Maximum number of results returned. The `type: text` indexes are limited to 200 results when queried.
	Limit *int64 `json:"limit,omitempty"`

	// Skip the first 'n' results, where 'n' is the value that is specified.
	Skip *int64 `json:"skip,omitempty"`

	// The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The first
	// field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of sort.
	// The field can be any field, using dotted notation if desired for sub-document fields.
	//
	// For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]`
	//
	// When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the
	// same order and each object in the sort array has a single key or at least one of the sort fields is included in the
	// selector. All sorting fields must use the same sort direction, either all ascending or all descending.
	Sort []map[string]string `json:"sort,omitempty"`

	// Whether or not the view results should be returned from a "stable" set of shards.
	Stable *bool `json:"stable,omitempty"`

	// Whether to update the index prior to returning the result.
	Update *string `json:"update,omitempty"`

	// Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant Query
	// algorithm to find the best index.
	UseIndex []string `json:"use_index,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostPartitionFindOptions : The PostPartitionFind options.

func (*PostPartitionFindOptions) SetBookmark 

func (_options *PostPartitionFindOptions) SetBookmark(bookmark string) *PostPartitionFindOptions

SetBookmark : Allow user to set Bookmark

func (*PostPartitionFindOptions) SetConflicts 

func (_options *PostPartitionFindOptions) SetConflicts(conflicts bool) *PostPartitionFindOptions

SetConflicts : Allow user to set Conflicts

func (*PostPartitionFindOptions) SetDb 

func (_options *PostPartitionFindOptions) SetDb(db string) *PostPartitionFindOptions

SetDb : Allow user to set Db

func (*PostPartitionFindOptions) SetExecutionStats 

func (_options *PostPartitionFindOptions) SetExecutionStats(executionStats bool) *PostPartitionFindOptions

SetExecutionStats : Allow user to set ExecutionStats

func (*PostPartitionFindOptions) SetFields 

func (_options *PostPartitionFindOptions) SetFields(fields []string) *PostPartitionFindOptions

SetFields : Allow user to set Fields

func (*PostPartitionFindOptions) SetHeaders 

func (options *PostPartitionFindOptions) SetHeaders(param map[string]string) *PostPartitionFindOptions

SetHeaders : Allow user to set Headers

func (*PostPartitionFindOptions) SetLimit 

func (_options *PostPartitionFindOptions) SetLimit(limit int64) *PostPartitionFindOptions

SetLimit : Allow user to set Limit

func (*PostPartitionFindOptions) SetPartitionKey 

func (_options *PostPartitionFindOptions) SetPartitionKey(partitionKey string) *PostPartitionFindOptions

SetPartitionKey : Allow user to set PartitionKey

func (*PostPartitionFindOptions) SetSelector 

func (_options *PostPartitionFindOptions) SetSelector(selector map[string]interface{}) *PostPartitionFindOptions

SetSelector : Allow user to set Selector

func (*PostPartitionFindOptions) SetSkip 

func (_options *PostPartitionFindOptions) SetSkip(skip int64) *PostPartitionFindOptions

SetSkip : Allow user to set Skip

func (*PostPartitionFindOptions) SetSort 

func (_options *PostPartitionFindOptions) SetSort(sort []map[string]string) *PostPartitionFindOptions

SetSort : Allow user to set Sort

func (*PostPartitionFindOptions) SetStable 

func (_options *PostPartitionFindOptions) SetStable(stable bool) *PostPartitionFindOptions

SetStable : Allow user to set Stable

func (*PostPartitionFindOptions) SetUpdate 

func (_options *PostPartitionFindOptions) SetUpdate(update string) *PostPartitionFindOptions

SetUpdate : Allow user to set Update

func (*PostPartitionFindOptions) SetUseIndex 

func (_options *PostPartitionFindOptions) SetUseIndex(useIndex []string) *PostPartitionFindOptions

SetUseIndex : Allow user to set UseIndex

type PostPartitionSearchOptions 

type PostPartitionSearchOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the index name.
	Index *string `json:"index" validate:"required,ne="`

	// The Lucene query to execute.
	Query *string `json:"query" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// Specifies which fields to highlight. If specified, the result object contains a highlights field with an entry for
	// each specified field.
	HighlightFields []string `json:"highlight_fields,omitempty"`

	// Number of fragments that are returned in highlights. If the search term occurs less often than the number of
	// fragments that are specified, longer fragments are returned.
	HighlightNumber *int64 `json:"highlight_number,omitempty"`

	// A string that is inserted after the highlighted word in the highlights output.
	HighlightPostTag *string `json:"highlight_post_tag,omitempty"`

	// A string that is inserted before the highlighted word in the highlights output.
	HighlightPreTag *string `json:"highlight_pre_tag,omitempty"`

	// Number of characters in each fragment for highlights.
	HighlightSize *int64 `json:"highlight_size,omitempty"`

	// Include the full content of the documents in the return.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// A JSON array of field names to include in search results. Any fields that are included must be indexed with the
	// store:true option. The default is all fields.
	IncludeFields []string `json:"include_fields,omitempty"`

	// Limit the number of the returned documents to the specified number.
	Limit *int64 `json:"limit,omitempty"`

	// Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter specifies
	// the sort order within a group. The default sort order is relevance.  A JSON string of the form
	// "fieldname&lt;type&gt;" or "-fieldname&lt;type&gt;" for descending order, where fieldname is the name of a string or
	// number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and
	// defaults to number. Some examples are "foo", "-foo", "bar&lt;string&gt;", "-foo&lt;number&gt;" and
	// ["-foo&lt;number&gt;", "bar&lt;string&gt;"]. String fields that are used for sorting must not be analyzed fields.
	// Fields that are used for sorting must be indexed by the same indexer that is used for the search query.
	Sort []string `json:"sort,omitempty"`

	// Do not wait for the index to finish building to return results.
	Stale *string `json:"stale,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostPartitionSearchOptions : The PostPartitionSearch options.

func (*PostPartitionSearchOptions) SetBookmark 

func (_options *PostPartitionSearchOptions) SetBookmark(bookmark string) *PostPartitionSearchOptions

SetBookmark : Allow user to set Bookmark

func (*PostPartitionSearchOptions) SetDb 

func (_options *PostPartitionSearchOptions) SetDb(db string) *PostPartitionSearchOptions

SetDb : Allow user to set Db

func (*PostPartitionSearchOptions) SetDdoc 

func (_options *PostPartitionSearchOptions) SetDdoc(ddoc string) *PostPartitionSearchOptions

SetDdoc : Allow user to set Ddoc

func (*PostPartitionSearchOptions) SetHeaders 

func (options *PostPartitionSearchOptions) SetHeaders(param map[string]string) *PostPartitionSearchOptions

SetHeaders : Allow user to set Headers

func (*PostPartitionSearchOptions) SetHighlightFields 

func (_options *PostPartitionSearchOptions) SetHighlightFields(highlightFields []string) *PostPartitionSearchOptions

SetHighlightFields : Allow user to set HighlightFields

func (*PostPartitionSearchOptions) SetHighlightNumber 

func (_options *PostPartitionSearchOptions) SetHighlightNumber(highlightNumber int64) *PostPartitionSearchOptions

SetHighlightNumber : Allow user to set HighlightNumber

func (*PostPartitionSearchOptions) SetHighlightPostTag 

func (_options *PostPartitionSearchOptions) SetHighlightPostTag(highlightPostTag string) *PostPartitionSearchOptions

SetHighlightPostTag : Allow user to set HighlightPostTag

func (*PostPartitionSearchOptions) SetHighlightPreTag 

func (_options *PostPartitionSearchOptions) SetHighlightPreTag(highlightPreTag string) *PostPartitionSearchOptions

SetHighlightPreTag : Allow user to set HighlightPreTag

func (*PostPartitionSearchOptions) SetHighlightSize 

func (_options *PostPartitionSearchOptions) SetHighlightSize(highlightSize int64) *PostPartitionSearchOptions

SetHighlightSize : Allow user to set HighlightSize

func (*PostPartitionSearchOptions) SetIncludeDocs 

func (_options *PostPartitionSearchOptions) SetIncludeDocs(includeDocs bool) *PostPartitionSearchOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostPartitionSearchOptions) SetIncludeFields 

func (_options *PostPartitionSearchOptions) SetIncludeFields(includeFields []string) *PostPartitionSearchOptions

SetIncludeFields : Allow user to set IncludeFields

func (*PostPartitionSearchOptions) SetIndex 

func (_options *PostPartitionSearchOptions) SetIndex(index string) *PostPartitionSearchOptions

SetIndex : Allow user to set Index

func (*PostPartitionSearchOptions) SetLimit 

func (_options *PostPartitionSearchOptions) SetLimit(limit int64) *PostPartitionSearchOptions

SetLimit : Allow user to set Limit

func (*PostPartitionSearchOptions) SetPartitionKey 

func (_options *PostPartitionSearchOptions) SetPartitionKey(partitionKey string) *PostPartitionSearchOptions

SetPartitionKey : Allow user to set PartitionKey

func (*PostPartitionSearchOptions) SetQuery 

func (_options *PostPartitionSearchOptions) SetQuery(query string) *PostPartitionSearchOptions

SetQuery : Allow user to set Query

func (*PostPartitionSearchOptions) SetSort 

func (_options *PostPartitionSearchOptions) SetSort(sort []string) *PostPartitionSearchOptions

SetSort : Allow user to set Sort

func (*PostPartitionSearchOptions) SetStale 

func (_options *PostPartitionSearchOptions) SetStale(stale string) *PostPartitionSearchOptions

SetStale : Allow user to set Stale

type PostPartitionViewOptions 

type PostPartitionViewOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the database partition key.
	PartitionKey *string `json:"partition_key" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the map reduce view function name.
	View *string `json:"view" validate:"required,ne="`

	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for any JSON type.
	EndKey interface{} `json:"end_key,omitempty"`

	// Schema for a document ID.
	EndKeyDocID *string `json:"end_key_doc_id,omitempty"`

	// Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view.
	// If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of
	// array elements with the `group_level` parameter.
	Group *bool `json:"group,omitempty"`

	// Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies
	// group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results
	// are grouped by the entire array key, returning a reduced value for each complete key.
	GroupLevel *int64 `json:"group_level,omitempty"`

	// Schema for any JSON type.
	Key interface{} `json:"key,omitempty"`

	// Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match
	// the key type emitted by the view function.
	Keys []interface{} `json:"keys,omitempty"`

	// Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function
	// is defined.
	Reduce *bool `json:"reduce,omitempty"`

	// Schema for any JSON type.
	StartKey interface{} `json:"start_key,omitempty"`

	// Schema for a document ID.
	StartKeyDocID *string `json:"start_key_doc_id,omitempty"`

	// Parameter to specify whether or not the view in question should be updated prior to responding to the user.
	//
	// * `true` - Return results after the view is updated.
	// * `false` - Return results without updating the view.
	// * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.
	Update *string `json:"update,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostPartitionViewOptions : The PostPartitionView options.

func (*PostPartitionViewOptions) SetAttEncodingInfo 

func (_options *PostPartitionViewOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostPartitionViewOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostPartitionViewOptions) SetAttachments 

func (_options *PostPartitionViewOptions) SetAttachments(attachments bool) *PostPartitionViewOptions

SetAttachments : Allow user to set Attachments

func (*PostPartitionViewOptions) SetConflicts 

func (_options *PostPartitionViewOptions) SetConflicts(conflicts bool) *PostPartitionViewOptions

SetConflicts : Allow user to set Conflicts

func (*PostPartitionViewOptions) SetDb 

func (_options *PostPartitionViewOptions) SetDb(db string) *PostPartitionViewOptions

SetDb : Allow user to set Db

func (*PostPartitionViewOptions) SetDdoc 

func (_options *PostPartitionViewOptions) SetDdoc(ddoc string) *PostPartitionViewOptions

SetDdoc : Allow user to set Ddoc

func (*PostPartitionViewOptions) SetDescending 

func (_options *PostPartitionViewOptions) SetDescending(descending bool) *PostPartitionViewOptions

SetDescending : Allow user to set Descending

func (*PostPartitionViewOptions) SetEndKey added in v0.1.0 

func (_options *PostPartitionViewOptions) SetEndKey(endKey interface{}) *PostPartitionViewOptions

SetEndKey : Allow user to set EndKey

func (*PostPartitionViewOptions) SetEndKeyDocID added in v0.1.0 

func (_options *PostPartitionViewOptions) SetEndKeyDocID(endKeyDocID string) *PostPartitionViewOptions

SetEndKeyDocID : Allow user to set EndKeyDocID

func (*PostPartitionViewOptions) SetGroup 

func (_options *PostPartitionViewOptions) SetGroup(group bool) *PostPartitionViewOptions

SetGroup : Allow user to set Group

func (*PostPartitionViewOptions) SetGroupLevel 

func (_options *PostPartitionViewOptions) SetGroupLevel(groupLevel int64) *PostPartitionViewOptions

SetGroupLevel : Allow user to set GroupLevel

func (*PostPartitionViewOptions) SetHeaders 

func (options *PostPartitionViewOptions) SetHeaders(param map[string]string) *PostPartitionViewOptions

SetHeaders : Allow user to set Headers

func (*PostPartitionViewOptions) SetIncludeDocs 

func (_options *PostPartitionViewOptions) SetIncludeDocs(includeDocs bool) *PostPartitionViewOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostPartitionViewOptions) SetInclusiveEnd 

func (_options *PostPartitionViewOptions) SetInclusiveEnd(inclusiveEnd bool) *PostPartitionViewOptions

SetInclusiveEnd : Allow user to set InclusiveEnd

func (*PostPartitionViewOptions) SetKey 

func (_options *PostPartitionViewOptions) SetKey(key interface{}) *PostPartitionViewOptions

SetKey : Allow user to set Key

func (*PostPartitionViewOptions) SetKeys 

func (_options *PostPartitionViewOptions) SetKeys(keys []interface{}) *PostPartitionViewOptions

SetKeys : Allow user to set Keys

func (*PostPartitionViewOptions) SetLimit 

func (_options *PostPartitionViewOptions) SetLimit(limit int64) *PostPartitionViewOptions

SetLimit : Allow user to set Limit

func (*PostPartitionViewOptions) SetPartitionKey 

func (_options *PostPartitionViewOptions) SetPartitionKey(partitionKey string) *PostPartitionViewOptions

SetPartitionKey : Allow user to set PartitionKey

func (*PostPartitionViewOptions) SetReduce 

func (_options *PostPartitionViewOptions) SetReduce(reduce bool) *PostPartitionViewOptions

SetReduce : Allow user to set Reduce

func (*PostPartitionViewOptions) SetSkip 

func (_options *PostPartitionViewOptions) SetSkip(skip int64) *PostPartitionViewOptions

SetSkip : Allow user to set Skip

func (*PostPartitionViewOptions) SetStartKey added in v0.1.0 

func (_options *PostPartitionViewOptions) SetStartKey(startKey interface{}) *PostPartitionViewOptions

SetStartKey : Allow user to set StartKey

func (*PostPartitionViewOptions) SetStartKeyDocID added in v0.1.0 

func (_options *PostPartitionViewOptions) SetStartKeyDocID(startKeyDocID string) *PostPartitionViewOptions

SetStartKeyDocID : Allow user to set StartKeyDocID

func (*PostPartitionViewOptions) SetUpdate 

func (_options *PostPartitionViewOptions) SetUpdate(update string) *PostPartitionViewOptions

SetUpdate : Allow user to set Update

func (*PostPartitionViewOptions) SetUpdateSeq 

func (_options *PostPartitionViewOptions) SetUpdateSeq(updateSeq bool) *PostPartitionViewOptions

SetUpdateSeq : Allow user to set UpdateSeq

func (*PostPartitionViewOptions) SetView 

func (_options *PostPartitionViewOptions) SetView(view string) *PostPartitionViewOptions

SetView : Allow user to set View

type PostRevsDiffOptions 

type PostRevsDiffOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// HTTP request body for operations with Document revisions.
	DocumentRevisions map[string][]string `json:"documentRevisions" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostRevsDiffOptions : The PostRevsDiff options.

func (*PostRevsDiffOptions) SetDb 

func (_options *PostRevsDiffOptions) SetDb(db string) *PostRevsDiffOptions

SetDb : Allow user to set Db

func (*PostRevsDiffOptions) SetDocumentRevisions added in v0.0.24 

func (_options *PostRevsDiffOptions) SetDocumentRevisions(documentRevisions map[string][]string) *PostRevsDiffOptions

SetDocumentRevisions : Allow user to set DocumentRevisions

func (*PostRevsDiffOptions) SetHeaders 

func (options *PostRevsDiffOptions) SetHeaders(param map[string]string) *PostRevsDiffOptions

SetHeaders : Allow user to set Headers

type PostSearchAnalyzeOptions 

type PostSearchAnalyzeOptions struct {
	// The analyzer type that is being used at the tokenization.
	Analyzer *string `json:"analyzer" validate:"required"`

	// The text to tokenize with the analyzer.
	Text *string `json:"text" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostSearchAnalyzeOptions : The PostSearchAnalyze options.

func (*PostSearchAnalyzeOptions) SetAnalyzer 

func (_options *PostSearchAnalyzeOptions) SetAnalyzer(analyzer string) *PostSearchAnalyzeOptions

SetAnalyzer : Allow user to set Analyzer

func (*PostSearchAnalyzeOptions) SetHeaders 

func (options *PostSearchAnalyzeOptions) SetHeaders(param map[string]string) *PostSearchAnalyzeOptions

SetHeaders : Allow user to set Headers

func (*PostSearchAnalyzeOptions) SetText 

func (_options *PostSearchAnalyzeOptions) SetText(text string) *PostSearchAnalyzeOptions

SetText : Allow user to set Text

type PostSearchOptions 

type PostSearchOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the index name.
	Index *string `json:"index" validate:"required,ne="`

	// The Lucene query to execute.
	Query *string `json:"query" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// Specifies which fields to highlight. If specified, the result object contains a highlights field with an entry for
	// each specified field.
	HighlightFields []string `json:"highlight_fields,omitempty"`

	// Number of fragments that are returned in highlights. If the search term occurs less often than the number of
	// fragments that are specified, longer fragments are returned.
	HighlightNumber *int64 `json:"highlight_number,omitempty"`

	// A string that is inserted after the highlighted word in the highlights output.
	HighlightPostTag *string `json:"highlight_post_tag,omitempty"`

	// A string that is inserted before the highlighted word in the highlights output.
	HighlightPreTag *string `json:"highlight_pre_tag,omitempty"`

	// Number of characters in each fragment for highlights.
	HighlightSize *int64 `json:"highlight_size,omitempty"`

	// Include the full content of the documents in the return.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// A JSON array of field names to include in search results. Any fields that are included must be indexed with the
	// store:true option. The default is all fields.
	IncludeFields []string `json:"include_fields,omitempty"`

	// Limit the number of the returned documents to the specified number.
	Limit *int64 `json:"limit,omitempty"`

	// Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter specifies
	// the sort order within a group. The default sort order is relevance.  A JSON string of the form
	// "fieldname&lt;type&gt;" or "-fieldname&lt;type&gt;" for descending order, where fieldname is the name of a string or
	// number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and
	// defaults to number. Some examples are "foo", "-foo", "bar&lt;string&gt;", "-foo&lt;number&gt;" and
	// ["-foo&lt;number&gt;", "bar&lt;string&gt;"]. String fields that are used for sorting must not be analyzed fields.
	// Fields that are used for sorting must be indexed by the same indexer that is used for the search query.
	Sort []string `json:"sort,omitempty"`

	// Do not wait for the index to finish building to return results.
	Stale *string `json:"stale,omitempty"`

	// This field defines an array of names of string fields, for which counts are requested. The response contains counts
	// for each unique value of this field name among the documents that match the search query. Faceting must be enabled
	// for this parameter to function. This option is only available when making global queries.
	Counts []string `json:"counts,omitempty"`

	// Restrict results to documents with a dimension equal to the specified label(s). The search matches only documents
	// containing the value that was provided in the named field. It differs from using "fieldname:value" in the q
	// parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to function.
	Drilldown [][]string `json:"drilldown,omitempty"`

	// Field by which to group search matches. A string that contains the name of a string field. Fields containing other
	// data such as numbers, objects, or arrays cannot be used. This option is only available when making global queries.
	GroupField *string `json:"group_field,omitempty"`

	// Maximum group count. This field can be used only if group_field is specified. This option is only available when
	// making global queries.
	GroupLimit *int64 `json:"group_limit,omitempty"`

	// This field defines the order of the groups in a search that uses group_field. The default sort order is relevance.
	// This field can have the same values as the sort field, so single fields and arrays of fields are supported. This
	// option is only available when making global queries.
	GroupSort []string `json:"group_sort,omitempty"`

	// This field defines ranges for faceted, numeric search fields. The value is a JSON object where the fields names are
	// faceted numeric search fields, and the values of the fields are JSON objects. The field names of the JSON objects
	// are names for ranges. The values are strings that describe the range, for example "[0 TO 10]". This option is only
	// available when making global queries.
	Ranges map[string]map[string]map[string]string `json:"ranges,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostSearchOptions : The PostSearch options.

func (*PostSearchOptions) SetBookmark 

func (_options *PostSearchOptions) SetBookmark(bookmark string) *PostSearchOptions

SetBookmark : Allow user to set Bookmark

func (*PostSearchOptions) SetCounts 

func (_options *PostSearchOptions) SetCounts(counts []string) *PostSearchOptions

SetCounts : Allow user to set Counts

func (*PostSearchOptions) SetDb 

func (_options *PostSearchOptions) SetDb(db string) *PostSearchOptions

SetDb : Allow user to set Db

func (*PostSearchOptions) SetDdoc 

func (_options *PostSearchOptions) SetDdoc(ddoc string) *PostSearchOptions

SetDdoc : Allow user to set Ddoc

func (*PostSearchOptions) SetDrilldown 

func (_options *PostSearchOptions) SetDrilldown(drilldown [][]string) *PostSearchOptions

SetDrilldown : Allow user to set Drilldown

func (*PostSearchOptions) SetGroupField 

func (_options *PostSearchOptions) SetGroupField(groupField string) *PostSearchOptions

SetGroupField : Allow user to set GroupField

func (*PostSearchOptions) SetGroupLimit 

func (_options *PostSearchOptions) SetGroupLimit(groupLimit int64) *PostSearchOptions

SetGroupLimit : Allow user to set GroupLimit

func (*PostSearchOptions) SetGroupSort 

func (_options *PostSearchOptions) SetGroupSort(groupSort []string) *PostSearchOptions

SetGroupSort : Allow user to set GroupSort

func (*PostSearchOptions) SetHeaders 

func (options *PostSearchOptions) SetHeaders(param map[string]string) *PostSearchOptions

SetHeaders : Allow user to set Headers

func (*PostSearchOptions) SetHighlightFields 

func (_options *PostSearchOptions) SetHighlightFields(highlightFields []string) *PostSearchOptions

SetHighlightFields : Allow user to set HighlightFields

func (*PostSearchOptions) SetHighlightNumber 

func (_options *PostSearchOptions) SetHighlightNumber(highlightNumber int64) *PostSearchOptions

SetHighlightNumber : Allow user to set HighlightNumber

func (*PostSearchOptions) SetHighlightPostTag 

func (_options *PostSearchOptions) SetHighlightPostTag(highlightPostTag string) *PostSearchOptions

SetHighlightPostTag : Allow user to set HighlightPostTag

func (*PostSearchOptions) SetHighlightPreTag 

func (_options *PostSearchOptions) SetHighlightPreTag(highlightPreTag string) *PostSearchOptions

SetHighlightPreTag : Allow user to set HighlightPreTag

func (*PostSearchOptions) SetHighlightSize 

func (_options *PostSearchOptions) SetHighlightSize(highlightSize int64) *PostSearchOptions

SetHighlightSize : Allow user to set HighlightSize

func (*PostSearchOptions) SetIncludeDocs 

func (_options *PostSearchOptions) SetIncludeDocs(includeDocs bool) *PostSearchOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostSearchOptions) SetIncludeFields 

func (_options *PostSearchOptions) SetIncludeFields(includeFields []string) *PostSearchOptions

SetIncludeFields : Allow user to set IncludeFields

func (*PostSearchOptions) SetIndex 

func (_options *PostSearchOptions) SetIndex(index string) *PostSearchOptions

SetIndex : Allow user to set Index

func (*PostSearchOptions) SetLimit 

func (_options *PostSearchOptions) SetLimit(limit int64) *PostSearchOptions

SetLimit : Allow user to set Limit

func (*PostSearchOptions) SetQuery 

func (_options *PostSearchOptions) SetQuery(query string) *PostSearchOptions

SetQuery : Allow user to set Query

func (*PostSearchOptions) SetRanges 

func (_options *PostSearchOptions) SetRanges(ranges map[string]map[string]map[string]string) *PostSearchOptions

SetRanges : Allow user to set Ranges

func (*PostSearchOptions) SetSort 

func (_options *PostSearchOptions) SetSort(sort []string) *PostSearchOptions

SetSort : Allow user to set Sort

func (*PostSearchOptions) SetStale 

func (_options *PostSearchOptions) SetStale(stale string) *PostSearchOptions

SetStale : Allow user to set Stale

type PostViewOptions 

type PostViewOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the map reduce view function name.
	View *string `json:"view" validate:"required,ne="`

	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for any JSON type.
	EndKey interface{} `json:"end_key,omitempty"`

	// Schema for a document ID.
	EndKeyDocID *string `json:"end_key_doc_id,omitempty"`

	// Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view.
	// If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of
	// array elements with the `group_level` parameter.
	Group *bool `json:"group,omitempty"`

	// Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies
	// group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results
	// are grouped by the entire array key, returning a reduced value for each complete key.
	GroupLevel *int64 `json:"group_level,omitempty"`

	// Schema for any JSON type.
	Key interface{} `json:"key,omitempty"`

	// Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match
	// the key type emitted by the view function.
	Keys []interface{} `json:"keys,omitempty"`

	// Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function
	// is defined.
	Reduce *bool `json:"reduce,omitempty"`

	// Query parameter to specify whether use the same replica of  the index on each request. The default value `false`
	// contacts all  replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in
	// conjunction with `update=false`  may improve consistency at the expense of increased latency and decreased
	// throughput if the selected replica is not the fastest of the available  replicas.
	//
	// **Note:** In general setting `true` is discouraged and is strictly not recommended when using `update=true`.
	Stable *bool `json:"stable,omitempty"`

	// Schema for any JSON type.
	StartKey interface{} `json:"start_key,omitempty"`

	// Schema for a document ID.
	StartKeyDocID *string `json:"start_key_doc_id,omitempty"`

	// Parameter to specify whether or not the view in question should be updated prior to responding to the user.
	//
	// * `true` - Return results after the view is updated.
	// * `false` - Return results without updating the view.
	// * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.
	Update *string `json:"update,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostViewOptions : The PostView options.

func (*PostViewOptions) SetAttEncodingInfo 

func (_options *PostViewOptions) SetAttEncodingInfo(attEncodingInfo bool) *PostViewOptions

SetAttEncodingInfo : Allow user to set AttEncodingInfo

func (*PostViewOptions) SetAttachments 

func (_options *PostViewOptions) SetAttachments(attachments bool) *PostViewOptions

SetAttachments : Allow user to set Attachments

func (*PostViewOptions) SetConflicts 

func (_options *PostViewOptions) SetConflicts(conflicts bool) *PostViewOptions

SetConflicts : Allow user to set Conflicts

func (*PostViewOptions) SetDb 

func (_options *PostViewOptions) SetDb(db string) *PostViewOptions

SetDb : Allow user to set Db

func (*PostViewOptions) SetDdoc 

func (_options *PostViewOptions) SetDdoc(ddoc string) *PostViewOptions

SetDdoc : Allow user to set Ddoc

func (*PostViewOptions) SetDescending 

func (_options *PostViewOptions) SetDescending(descending bool) *PostViewOptions

SetDescending : Allow user to set Descending

func (*PostViewOptions) SetEndKey added in v0.1.0 

func (_options *PostViewOptions) SetEndKey(endKey interface{}) *PostViewOptions

SetEndKey : Allow user to set EndKey

func (*PostViewOptions) SetEndKeyDocID added in v0.1.0 

func (_options *PostViewOptions) SetEndKeyDocID(endKeyDocID string) *PostViewOptions

SetEndKeyDocID : Allow user to set EndKeyDocID

func (*PostViewOptions) SetGroup 

func (_options *PostViewOptions) SetGroup(group bool) *PostViewOptions

SetGroup : Allow user to set Group

func (*PostViewOptions) SetGroupLevel 

func (_options *PostViewOptions) SetGroupLevel(groupLevel int64) *PostViewOptions

SetGroupLevel : Allow user to set GroupLevel

func (*PostViewOptions) SetHeaders 

func (options *PostViewOptions) SetHeaders(param map[string]string) *PostViewOptions

SetHeaders : Allow user to set Headers

func (*PostViewOptions) SetIncludeDocs 

func (_options *PostViewOptions) SetIncludeDocs(includeDocs bool) *PostViewOptions

SetIncludeDocs : Allow user to set IncludeDocs

func (*PostViewOptions) SetInclusiveEnd 

func (_options *PostViewOptions) SetInclusiveEnd(inclusiveEnd bool) *PostViewOptions

SetInclusiveEnd : Allow user to set InclusiveEnd

func (*PostViewOptions) SetKey 

func (_options *PostViewOptions) SetKey(key interface{}) *PostViewOptions

SetKey : Allow user to set Key

func (*PostViewOptions) SetKeys 

func (_options *PostViewOptions) SetKeys(keys []interface{}) *PostViewOptions

SetKeys : Allow user to set Keys

func (*PostViewOptions) SetLimit 

func (_options *PostViewOptions) SetLimit(limit int64) *PostViewOptions

SetLimit : Allow user to set Limit

func (*PostViewOptions) SetReduce 

func (_options *PostViewOptions) SetReduce(reduce bool) *PostViewOptions

SetReduce : Allow user to set Reduce

func (*PostViewOptions) SetSkip 

func (_options *PostViewOptions) SetSkip(skip int64) *PostViewOptions

SetSkip : Allow user to set Skip

func (*PostViewOptions) SetStable 

func (_options *PostViewOptions) SetStable(stable bool) *PostViewOptions

SetStable : Allow user to set Stable

func (*PostViewOptions) SetStartKey added in v0.1.0 

func (_options *PostViewOptions) SetStartKey(startKey interface{}) *PostViewOptions

SetStartKey : Allow user to set StartKey

func (*PostViewOptions) SetStartKeyDocID added in v0.1.0 

func (_options *PostViewOptions) SetStartKeyDocID(startKeyDocID string) *PostViewOptions

SetStartKeyDocID : Allow user to set StartKeyDocID

func (*PostViewOptions) SetUpdate 

func (_options *PostViewOptions) SetUpdate(update string) *PostViewOptions

SetUpdate : Allow user to set Update

func (*PostViewOptions) SetUpdateSeq 

func (_options *PostViewOptions) SetUpdateSeq(updateSeq bool) *PostViewOptions

SetUpdateSeq : Allow user to set UpdateSeq

func (*PostViewOptions) SetView 

func (_options *PostViewOptions) SetView(view string) *PostViewOptions

SetView : Allow user to set View

type PostViewQueriesOptions 

type PostViewQueriesOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// Path parameter to specify the map reduce view function name.
	View *string `json:"view" validate:"required,ne="`

	// An array of query objects with fields for the parameters of each individual view query to be executed. The field
	// names and their meaning are the same as the query parameters of a regular view request.
	Queries []ViewQuery `json:"queries" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostViewQueriesOptions : The PostViewQueries options.

func (*PostViewQueriesOptions) SetDb 

func (_options *PostViewQueriesOptions) SetDb(db string) *PostViewQueriesOptions

SetDb : Allow user to set Db

func (*PostViewQueriesOptions) SetDdoc 

func (_options *PostViewQueriesOptions) SetDdoc(ddoc string) *PostViewQueriesOptions

SetDdoc : Allow user to set Ddoc

func (*PostViewQueriesOptions) SetHeaders 

func (options *PostViewQueriesOptions) SetHeaders(param map[string]string) *PostViewQueriesOptions

SetHeaders : Allow user to set Headers

func (*PostViewQueriesOptions) SetQueries 

func (_options *PostViewQueriesOptions) SetQueries(queries []ViewQuery) *PostViewQueriesOptions

SetQueries : Allow user to set Queries

func (*PostViewQueriesOptions) SetView 

func (_options *PostViewQueriesOptions) SetView(view string) *PostViewQueriesOptions

SetView : Allow user to set View

type PutAttachmentOptions 

type PutAttachmentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// Path parameter to specify the attachment name.
	AttachmentName *string `json:"attachment_name" validate:"required,ne="`

	// HTTP request body for attachment operations.
	Attachment io.ReadCloser `json:"attachment" validate:"required"`

	// Content-Type of the attachment.
	ContentType *string `json:"Content-Type" validate:"required"`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutAttachmentOptions : The PutAttachment options.

func (*PutAttachmentOptions) SetAttachment 

func (_options *PutAttachmentOptions) SetAttachment(attachment io.ReadCloser) *PutAttachmentOptions

SetAttachment : Allow user to set Attachment

func (*PutAttachmentOptions) SetAttachmentName 

func (_options *PutAttachmentOptions) SetAttachmentName(attachmentName string) *PutAttachmentOptions

SetAttachmentName : Allow user to set AttachmentName

func (*PutAttachmentOptions) SetContentType 

func (_options *PutAttachmentOptions) SetContentType(contentType string) *PutAttachmentOptions

SetContentType : Allow user to set ContentType

func (*PutAttachmentOptions) SetDb 

func (_options *PutAttachmentOptions) SetDb(db string) *PutAttachmentOptions

SetDb : Allow user to set Db

func (*PutAttachmentOptions) SetDocID 

func (_options *PutAttachmentOptions) SetDocID(docID string) *PutAttachmentOptions

SetDocID : Allow user to set DocID

func (*PutAttachmentOptions) SetHeaders 

func (options *PutAttachmentOptions) SetHeaders(param map[string]string) *PutAttachmentOptions

SetHeaders : Allow user to set Headers

func (*PutAttachmentOptions) SetIfMatch 

func (_options *PutAttachmentOptions) SetIfMatch(ifMatch string) *PutAttachmentOptions

SetIfMatch : Allow user to set IfMatch

func (*PutAttachmentOptions) SetRev 

func (_options *PutAttachmentOptions) SetRev(rev string) *PutAttachmentOptions

SetRev : Allow user to set Rev

type PutCapacityThroughputConfigurationOptions added in v0.0.32 

type PutCapacityThroughputConfigurationOptions struct {
	// A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec
	// of provisioned throughput capacity.
	Blocks *int64 `json:"blocks" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutCapacityThroughputConfigurationOptions : The PutCapacityThroughputConfiguration options.

func (*PutCapacityThroughputConfigurationOptions) SetBlocks added in v0.0.32 

func (_options *PutCapacityThroughputConfigurationOptions) SetBlocks(blocks int64) *PutCapacityThroughputConfigurationOptions

SetBlocks : Allow user to set Blocks

func (*PutCapacityThroughputConfigurationOptions) SetHeaders added in v0.0.32 

func (options *PutCapacityThroughputConfigurationOptions) SetHeaders(param map[string]string) *PutCapacityThroughputConfigurationOptions

SetHeaders : Allow user to set Headers

type PutCloudantSecurityConfigurationOptions added in v0.0.24 

type PutCloudantSecurityConfigurationOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Database permissions for Cloudant users and/or API keys.
	Cloudant map[string][]string `json:"cloudant" validate:"required"`

	// Schema for names and roles to map to a database permission.
	Admins *SecurityObject `json:"admins,omitempty"`

	// Schema for names and roles to map to a database permission.
	Members *SecurityObject `json:"members,omitempty"`

	// Manage permissions using the `_users` database only.
	CouchdbAuthOnly *bool `json:"couchdb_auth_only,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutCloudantSecurityConfigurationOptions : The PutCloudantSecurityConfiguration options.

func (*PutCloudantSecurityConfigurationOptions) SetAdmins added in v0.0.24 

func (_options *PutCloudantSecurityConfigurationOptions) SetAdmins(admins *SecurityObject) *PutCloudantSecurityConfigurationOptions

SetAdmins : Allow user to set Admins

func (*PutCloudantSecurityConfigurationOptions) SetCloudant added in v0.0.24 

func (_options *PutCloudantSecurityConfigurationOptions) SetCloudant(cloudant map[string][]string) *PutCloudantSecurityConfigurationOptions

SetCloudant : Allow user to set Cloudant

func (*PutCloudantSecurityConfigurationOptions) SetCouchdbAuthOnly added in v0.0.24 

func (_options *PutCloudantSecurityConfigurationOptions) SetCouchdbAuthOnly(couchdbAuthOnly bool) *PutCloudantSecurityConfigurationOptions

SetCouchdbAuthOnly : Allow user to set CouchdbAuthOnly

func (*PutCloudantSecurityConfigurationOptions) SetDb added in v0.0.24 

func (_options *PutCloudantSecurityConfigurationOptions) SetDb(db string) *PutCloudantSecurityConfigurationOptions

SetDb : Allow user to set Db

func (*PutCloudantSecurityConfigurationOptions) SetHeaders added in v0.0.24 

func (options *PutCloudantSecurityConfigurationOptions) SetHeaders(param map[string]string) *PutCloudantSecurityConfigurationOptions

SetHeaders : Allow user to set Headers

func (*PutCloudantSecurityConfigurationOptions) SetMembers added in v0.0.24 

func (_options *PutCloudantSecurityConfigurationOptions) SetMembers(members *SecurityObject) *PutCloudantSecurityConfigurationOptions

SetMembers : Allow user to set Members

type PutCorsConfigurationOptions 

type PutCorsConfigurationOptions struct {
	// An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It
	// is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify
	// all subdomains used.
	Origins []string `json:"origins" validate:"required"`

	// Boolean value to allow authentication credentials. If set to true, browser requests must be done by using
	// withCredentials = true.
	AllowCredentials *bool `json:"allow_credentials,omitempty"`

	// Boolean value to turn CORS on and off.
	EnableCors *bool `json:"enable_cors,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutCorsConfigurationOptions : The PutCorsConfiguration options.

func (*PutCorsConfigurationOptions) SetAllowCredentials 

func (_options *PutCorsConfigurationOptions) SetAllowCredentials(allowCredentials bool) *PutCorsConfigurationOptions

SetAllowCredentials : Allow user to set AllowCredentials

func (*PutCorsConfigurationOptions) SetEnableCors 

func (_options *PutCorsConfigurationOptions) SetEnableCors(enableCors bool) *PutCorsConfigurationOptions

SetEnableCors : Allow user to set EnableCors

func (*PutCorsConfigurationOptions) SetHeaders 

func (options *PutCorsConfigurationOptions) SetHeaders(param map[string]string) *PutCorsConfigurationOptions

SetHeaders : Allow user to set Headers

func (*PutCorsConfigurationOptions) SetOrigins 

func (_options *PutCorsConfigurationOptions) SetOrigins(origins []string) *PutCorsConfigurationOptions

SetOrigins : Allow user to set Origins

type PutDatabaseOptions 

type PutDatabaseOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Query parameter to specify whether to enable database partitions when creating a database.
	Partitioned *bool `json:"partitioned,omitempty"`

	// The number of shards in the database. Each shard is a partition of the hash value range. Cloudant recommends using
	// the default value for most databases. However, if your database is expected to be larger than 250 GB or have a lot
	// of indexes, you may need to adjust the settings. In these cases, it's best to reach out to IBM Cloudant customer
	// support for guidance on how to meet your specific needs and requirements.
	Q *int64 `json:"q,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutDatabaseOptions : The PutDatabase options.

func (*PutDatabaseOptions) SetDb 

func (_options *PutDatabaseOptions) SetDb(db string) *PutDatabaseOptions

SetDb : Allow user to set Db

func (*PutDatabaseOptions) SetHeaders 

func (options *PutDatabaseOptions) SetHeaders(param map[string]string) *PutDatabaseOptions

SetHeaders : Allow user to set Headers

func (*PutDatabaseOptions) SetPartitioned 

func (_options *PutDatabaseOptions) SetPartitioned(partitioned bool) *PutDatabaseOptions

SetPartitioned : Allow user to set Partitioned

func (*PutDatabaseOptions) SetQ 

func (_options *PutDatabaseOptions) SetQ(q int64) *PutDatabaseOptions

SetQ : Allow user to set Q

type PutDesignDocumentOptions 

type PutDesignDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the design document name. The design document name is the design document ID excluding the
	// `_design/` prefix.
	Ddoc *string `json:"ddoc" validate:"required,ne="`

	// HTTP request body for DesignDocument operations.
	DesignDocument *DesignDocument `json:"designDocument" validate:"required"`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed
	// _rev must be included in the document. False is used by the replicator to insert documents into the target database
	// even if that leads to the creation of conflicts.
	NewEdits *bool `json:"new_edits,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutDesignDocumentOptions : The PutDesignDocument options.

func (*PutDesignDocumentOptions) SetBatch 

func (_options *PutDesignDocumentOptions) SetBatch(batch string) *PutDesignDocumentOptions

SetBatch : Allow user to set Batch

func (*PutDesignDocumentOptions) SetDb 

func (_options *PutDesignDocumentOptions) SetDb(db string) *PutDesignDocumentOptions

SetDb : Allow user to set Db

func (*PutDesignDocumentOptions) SetDdoc 

func (_options *PutDesignDocumentOptions) SetDdoc(ddoc string) *PutDesignDocumentOptions

SetDdoc : Allow user to set Ddoc

func (*PutDesignDocumentOptions) SetDesignDocument 

func (_options *PutDesignDocumentOptions) SetDesignDocument(designDocument *DesignDocument) *PutDesignDocumentOptions

SetDesignDocument : Allow user to set DesignDocument

func (*PutDesignDocumentOptions) SetHeaders 

func (options *PutDesignDocumentOptions) SetHeaders(param map[string]string) *PutDesignDocumentOptions

SetHeaders : Allow user to set Headers

func (*PutDesignDocumentOptions) SetIfMatch 

func (_options *PutDesignDocumentOptions) SetIfMatch(ifMatch string) *PutDesignDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*PutDesignDocumentOptions) SetNewEdits 

func (_options *PutDesignDocumentOptions) SetNewEdits(newEdits bool) *PutDesignDocumentOptions

SetNewEdits : Allow user to set NewEdits

func (*PutDesignDocumentOptions) SetRev 

func (_options *PutDesignDocumentOptions) SetRev(rev string) *PutDesignDocumentOptions

SetRev : Allow user to set Rev

type PutDocumentOptions 

type PutDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// HTTP request body for Document operations.
	Document *Document `json:"document,omitempty"`

	// HTTP request body for Document operations.
	Body io.ReadCloser `json:"body,omitempty"`

	// The type of the input.
	ContentType *string `json:"Content-Type,omitempty"`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed
	// _rev must be included in the document. False is used by the replicator to insert documents into the target database
	// even if that leads to the creation of conflicts.
	NewEdits *bool `json:"new_edits,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutDocumentOptions : The PutDocument options.

func (*PutDocumentOptions) SetBatch 

func (_options *PutDocumentOptions) SetBatch(batch string) *PutDocumentOptions

SetBatch : Allow user to set Batch

func (*PutDocumentOptions) SetBody 

func (_options *PutDocumentOptions) SetBody(body io.ReadCloser) *PutDocumentOptions

SetBody : Allow user to set Body

func (*PutDocumentOptions) SetContentType 

func (_options *PutDocumentOptions) SetContentType(contentType string) *PutDocumentOptions

SetContentType : Allow user to set ContentType

func (*PutDocumentOptions) SetDb 

func (_options *PutDocumentOptions) SetDb(db string) *PutDocumentOptions

SetDb : Allow user to set Db

func (*PutDocumentOptions) SetDocID 

func (_options *PutDocumentOptions) SetDocID(docID string) *PutDocumentOptions

SetDocID : Allow user to set DocID

func (*PutDocumentOptions) SetDocument 

func (_options *PutDocumentOptions) SetDocument(document *Document) *PutDocumentOptions

SetDocument : Allow user to set Document

func (*PutDocumentOptions) SetHeaders 

func (options *PutDocumentOptions) SetHeaders(param map[string]string) *PutDocumentOptions

SetHeaders : Allow user to set Headers

func (*PutDocumentOptions) SetIfMatch 

func (_options *PutDocumentOptions) SetIfMatch(ifMatch string) *PutDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*PutDocumentOptions) SetNewEdits 

func (_options *PutDocumentOptions) SetNewEdits(newEdits bool) *PutDocumentOptions

SetNewEdits : Allow user to set NewEdits

func (*PutDocumentOptions) SetRev 

func (_options *PutDocumentOptions) SetRev(rev string) *PutDocumentOptions

SetRev : Allow user to set Rev

type PutLocalDocumentOptions 

type PutLocalDocumentOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// HTTP request body for Document operations.
	Document *Document `json:"document,omitempty"`

	// HTTP request body for Document operations.
	Body io.ReadCloser `json:"body,omitempty"`

	// The type of the input.
	ContentType *string `json:"Content-Type,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutLocalDocumentOptions : The PutLocalDocument options.

func (*PutLocalDocumentOptions) SetBatch 

func (_options *PutLocalDocumentOptions) SetBatch(batch string) *PutLocalDocumentOptions

SetBatch : Allow user to set Batch

func (*PutLocalDocumentOptions) SetBody 

func (_options *PutLocalDocumentOptions) SetBody(body io.ReadCloser) *PutLocalDocumentOptions

SetBody : Allow user to set Body

func (*PutLocalDocumentOptions) SetContentType 

func (_options *PutLocalDocumentOptions) SetContentType(contentType string) *PutLocalDocumentOptions

SetContentType : Allow user to set ContentType

func (*PutLocalDocumentOptions) SetDb 

func (_options *PutLocalDocumentOptions) SetDb(db string) *PutLocalDocumentOptions

SetDb : Allow user to set Db

func (*PutLocalDocumentOptions) SetDocID 

func (_options *PutLocalDocumentOptions) SetDocID(docID string) *PutLocalDocumentOptions

SetDocID : Allow user to set DocID

func (*PutLocalDocumentOptions) SetDocument 

func (_options *PutLocalDocumentOptions) SetDocument(document *Document) *PutLocalDocumentOptions

SetDocument : Allow user to set Document

func (*PutLocalDocumentOptions) SetHeaders 

func (options *PutLocalDocumentOptions) SetHeaders(param map[string]string) *PutLocalDocumentOptions

SetHeaders : Allow user to set Headers

type PutReplicationDocumentOptions 

type PutReplicationDocumentOptions struct {
	// Path parameter to specify the document ID.
	DocID *string `json:"doc_id" validate:"required,ne="`

	// HTTP request body for replication operations.
	ReplicationDocument *ReplicationDocument `json:"replicationDocument" validate:"required"`

	// Header parameter to specify the document revision. Alternative to rev query parameter.
	IfMatch *string `json:"If-Match,omitempty"`

	// Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response
	// code immediately.
	Batch *string `json:"batch,omitempty"`

	// Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed
	// _rev must be included in the document. False is used by the replicator to insert documents into the target database
	// even if that leads to the creation of conflicts.
	NewEdits *bool `json:"new_edits,omitempty"`

	// Query parameter to specify a document revision.
	Rev *string `json:"rev,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutReplicationDocumentOptions : The PutReplicationDocument options.

func (*PutReplicationDocumentOptions) SetBatch 

func (_options *PutReplicationDocumentOptions) SetBatch(batch string) *PutReplicationDocumentOptions

SetBatch : Allow user to set Batch

func (*PutReplicationDocumentOptions) SetDocID 

func (_options *PutReplicationDocumentOptions) SetDocID(docID string) *PutReplicationDocumentOptions

SetDocID : Allow user to set DocID

func (*PutReplicationDocumentOptions) SetHeaders 

func (options *PutReplicationDocumentOptions) SetHeaders(param map[string]string) *PutReplicationDocumentOptions

SetHeaders : Allow user to set Headers

func (*PutReplicationDocumentOptions) SetIfMatch 

func (_options *PutReplicationDocumentOptions) SetIfMatch(ifMatch string) *PutReplicationDocumentOptions

SetIfMatch : Allow user to set IfMatch

func (*PutReplicationDocumentOptions) SetNewEdits 

func (_options *PutReplicationDocumentOptions) SetNewEdits(newEdits bool) *PutReplicationDocumentOptions

SetNewEdits : Allow user to set NewEdits

func (*PutReplicationDocumentOptions) SetReplicationDocument 

func (_options *PutReplicationDocumentOptions) SetReplicationDocument(replicationDocument *ReplicationDocument) *PutReplicationDocumentOptions

SetReplicationDocument : Allow user to set ReplicationDocument

func (*PutReplicationDocumentOptions) SetRev 

func (_options *PutReplicationDocumentOptions) SetRev(rev string) *PutReplicationDocumentOptions

SetRev : Allow user to set Rev

type PutSecurityOptions 

type PutSecurityOptions struct {
	// Path parameter to specify the database name.
	Db *string `json:"db" validate:"required,ne="`

	// Schema for names and roles to map to a database permission.
	Admins *SecurityObject `json:"admins,omitempty"`

	// Schema for names and roles to map to a database permission.
	Members *SecurityObject `json:"members,omitempty"`

	// Database permissions for Cloudant users and/or API keys.
	Cloudant map[string][]string `json:"cloudant,omitempty"`

	// Manage permissions using the `_users` database only.
	CouchdbAuthOnly *bool `json:"couchdb_auth_only,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutSecurityOptions : The PutSecurity options.

func (*PutSecurityOptions) SetAdmins 

func (_options *PutSecurityOptions) SetAdmins(admins *SecurityObject) *PutSecurityOptions

SetAdmins : Allow user to set Admins

func (*PutSecurityOptions) SetCloudant 

func (_options *PutSecurityOptions) SetCloudant(cloudant map[string][]string) *PutSecurityOptions

SetCloudant : Allow user to set Cloudant

func (*PutSecurityOptions) SetCouchdbAuthOnly 

func (_options *PutSecurityOptions) SetCouchdbAuthOnly(couchdbAuthOnly bool) *PutSecurityOptions

SetCouchdbAuthOnly : Allow user to set CouchdbAuthOnly

func (*PutSecurityOptions) SetDb 

func (_options *PutSecurityOptions) SetDb(db string) *PutSecurityOptions

SetDb : Allow user to set Db

func (*PutSecurityOptions) SetHeaders 

func (options *PutSecurityOptions) SetHeaders(param map[string]string) *PutSecurityOptions

SetHeaders : Allow user to set Headers

func (*PutSecurityOptions) SetMembers 

func (_options *PutSecurityOptions) SetMembers(members *SecurityObject) *PutSecurityOptions

SetMembers : Allow user to set Members

type ReplicationCreateTargetParameters 

type ReplicationCreateTargetParameters struct {
	// Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it cannot
	// be changed by the user.
	N *int64 `json:"n,omitempty"`

	// Parameter to specify whether to enable database partitions when creating the target database.
	Partitioned *bool `json:"partitioned,omitempty"`

	// Schema for the number of shards in a database. Each shard is a partition of the hash value range.
	Q *int64 `json:"q,omitempty"`
}

ReplicationCreateTargetParameters : Request parameters to use during target database creation.

type ReplicationDatabase 

type ReplicationDatabase struct {
	// Schema for replication source or target database authentication.
	Auth *ReplicationDatabaseAuth `json:"auth,omitempty"`

	// Replication request headers.
	HeadersVar map[string]string `json:"headers,omitempty"`

	// Replication database URL.
	URL *string `json:"url" validate:"required"`
}

ReplicationDatabase : Schema for a replication source or target database.

type ReplicationDatabaseAuth 

type ReplicationDatabaseAuth struct {
	// Schema for basic authentication of replication source or target database.
	Basic *ReplicationDatabaseAuthBasic `json:"basic,omitempty"`

	// Schema for an IAM API key for replication database authentication.
	Iam *ReplicationDatabaseAuthIam `json:"iam,omitempty"`
}

ReplicationDatabaseAuth : Schema for replication source or target database authentication.

type ReplicationDatabaseAuthBasic added in v0.0.38 

type ReplicationDatabaseAuthBasic struct {
	// The password associated with the username.
	Password *string `json:"password" validate:"required"`

	// The username.
	Username *string `json:"username" validate:"required"`
}

ReplicationDatabaseAuthBasic : Schema for basic authentication of replication source or target database.

type ReplicationDatabaseAuthIam 

type ReplicationDatabaseAuthIam struct {
	// IAM API key.
	ApiKey *string `json:"api_key" validate:"required"`
}

ReplicationDatabaseAuthIam : Schema for an IAM API key for replication database authentication.

type ReplicationDocument 

type ReplicationDocument struct {
	// Schema for a map of attachment name to attachment metadata.
	Attachments map[string]Attachment `json:"_attachments,omitempty"`

	// Schema for a list of document revision identifiers.
	Conflicts []string `json:"_conflicts,omitempty"`

	// Deletion flag. Available if document was removed.
	Deleted *bool `json:"_deleted,omitempty"`

	// Schema for a list of document revision identifiers.
	DeletedConflicts []string `json:"_deleted_conflicts,omitempty"`

	// Document ID.
	ID *string `json:"_id,omitempty"`

	// Document's update sequence in current database. Available if requested with local_seq=true query parameter.
	LocalSeq *string `json:"_local_seq,omitempty"`

	// Schema for a document revision identifier.
	Rev *string `json:"_rev,omitempty"`

	// Schema for list of revision information.
	Revisions *Revisions `json:"_revisions,omitempty"`

	// Schema for a list of objects with information about local revisions and their status.
	RevsInfo []DocumentRevisionStatus `json:"_revs_info,omitempty"`

	// Cancels the replication.
	Cancel *bool `json:"cancel,omitempty"`

	// Defines replication checkpoint interval in milliseconds.
	CheckpointInterval *int64 `json:"checkpoint_interval,omitempty"`

	// HTTP connection timeout per replication. Even for very fast/reliable networks it might need to be increased if a
	// remote database is too busy.
	ConnectionTimeout *int64 `json:"connection_timeout,omitempty"`

	// Configure the replication to be continuous.
	Continuous *bool `json:"continuous,omitempty"`

	// Creates the target database. Requires administrator privileges on target server.
	CreateTarget *bool `json:"create_target,omitempty"`

	// Request parameters to use during target database creation.
	CreateTargetParams *ReplicationCreateTargetParameters `json:"create_target_params,omitempty"`

	// Schema for a list of document IDs.
	DocIds []string `json:"doc_ids,omitempty"`

	// The name of a filter function which is defined in a design document in the source database in {ddoc_id}/{filter}
	// format. It determines which documents get replicated. Using the selector option provides performance benefits when
	// compared with using the filter option. Use the selector option when possible.
	Filter *string `json:"filter,omitempty"`

	// Maximum number of HTTP connections per replication.
	HTTPConnections *int64 `json:"http_connections,omitempty"`

	// Schema for a map of string key value pairs, such as query parameters.
	QueryParams map[string]string `json:"query_params,omitempty"`

	// Number of times a replication request is retried. The requests are retried with a doubling exponential backoff
	// starting at 0.25 seconds, with a cap at 5 minutes.
	RetriesPerRequest *int64 `json:"retries_per_request,omitempty"`

	// JSON object describing criteria used to select documents. The selector specifies fields in the document, and
	// provides an expression to evaluate with the field content or other data.
	//
	// The selector object must:
	//   * Be structured as valid JSON.
	//   * Contain a valid query expression.
	//
	// Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended
	// option if filtering on document attributes only.
	//
	// Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for
	// those fields. You can create more complex selector expressions by combining operators.
	//
	// Operators are identified by the use of a dollar sign `$` prefix in the name field.
	//
	// There are two core types of operators in the selector syntax:
	// * Combination operators: applied at the topmost level of selection. They are used to combine selectors. A
	// combination operator takes a single argument. The argument is either another selector, or an array of selectors.
	// * Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For
	// instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied
	// argument. See [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators) for a list of all
	// available combination and conditional operators.
	// * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis
	// of a query. You should include at least one of these in a selector.
	//
	// For further reference see
	// [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax).
	Selector map[string]interface{} `json:"selector,omitempty"`

	// Start the replication at a specific sequence value.
	SinceSeq *string `json:"since_seq,omitempty"`

	// Replication socket options.
	SocketOptions *string `json:"socket_options,omitempty"`

	// Schema for a replication source or target database.
	Source *ReplicationDatabase `json:"source" validate:"required"`

	// This setting is forbidden in IBM Cloudant replication documents. This setting may be used with alternative
	// replication mediators.
	//
	// Address of a (http or socks5 protocol) proxy server through which replication with the source database should occur.
	// Deprecated: this field is deprecated and may be removed in a future release.
	SourceProxy *string `json:"source_proxy,omitempty"`

	// Schema for a replication source or target database.
	Target *ReplicationDatabase `json:"target" validate:"required"`

	// This setting is forbidden in IBM Cloudant replication documents. This setting may be used with alternative
	// replication mediators.
	//
	// Address of a (http or socks5 protocol) proxy server through which replication with the target database should occur.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TargetProxy *string `json:"target_proxy,omitempty"`

	// Specify whether to use _bulk_get for fetching documents from the source. If unset, the server configured default
	// will be used.
	UseBulkGet *bool `json:"use_bulk_get,omitempty"`

	// Specify if checkpoints should be saved during replication. Using checkpoints means a replication can be efficiently
	// resumed.
	UseCheckpoints *bool `json:"use_checkpoints,omitempty"`

	// Schema for the user context of a session.
	UserCtx *UserContext `json:"user_ctx,omitempty"`

	// Replicate only the winning revisions. Replication with this mode discards conflicting revisions. Replication IDs and
	// checkpoints generated by this mode are different to those generated by default, so it is possible to first replicate
	// the winning revisions then later backfill remaining revisions with a regular replication job.
	WinningRevsOnly *bool `json:"winning_revs_only,omitempty"`

	// Controls how many documents are processed. After each batch a checkpoint is written so this controls how frequently
	// checkpointing occurs.
	WorkerBatchSize *int64 `json:"worker_batch_size,omitempty"`

	// Controls how many separate processes will read from the changes manager and write to the target. A higher number can
	// improve throughput.
	WorkerProcesses *int64 `json:"worker_processes,omitempty"`
	// contains filtered or unexported fields
}

ReplicationDocument : Schema for a replication document. Note that `selector`, `doc_ids`, and `filter` are incompatible with each other.

func (*ReplicationDocument) GetProperties 

func (o *ReplicationDocument) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ReplicationDocument

func (*ReplicationDocument) GetProperty 

func (o *ReplicationDocument) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ReplicationDocument

func (*ReplicationDocument) MarshalJSON 

func (o *ReplicationDocument) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ReplicationDocument

func (*ReplicationDocument) SetProperties added in v0.0.37 

func (o *ReplicationDocument) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ReplicationDocument

func (*ReplicationDocument) SetProperty 

func (o *ReplicationDocument) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ReplicationDocument

type Revisions 

type Revisions struct {
	// Array of valid revision IDs, in reverse order (latest first).
	Ids []string `json:"ids" validate:"required"`

	// Prefix number for the latest revision.
	Start *int64 `json:"start" validate:"required"`
}

Revisions : Schema for list of revision information.

type RevsDiff 

type RevsDiff struct {
	// List of missing revisions.
	Missing []string `json:"missing,omitempty"`

	// List of possible ancestor revisions.
	PossibleAncestors []string `json:"possible_ancestors,omitempty"`
}

RevsDiff : Schema for information about missing revs and possible ancestors.

type SchedulerDocsResult 

type SchedulerDocsResult struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// Array of replication scheduler doc objects.
	Docs []SchedulerDocument `json:"docs" validate:"required"`
}

SchedulerDocsResult : Schema for a listing of replication scheduler documents.

type SchedulerDocument 

type SchedulerDocument struct {
	// Database where replication document came from.
	Database *string `json:"database" validate:"required"`

	// Replication document ID.
	DocID *string `json:"doc_id" validate:"required"`

	// Consecutive errors count. Indicates how many times in a row this replication has crashed. Replication will be
	// retried with an exponential backoff based on this number. As soon as the replication succeeds this count is reset to
	// 0. To can be used to get an idea why a particular replication is not making progress.
	ErrorCount *int64 `json:"error_count" validate:"required"`

	// Replication ID, or null if state is completed or failed.
	ID *string `json:"id" validate:"required"`

	// Schema for scheduler document information. A JSON object that may contain additional information about the state.
	// For error states this will contain an error field and string value.
	Info *SchedulerInfo `json:"info" validate:"required"`

	// Timestamp of last state update.
	LastUpdated *strfmt.DateTime `json:"last_updated" validate:"required"`

	// Cluster node where the job is running.
	Node *string `json:"node,omitempty"`

	// Replication source.
	Source *string `json:"source,omitempty"`

	// Forbidden in IBM Cloudant mediated replications.
	//
	// Address of the (http or socks5 protocol) proxy server through which replication with the source database occurs.
	// Deprecated: this field is deprecated and may be removed in a future release.
	SourceProxy *string `json:"source_proxy,omitempty"`

	// Timestamp of when the replication was started.
	StartTime *strfmt.DateTime `json:"start_time" validate:"required"`

	// Schema for replication state.
	State *string `json:"state" validate:"required"`

	// Replication target.
	Target *string `json:"target,omitempty"`

	// Forbidden in IBM Cloudant mediated replications.
	//
	// Address of the (http or socks5 protocol) proxy server through which replication with the target database occurs.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TargetProxy *string `json:"target_proxy,omitempty"`
}

SchedulerDocument : Schema for a replication scheduler document.

type SchedulerInfo 

type SchedulerInfo struct {
	// The count of changes not yet replicated.
	ChangesPending *int64 `json:"changes_pending,omitempty"`

	// The source sequence id which was last successfully replicated.
	CheckpointedSourceSeq *string `json:"checkpointed_source_seq,omitempty"`

	// The count of docs which failed to be written to the target.
	DocWriteFailures *int64 `json:"doc_write_failures,omitempty"`

	// The count of docs which have been read from the source.
	DocsRead *int64 `json:"docs_read,omitempty"`

	// The count of docs which have been written to the target.
	DocsWritten *int64 `json:"docs_written,omitempty"`

	// Replication error message.
	Error *string `json:"error,omitempty"`

	// The count of revisions which were found on the source, but missing from the target.
	MissingRevisionsFound *int64 `json:"missing_revisions_found,omitempty"`

	// The count of revisions which have been checked since this replication began.
	RevisionsChecked *int64 `json:"revisions_checked,omitempty"`

	// The last sequence number obtained from the source database changes feed.
	SourceSeq *string `json:"source_seq,omitempty"`

	// The last sequence number processed by the replicator.
	ThroughSeq *string `json:"through_seq,omitempty"`
}

SchedulerInfo : Schema for scheduler document information. A JSON object that may contain additional information about the state. For error states this will contain an error field and string value.

type SchedulerJob 

type SchedulerJob struct {
	// Replication document database.
	Database *string `json:"database" validate:"required"`

	// Replication document ID.
	DocID *string `json:"doc_id" validate:"required"`

	// Timestamped history of events as a list of objects.
	History []SchedulerJobEvent `json:"history" validate:"required"`

	// Schema for a replication job id.
	ID *string `json:"id" validate:"required"`

	// Schema for scheduler document information. A JSON object that may contain additional information about the state.
	// For error states this will contain an error field and string value.
	Info *SchedulerInfo `json:"info" validate:"required"`

	// Cluster node where the job is running.
	Node *string `json:"node" validate:"required"`

	// Replication process ID.
	Pid *string `json:"pid" validate:"required"`

	// Replication source.
	Source *string `json:"source" validate:"required"`

	// Timestamp of when the replication was started.
	StartTime *strfmt.DateTime `json:"start_time" validate:"required"`

	// Replication target.
	Target *string `json:"target" validate:"required"`

	// Name of user running replication.
	User *string `json:"user" validate:"required"`
}

SchedulerJob : Schema for a replication scheduler job.

type SchedulerJobEvent 

type SchedulerJobEvent struct {
	// Reason for current state of event.
	Reason *string `json:"reason,omitempty"`

	// Timestamp of the event.
	Timestamp *strfmt.DateTime `json:"timestamp" validate:"required"`

	// Type of the event.
	Type *string `json:"type" validate:"required"`
}

SchedulerJobEvent : Schema for a replication scheduler job event.

type SchedulerJobsResult 

type SchedulerJobsResult struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// Array of replication job objects.
	Jobs []SchedulerJob `json:"jobs" validate:"required"`
}

SchedulerJobsResult : Schema for a listing of replication scheduler jobs.

type SearchAnalyzeResult 

type SearchAnalyzeResult struct {
	// tokens.
	Tokens []string `json:"tokens" validate:"required"`
}

SearchAnalyzeResult : Schema for the output of testing search analyzer tokenization.

type SearchIndexDefinition 

type SearchIndexDefinition struct {
	// Schema for a search analyzer configuration.
	Analyzer *AnalyzerConfiguration `json:"analyzer,omitempty"`

	// String form of a JavaScript function that is called for each document in the database. The function takes the
	// document as a parameter, extracts some data from it, and then calls the `index` function to index that data. The
	// index function takes 2, or optionally 3, parameters.
	//
	// * The first parameter is the name of the field you intend to use when
	//   querying the index. If the special value `"default"` is used when you
	//   define the name, you do not have to specify a field name at query time.
	// * The second parameter is the data to be indexed. This data must be only a
	//   string, number, or boolean. Other types will cause an error to be thrown
	//   by the index function call.
	// * The optional third parameter is a JavaScript object with these
	//   properties:
	//
	//     * `facet` - boolean, default `false` - Creates a faceted index.
	//     * `index` - boolean, default `true` - If set to `false`, the data
	//       cannot be used for searches, but can still be retrieved from the
	//       index if `store` is set to `true`.
	//     * `store` - boolean, default `true` - If true, the value is returned
	//       in the search result; otherwise, the value is not returned.
	Index *string `json:"index" validate:"required"`
}

SearchIndexDefinition : Schema for a search index definition.

type SearchIndexInfo 

type SearchIndexInfo struct {
	// The committed sequence identifier.
	CommittedSeq *int64 `json:"committed_seq" validate:"required"`

	// The size of the search index on disk.
	DiskSize *int64 `json:"disk_size" validate:"required"`

	// The count of the number of indexed documents.
	DocCount *int64 `json:"doc_count" validate:"required"`

	// The number of deleted documents.
	DocDelCount *int64 `json:"doc_del_count" validate:"required"`

	// The pending sequence identifier.
	PendingSeq *int64 `json:"pending_seq" validate:"required"`

	// Unique signature of the search index.
	Signature *string `json:"signature" validate:"required"`
}

SearchIndexInfo : Schema for metadata information about a search index.

type SearchInfoResult 

type SearchInfoResult struct {
	// The name of the search index prefixed by the design document ID where the index is stored.
	Name *string `json:"name" validate:"required"`

	// Schema for metadata information about a search index.
	SearchIndex *SearchIndexInfo `json:"search_index" validate:"required"`
}

SearchInfoResult : Schema for search index information.

type SearchResult 

type SearchResult struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// Grouped search matches.
	By *string `json:"by,omitempty"`

	// The counts facet syntax returns the number of query results for each unique value of each named field.
	Counts map[string]map[string]int64 `json:"counts,omitempty"`

	// The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each
	// specified category.
	Ranges map[string]map[string]int64 `json:"ranges,omitempty"`

	// Array of row objects.
	Rows []SearchResultRow `json:"rows,omitempty"`

	// Array of grouped search matches.
	Groups []SearchResultProperties `json:"groups,omitempty"`
}

SearchResult : Schema for the result of a query search operation.

type SearchResultProperties 

type SearchResultProperties struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows" validate:"required"`

	// Opaque bookmark token used when paginating results.
	Bookmark *string `json:"bookmark,omitempty"`

	// Grouped search matches.
	By *string `json:"by,omitempty"`

	// The counts facet syntax returns the number of query results for each unique value of each named field.
	Counts map[string]map[string]int64 `json:"counts,omitempty"`

	// The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each
	// specified category.
	Ranges map[string]map[string]int64 `json:"ranges,omitempty"`

	// Array of row objects.
	Rows []SearchResultRow `json:"rows,omitempty"`
}

SearchResultProperties : Schema for the result of a query search operation.

type SearchResultRow 

type SearchResultRow struct {
	// Schema for a document.
	Doc *Document `json:"doc,omitempty"`

	// Schema for the fields returned by a query search operation, a map of field name to value.
	Fields map[string]interface{} `json:"fields" validate:"required"`

	// Returns the context in which a search term was mentioned so that you can display more emphasized results to a user.
	Highlights map[string][]string `json:"highlights,omitempty"`

	// Schema for a document ID.
	ID *string `json:"id" validate:"required"`
}

SearchResultRow : Schema for a row of the result of a query search operation.

type Security 

type Security struct {
	// Schema for names and roles to map to a database permission.
	Admins *SecurityObject `json:"admins,omitempty"`

	// Schema for names and roles to map to a database permission.
	Members *SecurityObject `json:"members,omitempty"`

	// Database permissions for Cloudant users and/or API keys.
	Cloudant map[string][]string `json:"cloudant,omitempty"`

	// Manage permissions using the `_users` database only.
	CouchdbAuthOnly *bool `json:"couchdb_auth_only,omitempty"`
}

Security : Schema for a security document.

type SecurityObject 

type SecurityObject struct {
	// List of usernames.
	Names []string `json:"names,omitempty"`

	// List of roles.
	Roles []string `json:"roles,omitempty"`
}

SecurityObject : Schema for names and roles to map to a database permission.

type ServerInformation 

type ServerInformation struct {
	// Welcome message.
	Couchdb *string `json:"couchdb" validate:"required"`

	// List of enabled optional features.
	Features []string `json:"features" validate:"required"`

	// Schema for server vendor information.
	Vendor *ServerVendor `json:"vendor" validate:"required"`

	// Apache CouchDB version.
	Version *string `json:"version" validate:"required"`

	// List of feature flags.
	FeaturesFlags []string `json:"features_flags" validate:"required"`
}

ServerInformation : Schema for information about the server instance.

type ServerVendor 

type ServerVendor struct {
	// Vendor name.
	Name *string `json:"name" validate:"required"`

	// Vendor variant.
	Variant *string `json:"variant,omitempty"`

	// Vendor version.
	Version *string `json:"version,omitempty"`
}

ServerVendor : Schema for server vendor information.

type SessionAuthentication 

type SessionAuthentication struct {
	// authenticated.
	Authenticated *string `json:"authenticated,omitempty"`

	// authentication_db.
	AuthenticationDb *string `json:"authentication_db,omitempty"`

	// authentication_handlers.
	AuthenticationHandlers []string `json:"authentication_handlers" validate:"required"`
}

SessionAuthentication : Schema for session authentication information.

type SessionInformation 

type SessionInformation struct {
	// ok.
	Ok *bool `json:"ok" validate:"required"`

	// Schema for session authentication information.
	Info *SessionAuthentication `json:"info" validate:"required"`

	// Schema for the user context of a session.
	UserCtx *UserContext `json:"userCtx" validate:"required"`
}

SessionInformation : Schema for information about a session.

type ShardsInformation 

type ShardsInformation struct {
	// Mapping of shard hash value range to a list of nodes.
	Shards map[string][]string `json:"shards" validate:"required"`
}

ShardsInformation : Schema for a shards object that maps the hash value range for each shard to the array of nodes that contain a copy of that shard.

type ThroughputInformation added in v0.0.27 

type ThroughputInformation struct {
	// A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec
	// of provisioned throughput capacity.
	Blocks *int64 `json:"blocks" validate:"required"`

	// Provisioned global queries capacity in operations per second.
	Query *int64 `json:"query" validate:"required"`

	// Provisioned reads capacity in operations per second.
	Read *int64 `json:"read" validate:"required"`

	// Provisioned writes capacity in operations per second.
	Write *int64 `json:"write" validate:"required"`
}

ThroughputInformation : Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.

type UpInformation 

type UpInformation struct {
	// seeds.
	Seeds map[string]interface{} `json:"seeds" validate:"required"`

	// status.
	Status *string `json:"status" validate:"required"`
}

UpInformation : Schema for information about the up state of the server.

type UpdatesPending added in v0.4.1 

type UpdatesPending struct {
	// Sum of shard copies with the least amount of work to do.
	Minimum *int64 `json:"minimum" validate:"required"`

	// Sum of unique shards. This value is zero when at least one copy of every shard range is up-to-date and the view is
	// able to answer a query without index building delays.
	Preferred *int64 `json:"preferred" validate:"required"`

	// Sum of all shard copies.
	Total *int64 `json:"total" validate:"required"`
}

UpdatesPending : Schema for an ability to tell if view is up-to-date without querying it.

type UserContext 

type UserContext struct {
	// Database name in the context of the provided operation.
	Db *string `json:"db,omitempty"`

	// User name.
	Name *string `json:"name" validate:"required"`

	// List of user roles.
	Roles []string `json:"roles" validate:"required"`
}

UserContext : Schema for the user context of a session.

type UuidsResult 

type UuidsResult struct {
	// uuids.
	Uuids []string `json:"uuids" validate:"required"`
}

UuidsResult : Schema for a set of uuids generated by the server.

type ViewQueriesResult 

type ViewQueriesResult struct {
	// An array of result objects - one for each query. Each result object contains the same fields as the response to a
	// regular view request.
	Results []ViewResult `json:"results" validate:"required"`
}

ViewQueriesResult : Schema for the results of a queries view operation.

type ViewQuery 

type ViewQuery struct {
	// Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is
	// compressed.
	AttEncodingInfo *bool `json:"att_encoding_info,omitempty"`

	// Parameter to specify whether to include attachments bodies in a response.
	Attachments *bool `json:"attachments,omitempty"`

	// Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
	// `include_docs` is `true`.
	Conflicts *bool `json:"conflicts,omitempty"`

	// Parameter to specify whether to return the documents in descending by key order.
	Descending *bool `json:"descending,omitempty"`

	// Parameter to specify whether to include the full content of the documents in the response.
	IncludeDocs *bool `json:"include_docs,omitempty"`

	// Parameter to specify whether the specified end key should be included in the result.
	InclusiveEnd *bool `json:"inclusive_end,omitempty"`

	// Parameter to specify the number of returned documents to limit the result to.
	Limit *int64 `json:"limit,omitempty"`

	// Parameter to specify the number of records before starting to return the results.
	Skip *int64 `json:"skip,omitempty"`

	// Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the
	// database the view reflects.
	UpdateSeq *bool `json:"update_seq,omitempty"`

	// Schema for any JSON type.
	EndKey interface{} `json:"end_key,omitempty"`

	// Schema for a document ID.
	EndKeyDocID *string `json:"end_key_doc_id,omitempty"`

	// Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view.
	// If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of
	// array elements with the `group_level` parameter.
	Group *bool `json:"group,omitempty"`

	// Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies
	// group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results
	// are grouped by the entire array key, returning a reduced value for each complete key.
	GroupLevel *int64 `json:"group_level,omitempty"`

	// Schema for any JSON type.
	Key interface{} `json:"key,omitempty"`

	// Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match
	// the key type emitted by the view function.
	Keys []interface{} `json:"keys,omitempty"`

	// Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function
	// is defined.
	Reduce *bool `json:"reduce,omitempty"`

	// Query parameter to specify whether use the same replica of  the index on each request. The default value `false`
	// contacts all  replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in
	// conjunction with `update=false`  may improve consistency at the expense of increased latency and decreased
	// throughput if the selected replica is not the fastest of the available  replicas.
	//
	// **Note:** In general setting `true` is discouraged and is strictly not recommended when using `update=true`.
	Stable *bool `json:"stable,omitempty"`

	// Schema for any JSON type.
	StartKey interface{} `json:"start_key,omitempty"`

	// Schema for a document ID.
	StartKeyDocID *string `json:"start_key_doc_id,omitempty"`

	// Parameter to specify whether or not the view in question should be updated prior to responding to the user.
	//
	// * `true` - Return results after the view is updated.
	// * `false` - Return results without updating the view.
	// * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.
	Update *string `json:"update,omitempty"`
}

ViewQuery : Schema for a query view operation.

type ViewResult 

type ViewResult struct {
	// Number of total rows.
	TotalRows *int64 `json:"total_rows,omitempty"`

	// Current update sequence for the database.
	UpdateSeq *string `json:"update_seq,omitempty"`

	// rows.
	Rows []ViewResultRow `json:"rows" validate:"required"`
}

ViewResult : Schema for the result of a query view operation.

type ViewResultRow 

type ViewResultRow struct {
	// The cause of the error (if available).
	CausedBy *string `json:"caused_by,omitempty"`

	// The name of the error.
	Error *string `json:"error,omitempty"`

	// The reason the error occurred (if available).
	Reason *string `json:"reason,omitempty"`

	// Schema for a document.
	Doc *Document `json:"doc,omitempty"`

	// Schema for a document ID.
	ID *string `json:"id,omitempty"`

	// Schema for any JSON type.
	Key interface{} `json:"key" validate:"required"`

	// Schema for any JSON type.
	Value interface{} `json:"value" validate:"required"`
}

ViewResultRow : Schema for a row of a view result.

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.