CloudSearchClient Class
(QtAws::CloudSearch::CloudSearchClient)The CloudSearchClient class provides access to the Amazon CloudSearch service. More...
| Header: | #include <CloudSearchClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| CloudSearchClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| CloudSearchClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| BuildSuggestersResponse * | buildSuggesters(const BuildSuggestersRequest &request) |
| CreateDomainResponse * | createDomain(const CreateDomainRequest &request) |
| DefineAnalysisSchemeResponse * | defineAnalysisScheme(const DefineAnalysisSchemeRequest &request) |
| DefineExpressionResponse * | defineExpression(const DefineExpressionRequest &request) |
| DefineIndexFieldResponse * | defineIndexField(const DefineIndexFieldRequest &request) |
| DefineSuggesterResponse * | defineSuggester(const DefineSuggesterRequest &request) |
| DeleteAnalysisSchemeResponse * | deleteAnalysisScheme(const DeleteAnalysisSchemeRequest &request) |
| DeleteDomainResponse * | deleteDomain(const DeleteDomainRequest &request) |
| DeleteExpressionResponse * | deleteExpression(const DeleteExpressionRequest &request) |
| DeleteIndexFieldResponse * | deleteIndexField(const DeleteIndexFieldRequest &request) |
| DeleteSuggesterResponse * | deleteSuggester(const DeleteSuggesterRequest &request) |
| DescribeAnalysisSchemesResponse * | describeAnalysisSchemes(const DescribeAnalysisSchemesRequest &request) |
| DescribeAvailabilityOptionsResponse * | describeAvailabilityOptions(const DescribeAvailabilityOptionsRequest &request) |
| DescribeDomainsResponse * | describeDomains(const DescribeDomainsRequest &request) |
| DescribeExpressionsResponse * | describeExpressions(const DescribeExpressionsRequest &request) |
| DescribeIndexFieldsResponse * | describeIndexFields(const DescribeIndexFieldsRequest &request) |
| DescribeScalingParametersResponse * | describeScalingParameters(const DescribeScalingParametersRequest &request) |
| DescribeServiceAccessPoliciesResponse * | describeServiceAccessPolicies(const DescribeServiceAccessPoliciesRequest &request) |
| DescribeSuggestersResponse * | describeSuggesters(const DescribeSuggestersRequest &request) |
| IndexDocumentsResponse * | indexDocuments(const IndexDocumentsRequest &request) |
| ListDomainNamesResponse * | listDomainNames() |
| UpdateAvailabilityOptionsResponse * | updateAvailabilityOptions(const UpdateAvailabilityOptionsRequest &request) |
| UpdateScalingParametersResponse * | updateScalingParameters(const UpdateScalingParametersRequest &request) |
| UpdateServiceAccessPoliciesResponse * | updateServiceAccessPolicies(const UpdateServiceAccessPoliciesRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The CloudSearchClient class provides access to the Amazon CloudSearch service.
<fullname>Amazon CloudSearch Configuration Service</fullname>
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named
Action>
The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region" target="_blank">Regions and
Member Function Documentation
CloudSearchClient::CloudSearchClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
Constructs a CloudSearchClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
CloudSearchClient::CloudSearchClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads CloudSearchClient().
This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).
See also QtAws::Core::AwsEndpoint::getEndpoint.
[slot] BuildSuggestersResponse *CloudSearchClient::buildSuggesters(const BuildSuggestersRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an BuildSuggestersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer
[slot] CreateDomainResponse *CloudSearchClient::createDomain(const CreateDomainRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an CreateDomainResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer
[slot] DefineAnalysisSchemeResponse *CloudSearchClient::defineAnalysisScheme(const DefineAnalysisSchemeRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DefineAnalysisSchemeResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer
[slot] DefineExpressionResponse *CloudSearchClient::defineExpression(const DefineExpressionRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DefineExpressionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer
[slot] DefineIndexFieldResponse *CloudSearchClient::defineIndexField(const DefineIndexFieldRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DefineIndexFieldResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.
[slot] DefineSuggesterResponse *CloudSearchClient::defineSuggester(const DefineSuggesterRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DefineSuggesterResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer
[slot] DeleteAnalysisSchemeResponse *CloudSearchClient::deleteAnalysisScheme(const DeleteAnalysisSchemeRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DeleteAnalysisSchemeResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.
[slot] DeleteDomainResponse *CloudSearchClient::deleteDomain(const DeleteDomainRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DeleteDomainResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.
[slot] DeleteExpressionResponse *CloudSearchClient::deleteExpression(const DeleteExpressionRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DeleteExpressionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer
[slot] DeleteIndexFieldResponse *CloudSearchClient::deleteIndexField(const DeleteIndexFieldRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DeleteIndexFieldResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer
[slot] DeleteSuggesterResponse *CloudSearchClient::deleteSuggester(const DeleteSuggesterRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DeleteSuggesterResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeAnalysisSchemesResponse *CloudSearchClient::describeAnalysisSchemes(const DescribeAnalysisSchemesRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeAnalysisSchemesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeAvailabilityOptionsResponse *CloudSearchClient::describeAvailabilityOptions(const DescribeAvailabilityOptionsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeAvailabilityOptionsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeDomainsResponse *CloudSearchClient::describeDomains(const DescribeDomainsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeDomainsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeExpressionsResponse *CloudSearchClient::describeExpressions(const DescribeExpressionsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeExpressionsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeIndexFieldsResponse *CloudSearchClient::describeIndexFields(const DescribeIndexFieldsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeIndexFieldsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeScalingParametersResponse *CloudSearchClient::describeScalingParameters(const DescribeScalingParametersRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeScalingParametersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeServiceAccessPoliciesResponse *CloudSearchClient::describeServiceAccessPolicies(const DescribeServiceAccessPoliciesRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeServiceAccessPoliciesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer
[slot] DescribeSuggestersResponse *CloudSearchClient::describeSuggesters(const DescribeSuggestersRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an DescribeSuggestersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer
[slot] IndexDocumentsResponse *CloudSearchClient::indexDocuments(const IndexDocumentsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an IndexDocumentsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is
[slot] ListDomainNamesResponse *CloudSearchClient::listDomainNames()
Sends a ListDomainNames request to the CloudSearchClient service, and returns a pointer to an ListDomainNamesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Lists all search domains owned by an
[slot] UpdateAvailabilityOptionsResponse *CloudSearchClient::updateAvailabilityOptions(const UpdateAvailabilityOptionsRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an UpdateAvailabilityOptionsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer
[slot] UpdateScalingParametersResponse *CloudSearchClient::updateScalingParameters(const UpdateScalingParametersRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an UpdateScalingParametersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.
[slot] UpdateServiceAccessPoliciesResponse *CloudSearchClient::updateServiceAccessPolicies(const UpdateServiceAccessPoliciesRequest &request)
Sends request to the CloudSearchClient service, and returns a pointer to an UpdateServiceAccessPoliciesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.