software.amazon.awssdk.services.cloudsearch.CloudSearchAsyncClient Maven / Gradle / Ivy
Show all versions of cloudsearch Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudsearch;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.cloudsearch.model.BuildSuggestersRequest;
import software.amazon.awssdk.services.cloudsearch.model.BuildSuggestersResponse;
import software.amazon.awssdk.services.cloudsearch.model.CreateDomainRequest;
import software.amazon.awssdk.services.cloudsearch.model.CreateDomainResponse;
import software.amazon.awssdk.services.cloudsearch.model.DefineAnalysisSchemeRequest;
import software.amazon.awssdk.services.cloudsearch.model.DefineAnalysisSchemeResponse;
import software.amazon.awssdk.services.cloudsearch.model.DefineExpressionRequest;
import software.amazon.awssdk.services.cloudsearch.model.DefineExpressionResponse;
import software.amazon.awssdk.services.cloudsearch.model.DefineIndexFieldRequest;
import software.amazon.awssdk.services.cloudsearch.model.DefineIndexFieldResponse;
import software.amazon.awssdk.services.cloudsearch.model.DefineSuggesterRequest;
import software.amazon.awssdk.services.cloudsearch.model.DefineSuggesterResponse;
import software.amazon.awssdk.services.cloudsearch.model.DeleteAnalysisSchemeRequest;
import software.amazon.awssdk.services.cloudsearch.model.DeleteAnalysisSchemeResponse;
import software.amazon.awssdk.services.cloudsearch.model.DeleteDomainRequest;
import software.amazon.awssdk.services.cloudsearch.model.DeleteDomainResponse;
import software.amazon.awssdk.services.cloudsearch.model.DeleteExpressionRequest;
import software.amazon.awssdk.services.cloudsearch.model.DeleteExpressionResponse;
import software.amazon.awssdk.services.cloudsearch.model.DeleteIndexFieldRequest;
import software.amazon.awssdk.services.cloudsearch.model.DeleteIndexFieldResponse;
import software.amazon.awssdk.services.cloudsearch.model.DeleteSuggesterRequest;
import software.amazon.awssdk.services.cloudsearch.model.DeleteSuggesterResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeAnalysisSchemesRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeAnalysisSchemesResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeAvailabilityOptionsRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeAvailabilityOptionsResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeDomainsRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeDomainsResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeExpressionsRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeExpressionsResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeIndexFieldsRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeIndexFieldsResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeScalingParametersRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeScalingParametersResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeServiceAccessPoliciesRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeServiceAccessPoliciesResponse;
import software.amazon.awssdk.services.cloudsearch.model.DescribeSuggestersRequest;
import software.amazon.awssdk.services.cloudsearch.model.DescribeSuggestersResponse;
import software.amazon.awssdk.services.cloudsearch.model.IndexDocumentsRequest;
import software.amazon.awssdk.services.cloudsearch.model.IndexDocumentsResponse;
import software.amazon.awssdk.services.cloudsearch.model.ListDomainNamesRequest;
import software.amazon.awssdk.services.cloudsearch.model.ListDomainNamesResponse;
import software.amazon.awssdk.services.cloudsearch.model.UpdateAvailabilityOptionsRequest;
import software.amazon.awssdk.services.cloudsearch.model.UpdateAvailabilityOptionsResponse;
import software.amazon.awssdk.services.cloudsearch.model.UpdateScalingParametersRequest;
import software.amazon.awssdk.services.cloudsearch.model.UpdateScalingParametersResponse;
import software.amazon.awssdk.services.cloudsearch.model.UpdateServiceAccessPoliciesRequest;
import software.amazon.awssdk.services.cloudsearch.model.UpdateServiceAccessPoliciesResponse;
/**
* Service client for accessing Amazon CloudSearch asynchronously. This can be created using the static
* {@link #builder()} method.
*
* Amazon CloudSearch Configuration Service
*
* 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.region.amazonaws.com. For
* example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and
* Endpoints.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface CloudSearchAsyncClient extends SdkClient {
String SERVICE_NAME = "cloudsearch";
/**
* Create a {@link CloudSearchAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static CloudSearchAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link CloudSearchAsyncClient}.
*/
static CloudSearchAsyncClientBuilder builder() {
return new DefaultCloudSearchAsyncClientBuilder();
}
/**
*
* Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
*
*
* @param buildSuggestersRequest
* Container for the parameters to the BuildSuggester operation. Specifies the name of
* the domain you want to update.
* @return A Java Future containing the result of the BuildSuggesters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.BuildSuggesters
*/
default CompletableFuture buildSuggesters(BuildSuggestersRequest buildSuggestersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link BuildSuggestersRequest.Builder} avoiding the need
* to create one manually via {@link BuildSuggestersRequest#builder()}
*
*
* @param buildSuggestersRequest
* A {@link Consumer} that will call methods on {@link BuildSuggestersRequest.Builder} to create a request.
* Container for the parameters to the BuildSuggester operation. Specifies the name of
* the domain you want to update.
* @return A Java Future containing the result of the BuildSuggesters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.BuildSuggesters
*/
default CompletableFuture buildSuggesters(
Consumer buildSuggestersRequest) {
return buildSuggesters(BuildSuggestersRequest.builder().applyMutation(buildSuggestersRequest).build());
}
/**
*
* Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
* @param createDomainRequest
* Container for the parameters to the CreateDomain operation. Specifies a name for the
* new search domain.
* @return A Java Future containing the result of the CreateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.CreateDomain
*/
default CompletableFuture createDomain(CreateDomainRequest createDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDomainRequest.Builder} avoiding the need to
* create one manually via {@link CreateDomainRequest#builder()}
*
*
* @param createDomainRequest
* A {@link Consumer} that will call methods on {@link CreateDomainRequest.Builder} to create a request.
* Container for the parameters to the CreateDomain operation. Specifies a name for the
* new search domain.
* @return A Java Future containing the result of the CreateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.CreateDomain
*/
default CompletableFuture createDomain(Consumer createDomainRequest) {
return createDomain(CreateDomainRequest.builder().applyMutation(createDomainRequest).build());
}
/**
*
* Configures an analysis scheme that can be applied to a text or text-array field to
* define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
* @param defineAnalysisSchemeRequest
* Container for the parameters to the DefineAnalysisScheme operation. Specifies the name
* of the domain you want to update and the analysis scheme configuration.
* @return A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineAnalysisScheme
*/
default CompletableFuture defineAnalysisScheme(
DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures an analysis scheme that can be applied to a text or text-array field to
* define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DefineAnalysisSchemeRequest.Builder} avoiding the
* need to create one manually via {@link DefineAnalysisSchemeRequest#builder()}
*
*
* @param defineAnalysisSchemeRequest
* A {@link Consumer} that will call methods on {@link DefineAnalysisSchemeRequest.Builder} to create a
* request. Container for the parameters to the DefineAnalysisScheme operation. Specifies
* the name of the domain you want to update and the analysis scheme configuration.
* @return A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineAnalysisScheme
*/
default CompletableFuture defineAnalysisScheme(
Consumer defineAnalysisSchemeRequest) {
return defineAnalysisScheme(DefineAnalysisSchemeRequest.builder().applyMutation(defineAnalysisSchemeRequest).build());
}
/**
*
* Configures an Expression 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 Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
* @param defineExpressionRequest
* Container for the parameters to the DefineExpression operation. Specifies the name of
* the domain you want to update and the expression you want to configure.
* @return A Java Future containing the result of the DefineExpression operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineExpression
*/
default CompletableFuture defineExpression(DefineExpressionRequest defineExpressionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures an Expression 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 Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DefineExpressionRequest.Builder} avoiding the need
* to create one manually via {@link DefineExpressionRequest#builder()}
*
*
* @param defineExpressionRequest
* A {@link Consumer} that will call methods on {@link DefineExpressionRequest.Builder} to create a request.
* Container for the parameters to the DefineExpression operation. Specifies the name of
* the domain you want to update and the expression you want to configure.
* @return A Java Future containing the result of the DefineExpression operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineExpression
*/
default CompletableFuture defineExpression(
Consumer defineExpressionRequest) {
return defineExpression(DefineExpressionRequest.builder().applyMutation(defineExpressionRequest).build());
}
/**
*
* Configures an IndexField 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 IndexFieldType. If the field exists, the new
* configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
*
*
* @param defineIndexFieldRequest
* Container for the parameters to the DefineIndexField operation. Specifies the name of
* the domain you want to update and the index field configuration.
* @return A Java Future containing the result of the DefineIndexField operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineIndexField
*/
default CompletableFuture defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures an IndexField 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 IndexFieldType. If the field exists, the new
* configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DefineIndexFieldRequest.Builder} avoiding the need
* to create one manually via {@link DefineIndexFieldRequest#builder()}
*
*
* @param defineIndexFieldRequest
* A {@link Consumer} that will call methods on {@link DefineIndexFieldRequest.Builder} to create a request.
* Container for the parameters to the DefineIndexField operation. Specifies the name of
* the domain you want to update and the index field configuration.
* @return A Java Future containing the result of the DefineIndexField operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineIndexField
*/
default CompletableFuture defineIndexField(
Consumer defineIndexFieldRequest) {
return defineIndexField(DefineIndexFieldRequest.builder().applyMutation(defineIndexFieldRequest).build());
}
/**
*
* 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 Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
* @param defineSuggesterRequest
* Container for the parameters to the DefineSuggester operation. Specifies the name of
* the domain you want to update and the suggester configuration.
* @return A Java Future containing the result of the DefineSuggester operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineSuggester
*/
default CompletableFuture defineSuggester(DefineSuggesterRequest defineSuggesterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DefineSuggesterRequest.Builder} avoiding the need
* to create one manually via {@link DefineSuggesterRequest#builder()}
*
*
* @param defineSuggesterRequest
* A {@link Consumer} that will call methods on {@link DefineSuggesterRequest.Builder} to create a request.
* Container for the parameters to the DefineSuggester operation. Specifies the name of
* the domain you want to update and the suggester configuration.
* @return A Java Future containing the result of the DefineSuggester operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DefineSuggester
*/
default CompletableFuture defineSuggester(
Consumer defineSuggesterRequest) {
return defineSuggester(DefineSuggesterRequest.builder().applyMutation(defineSuggesterRequest).build());
}
/**
*
* Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
* @param deleteAnalysisSchemeRequest
* Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name
* of the domain you want to update and the analysis scheme you want to delete.
* @return A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteAnalysisScheme
*/
default CompletableFuture deleteAnalysisScheme(
DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAnalysisSchemeRequest.Builder} avoiding the
* need to create one manually via {@link DeleteAnalysisSchemeRequest#builder()}
*
*
* @param deleteAnalysisSchemeRequest
* A {@link Consumer} that will call methods on {@link DeleteAnalysisSchemeRequest.Builder} to create a
* request. Container for the parameters to the DeleteAnalysisScheme operation. Specifies
* the name of the domain you want to update and the analysis scheme you want to delete.
* @return A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteAnalysisScheme
*/
default CompletableFuture deleteAnalysisScheme(
Consumer deleteAnalysisSchemeRequest) {
return deleteAnalysisScheme(DeleteAnalysisSchemeRequest.builder().applyMutation(deleteAnalysisSchemeRequest).build());
}
/**
*
* Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered.
* For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
* @param deleteDomainRequest
* Container for the parameters to the DeleteDomain operation. Specifies the name of the
* domain you want to delete.
* @return A Java Future containing the result of the DeleteDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteDomain
*/
default CompletableFuture deleteDomain(DeleteDomainRequest deleteDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered.
* For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDomainRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDomainRequest#builder()}
*
*
* @param deleteDomainRequest
* A {@link Consumer} that will call methods on {@link DeleteDomainRequest.Builder} to create a request.
* Container for the parameters to the DeleteDomain operation. Specifies the name of the
* domain you want to delete.
* @return A Java Future containing the result of the DeleteDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteDomain
*/
default CompletableFuture deleteDomain(Consumer deleteDomainRequest) {
return deleteDomain(DeleteDomainRequest.builder().applyMutation(deleteDomainRequest).build());
}
/**
*
* Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
* @param deleteExpressionRequest
* Container for the parameters to the DeleteExpression operation. Specifies the name of
* the domain you want to update and the name of the expression you want to delete.
* @return A Java Future containing the result of the DeleteExpression operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteExpression
*/
default CompletableFuture deleteExpression(DeleteExpressionRequest deleteExpressionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteExpressionRequest.Builder} avoiding the need
* to create one manually via {@link DeleteExpressionRequest#builder()}
*
*
* @param deleteExpressionRequest
* A {@link Consumer} that will call methods on {@link DeleteExpressionRequest.Builder} to create a request.
* Container for the parameters to the DeleteExpression operation. Specifies the name of
* the domain you want to update and the name of the expression you want to delete.
* @return A Java Future containing the result of the DeleteExpression operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteExpression
*/
default CompletableFuture deleteExpression(
Consumer deleteExpressionRequest) {
return deleteExpression(DeleteExpressionRequest.builder().applyMutation(deleteExpressionRequest).build());
}
/**
*
* Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
*
*
* @param deleteIndexFieldRequest
* Container for the parameters to the DeleteIndexField operation. Specifies the name of
* the domain you want to update and the name of the index field you want to delete.
* @return A Java Future containing the result of the DeleteIndexField operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteIndexField
*/
default CompletableFuture deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIndexFieldRequest.Builder} avoiding the need
* to create one manually via {@link DeleteIndexFieldRequest#builder()}
*
*
* @param deleteIndexFieldRequest
* A {@link Consumer} that will call methods on {@link DeleteIndexFieldRequest.Builder} to create a request.
* Container for the parameters to the DeleteIndexField operation. Specifies the name of
* the domain you want to update and the name of the index field you want to delete.
* @return A Java Future containing the result of the DeleteIndexField operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteIndexField
*/
default CompletableFuture deleteIndexField(
Consumer deleteIndexFieldRequest) {
return deleteIndexField(DeleteIndexFieldRequest.builder().applyMutation(deleteIndexFieldRequest).build());
}
/**
*
* Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
* @param deleteSuggesterRequest
* Container for the parameters to the DeleteSuggester operation. Specifies the name of
* the domain you want to update and name of the suggester you want to delete.
* @return A Java Future containing the result of the DeleteSuggester operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteSuggester
*/
default CompletableFuture deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSuggesterRequest.Builder} avoiding the need
* to create one manually via {@link DeleteSuggesterRequest#builder()}
*
*
* @param deleteSuggesterRequest
* A {@link Consumer} that will call methods on {@link DeleteSuggesterRequest.Builder} to create a request.
* Container for the parameters to the DeleteSuggester operation. Specifies the name of
* the domain you want to update and name of the suggester you want to delete.
* @return A Java Future containing the result of the DeleteSuggester operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DeleteSuggester
*/
default CompletableFuture deleteSuggester(
Consumer deleteSuggesterRequest) {
return deleteSuggester(DeleteSuggesterRequest.builder().applyMutation(deleteSuggesterRequest).build());
}
/**
*
* Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing
* options for a text 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 Deployed option to
* true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
* @param describeAnalysisSchemesRequest
* Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the
* name of the domain you want to describe. To limit the response to particular analysis schemes, specify the
* names of the analysis schemes you want to describe. To show the active configuration and exclude any
* pending changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeAnalysisSchemes
*/
default CompletableFuture describeAnalysisSchemes(
DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing
* options for a text 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 Deployed option to
* true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAnalysisSchemesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAnalysisSchemesRequest#builder()}
*
*
* @param describeAnalysisSchemesRequest
* A {@link Consumer} that will call methods on {@link DescribeAnalysisSchemesRequest.Builder} to create a
* request. Container for the parameters to the DescribeAnalysisSchemes operation.
* Specifies the name of the domain you want to describe. To limit the response to particular analysis
* schemes, specify the names of the analysis schemes you want to describe. To show the active configuration
* and exclude any pending changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeAnalysisSchemes
*/
default CompletableFuture describeAnalysisSchemes(
Consumer describeAnalysisSchemesRequest) {
return describeAnalysisSchemes(DescribeAnalysisSchemesRequest.builder().applyMutation(describeAnalysisSchemesRequest)
.build());
}
/**
*
* Gets the availability options configured for a domain. By default, shows the configuration with any pending
* changes. Set the Deployed option to true to show the active configuration and exclude
* pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
*
*
* @param describeAvailabilityOptionsRequest
* Container for the parameters to the DescribeAvailabilityOptions operation. Specifies
* the name of the domain you want to describe. To show the active configuration and exclude any pending
* changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - DisabledOperationException The request was rejected because it attempted an operation which is not
* enabled.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeAvailabilityOptions
*/
default CompletableFuture describeAvailabilityOptions(
DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the availability options configured for a domain. By default, shows the configuration with any pending
* changes. Set the Deployed option to true to show the active configuration and exclude
* pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAvailabilityOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeAvailabilityOptionsRequest#builder()}
*
*
* @param describeAvailabilityOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeAvailabilityOptionsRequest.Builder} to create
* a request. Container for the parameters to the DescribeAvailabilityOptions operation.
* Specifies the name of the domain you want to describe. To show the active configuration and exclude any
* pending changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - DisabledOperationException The request was rejected because it attempted an operation which is not
* enabled.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeAvailabilityOptions
*/
default CompletableFuture describeAvailabilityOptions(
Consumer describeAvailabilityOptionsRequest) {
return describeAvailabilityOptions(DescribeAvailabilityOptionsRequest.builder()
.applyMutation(describeAvailabilityOptionsRequest).build());
}
/**
*
* 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
* matchall request to your domain's search endpoint:
* q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
* @param describeDomainsRequest
* Container for the parameters to the DescribeDomains operation. By default shows the
* status of all domains. To restrict the response to particular domains, specify the names of the domains
* you want to describe.
* @return A Java Future containing the result of the DescribeDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeDomains
*/
default CompletableFuture describeDomains(DescribeDomainsRequest describeDomainsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* matchall request to your domain's search endpoint:
* q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDomainsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDomainsRequest#builder()}
*
*
* @param describeDomainsRequest
* A {@link Consumer} that will call methods on {@link DescribeDomainsRequest.Builder} to create a request.
* Container for the parameters to the DescribeDomains operation. By default shows the
* status of all domains. To restrict the response to particular domains, specify the names of the domains
* you want to describe.
* @return A Java Future containing the result of the DescribeDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeDomains
*/
default CompletableFuture describeDomains(
Consumer describeDomainsRequest) {
return describeDomains(DescribeDomainsRequest.builder().applyMutation(describeDomainsRequest).build());
}
/**
*
* 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
* matchall request to your domain's search endpoint:
* q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
* @return A Java Future containing the result of the DescribeDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeDomains
*/
default CompletableFuture describeDomains() {
return describeDomains(DescribeDomainsRequest.builder().build());
}
/**
*
* 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
* Deployed option to true to show the active configuration and exclude pending changes.
* For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
* @param describeExpressionsRequest
* Container for the parameters to the DescribeDomains operation. Specifies the name of
* the domain you want to describe. To restrict the response to particular expressions, specify the names of
* the expressions you want to describe. To show the active configuration and exclude any pending changes,
* set the Deployed option to true.
* @return A Java Future containing the result of the DescribeExpressions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeExpressions
*/
default CompletableFuture describeExpressions(
DescribeExpressionsRequest describeExpressionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* Deployed option to true to show the active configuration and exclude pending changes.
* For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeExpressionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeExpressionsRequest#builder()}
*
*
* @param describeExpressionsRequest
* A {@link Consumer} that will call methods on {@link DescribeExpressionsRequest.Builder} to create a
* request. Container for the parameters to the DescribeDomains operation. Specifies the
* name of the domain you want to describe. To restrict the response to particular expressions, specify the
* names of the expressions you want to describe. To show the active configuration and exclude any pending
* changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeExpressions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeExpressions
*/
default CompletableFuture describeExpressions(
Consumer describeExpressionsRequest) {
return describeExpressions(DescribeExpressionsRequest.builder().applyMutation(describeExpressionsRequest).build());
}
/**
*
* 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
* Deployed option to true to show the active configuration and exclude pending changes.
* For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
*
*
* @param describeIndexFieldsRequest
* Container for the parameters to the DescribeIndexFields operation. Specifies the name
* of the domain you want to describe. To restrict the response to particular index fields, specify the names
* of the index fields you want to describe. To show the active configuration and exclude any pending
* changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeIndexFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeIndexFields
*/
default CompletableFuture describeIndexFields(
DescribeIndexFieldsRequest describeIndexFieldsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* Deployed option to true to show the active configuration and exclude pending changes.
* For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeIndexFieldsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeIndexFieldsRequest#builder()}
*
*
* @param describeIndexFieldsRequest
* A {@link Consumer} that will call methods on {@link DescribeIndexFieldsRequest.Builder} to create a
* request. Container for the parameters to the DescribeIndexFields operation. Specifies
* the name of the domain you want to describe. To restrict the response to particular index fields, specify
* the names of the index fields you want to describe. To show the active configuration and exclude any
* pending changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeIndexFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeIndexFields
*/
default CompletableFuture describeIndexFields(
Consumer describeIndexFieldsRequest) {
return describeIndexFields(DescribeIndexFieldsRequest.builder().applyMutation(describeIndexFieldsRequest).build());
}
/**
*
* 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 Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
*
*
* @param describeScalingParametersRequest
* Container for the parameters to the DescribeScalingParameters operation. Specifies the
* name of the domain you want to describe.
* @return A Java Future containing the result of the DescribeScalingParameters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeScalingParameters
*/
default CompletableFuture describeScalingParameters(
DescribeScalingParametersRequest describeScalingParametersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeScalingParametersRequest.Builder} avoiding
* the need to create one manually via {@link DescribeScalingParametersRequest#builder()}
*
*
* @param describeScalingParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeScalingParametersRequest.Builder} to create a
* request. Container for the parameters to the DescribeScalingParameters operation.
* Specifies the name of the domain you want to describe.
* @return A Java Future containing the result of the DescribeScalingParameters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeScalingParameters
*/
default CompletableFuture describeScalingParameters(
Consumer describeScalingParametersRequest) {
return describeScalingParameters(DescribeScalingParametersRequest.builder()
.applyMutation(describeScalingParametersRequest).build());
}
/**
*
* 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 Deployed option to
* true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
* @param describeServiceAccessPoliciesRequest
* Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies
* the name of the domain you want to describe. To show the active configuration and exclude any pending
* changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeServiceAccessPolicies
*/
default CompletableFuture describeServiceAccessPolicies(
DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Deployed option to
* true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeServiceAccessPoliciesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeServiceAccessPoliciesRequest#builder()}
*
*
* @param describeServiceAccessPoliciesRequest
* A {@link Consumer} that will call methods on {@link DescribeServiceAccessPoliciesRequest.Builder} to
* create a request. Container for the parameters to the DescribeServiceAccessPolicies
* operation. Specifies the name of the domain you want to describe. To show the active configuration and
* exclude any pending changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeServiceAccessPolicies
*/
default CompletableFuture describeServiceAccessPolicies(
Consumer describeServiceAccessPoliciesRequest) {
return describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest.builder()
.applyMutation(describeServiceAccessPoliciesRequest).build());
}
/**
*
* 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 Deployed option to true to
* show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
* @param describeSuggestersRequest
* Container for the parameters to the DescribeSuggester operation. Specifies the name of
* the domain you want to describe. To restrict the response to particular suggesters, specify the names of
* the suggesters you want to describe. To show the active configuration and exclude any pending changes, set
* the Deployed option to true.
* @return A Java Future containing the result of the DescribeSuggesters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeSuggesters
*/
default CompletableFuture describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Deployed option to true to
* show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSuggestersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSuggestersRequest#builder()}
*
*
* @param describeSuggestersRequest
* A {@link Consumer} that will call methods on {@link DescribeSuggestersRequest.Builder} to create a
* request. Container for the parameters to the DescribeSuggester operation. Specifies
* the name of the domain you want to describe. To restrict the response to particular suggesters, specify
* the names of the suggesters you want to describe. To show the active configuration and exclude any pending
* changes, set the Deployed option to true.
* @return A Java Future containing the result of the DescribeSuggesters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.DescribeSuggesters
*/
default CompletableFuture describeSuggesters(
Consumer describeSuggestersRequest) {
return describeSuggesters(DescribeSuggestersRequest.builder().applyMutation(describeSuggestersRequest).build());
}
/**
*
* Tells the search domain to start indexing its documents using the latest indexing options. This operation must be
* invoked to activate options whose OptionStatus is RequiresIndexDocuments.
*
*
* @param indexDocumentsRequest
* Container for the parameters to the IndexDocuments operation. Specifies the name of
* the domain you want to re-index.
* @return A Java Future containing the result of the IndexDocuments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.IndexDocuments
*/
default CompletableFuture indexDocuments(IndexDocumentsRequest indexDocumentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Tells the search domain to start indexing its documents using the latest indexing options. This operation must be
* invoked to activate options whose OptionStatus is RequiresIndexDocuments.
*
*
*
* This is a convenience which creates an instance of the {@link IndexDocumentsRequest.Builder} avoiding the need to
* create one manually via {@link IndexDocumentsRequest#builder()}
*
*
* @param indexDocumentsRequest
* A {@link Consumer} that will call methods on {@link IndexDocumentsRequest.Builder} to create a request.
* Container for the parameters to the IndexDocuments operation. Specifies the name of
* the domain you want to re-index.
* @return A Java Future containing the result of the IndexDocuments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.IndexDocuments
*/
default CompletableFuture indexDocuments(Consumer indexDocumentsRequest) {
return indexDocuments(IndexDocumentsRequest.builder().applyMutation(indexDocumentsRequest).build());
}
/**
*
* Lists all search domains owned by an account.
*
*
* @param listDomainNamesRequest
* @return A Java Future containing the result of the ListDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.ListDomainNames
*/
default CompletableFuture listDomainNames(ListDomainNamesRequest listDomainNamesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all search domains owned by an account.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainNamesRequest.Builder} avoiding the need
* to create one manually via {@link ListDomainNamesRequest#builder()}
*
*
* @param listDomainNamesRequest
* A {@link Consumer} that will call methods on {@link ListDomainNamesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.ListDomainNames
*/
default CompletableFuture listDomainNames(
Consumer listDomainNamesRequest) {
return listDomainNames(ListDomainNamesRequest.builder().applyMutation(listDomainNamesRequest).build());
}
/**
*
* Lists all search domains owned by an account.
*
*
* @return A Java Future containing the result of the ListDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.ListDomainNames
*/
default CompletableFuture listDomainNames() {
return listDomainNames(ListDomainNamesRequest.builder().build());
}
/**
*
* 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 Configuring Availability Options in the Amazon CloudSearch Developer Guide.
*
*
* @param updateAvailabilityOptionsRequest
* Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the
* name of the domain you want to update and the Multi-AZ availability option.
* @return A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - DisabledOperationException The request was rejected because it attempted an operation which is not
* enabled.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateAvailabilityOptions
*/
default CompletableFuture updateAvailabilityOptions(
UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Configuring Availability Options in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAvailabilityOptionsRequest.Builder} avoiding
* the need to create one manually via {@link UpdateAvailabilityOptionsRequest#builder()}
*
*
* @param updateAvailabilityOptionsRequest
* A {@link Consumer} that will call methods on {@link UpdateAvailabilityOptionsRequest.Builder} to create a
* request. Container for the parameters to the UpdateAvailabilityOptions operation.
* Specifies the name of the domain you want to update and the Multi-AZ availability option.
* @return A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - DisabledOperationException The request was rejected because it attempted an operation which is not
* enabled.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateAvailabilityOptions
*/
default CompletableFuture updateAvailabilityOptions(
Consumer updateAvailabilityOptionsRequest) {
return updateAvailabilityOptions(UpdateAvailabilityOptionsRequest.builder()
.applyMutation(updateAvailabilityOptionsRequest).build());
}
/**
*
* 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 Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
*
*
* @param updateScalingParametersRequest
* Container for the parameters to the UpdateScalingParameters operation. Specifies the
* name of the domain you want to update and the scaling parameters you want to configure.
* @return A Java Future containing the result of the UpdateScalingParameters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateScalingParameters
*/
default CompletableFuture updateScalingParameters(
UpdateScalingParametersRequest updateScalingParametersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateScalingParametersRequest.Builder} avoiding
* the need to create one manually via {@link UpdateScalingParametersRequest#builder()}
*
*
* @param updateScalingParametersRequest
* A {@link Consumer} that will call methods on {@link UpdateScalingParametersRequest.Builder} to create a
* request. Container for the parameters to the UpdateScalingParameters operation.
* Specifies the name of the domain you want to update and the scaling parameters you want to configure.
* @return A Java Future containing the result of the UpdateScalingParameters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateScalingParameters
*/
default CompletableFuture updateScalingParameters(
Consumer updateScalingParametersRequest) {
return updateScalingParameters(UpdateScalingParametersRequest.builder().applyMutation(updateScalingParametersRequest)
.build());
}
/**
*
* Configures the access rules that control access to the domain's document and search endpoints. For more
* information, see Configuring Access for an Amazon CloudSearch Domain.
*
*
* @param updateServiceAccessPoliciesRequest
* Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies
* the name of the domain you want to update and the access rules you want to configure.
* @return A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateServiceAccessPolicies
*/
default CompletableFuture updateServiceAccessPolicies(
UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures the access rules that control access to the domain's document and search endpoints. For more
* information, see Configuring Access for an Amazon CloudSearch Domain.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateServiceAccessPoliciesRequest.Builder}
* avoiding the need to create one manually via {@link UpdateServiceAccessPoliciesRequest#builder()}
*
*
* @param updateServiceAccessPoliciesRequest
* A {@link Consumer} that will call methods on {@link UpdateServiceAccessPoliciesRequest.Builder} to create
* a request. Container for the parameters to the UpdateServiceAccessPolicies operation.
* Specifies the name of the domain you want to update and the access rules you want to configure.
* @return A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BaseException An error occurred while processing the request.
* - InternalException An internal error occurred while processing the request. If this problem persists,
* report an issue from the Service Health
* Dashboard.
* - LimitExceededException The request was rejected because a resource limit has already been met.
* - ResourceNotFoundException The request was rejected because it attempted to reference a resource that
* does not exist.
* - InvalidTypeException The request was rejected because it specified an invalid type definition.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudSearchAsyncClient.UpdateServiceAccessPolicies
*/
default CompletableFuture updateServiceAccessPolicies(
Consumer updateServiceAccessPoliciesRequest) {
return updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest.builder()
.applyMutation(updateServiceAccessPoliciesRequest).build());
}
}