Package com.amazonaws.services.cloudsearchv2

Class AbstractAmazonCloudSearch

  • All Implemented Interfaces:
    AmazonCloudSearch
    Direct Known Subclasses:
    AbstractAmazonCloudSearchAsync
    public class AbstractAmazonCloudSearch
extends Object
implements AmazonCloudSearch
    Abstract implementation of AmazonCloudSearch. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

    • Constructor Detail

      • AbstractAmazonCloudSearch

        protected AbstractAmazonCloudSearch()

    • Method Detail

      • setEndpoint

        public void setEndpoint​(String endpoint)
        Description copied from interface: AmazonCloudSearch
        Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

        Callers can pass in just the endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

        For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

        This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

        Specified by:
        setEndpoint in interface AmazonCloudSearch
        Parameters:
        endpoint - The endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

      • defineExpression

        public DefineExpressionResult defineExpression​(DefineExpressionRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        defineExpression in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DefineExpression operation returned by the service.

      • defineIndexField

        public DefineIndexFieldResult defineIndexField​(DefineIndexFieldRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        defineIndexField in interface AmazonCloudSearch
        Parameters:
        request - Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.
        Returns:
        Result of the DefineIndexField operation returned by the service.

      • defineSuggester

        public DefineSuggesterResult defineSuggester​(DefineSuggesterRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        defineSuggester in interface AmazonCloudSearch
        Parameters:
        request - Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.
        Returns:
        Result of the DefineSuggester operation returned by the service.

      • deleteDomain

        public DeleteDomainResult deleteDomain​(DeleteDomainRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        deleteDomain in interface AmazonCloudSearch
        Parameters:
        request - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
        Returns:
        Result of the DeleteDomain operation returned by the service.

      • describeAnalysisSchemes

        public DescribeAnalysisSchemesResult describeAnalysisSchemes​(DescribeAnalysisSchemesRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        describeAnalysisSchemes in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DescribeAnalysisSchemes operation returned by the service.

      • describeDomains

        public DescribeDomainsResult describeDomains​(DescribeDomainsRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        describeDomains in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DescribeDomains operation returned by the service.

      • describeExpressions

        public DescribeExpressionsResult describeExpressions​(DescribeExpressionsRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        describeExpressions in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DescribeExpressions operation returned by the service.

      • describeIndexFields

        public DescribeIndexFieldsResult describeIndexFields​(DescribeIndexFieldsRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        describeIndexFields in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DescribeIndexFields operation returned by the service.

      • describeSuggesters

        public DescribeSuggestersResult describeSuggesters​(DescribeSuggestersRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        describeSuggesters in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the DescribeSuggesters operation returned by the service.

      • indexDocuments

        public IndexDocumentsResult indexDocuments​(IndexDocumentsRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        indexDocuments in interface AmazonCloudSearch
        Parameters:
        request - Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.
        Returns:
        Result of the IndexDocuments operation returned by the service.

      • updateAvailabilityOptions

        public UpdateAvailabilityOptionsResult updateAvailabilityOptions​(UpdateAvailabilityOptionsRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        updateAvailabilityOptions in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the UpdateAvailabilityOptions operation returned by the service.

      • updateScalingParameters

        public UpdateScalingParametersResult updateScalingParameters​(UpdateScalingParametersRequest request)
        Description copied from interface: AmazonCloudSearch

        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.

        Specified by:
        updateScalingParameters in interface AmazonCloudSearch
        Parameters:
        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.
        Returns:
        Result of the UpdateScalingParameters operation returned by the service.

      • shutdown

        public void shutdown()
        Description copied from interface: AmazonCloudSearch
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonCloudSearch

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Description copied from interface: AmazonCloudSearch
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Specified by:
        getCachedResponseMetadata in interface AmazonCloudSearch
        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.