|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/cloudsearch2/__pycache__/ |
Upload File : |
o
ckF[�R � @ sp d dl mZ d dl mZ d dl mZ d dl mZ d dl mZ d dlmZ d dlm Z dd � Z
G d
d � d e �Z d S )
� ��IndexFieldStatus)�ServicePoliciesStatus��ExpressionStatus)�AvailabilityOptionsStatus)�ScalingParametersStatus��DocumentServiceConnection��SearchConnectionc C s | dv rdS dS )N)T�true�True�TRUE� TF� )�valuer r �:/usr/lib/python3/dist-packages/boto/cloudsearch2/domain.py� handle_bool s r c @ sn e Zd ZdZdd� Zdd� Zedd� �Zedd � �Zed
d � �Z ed d
� �Z
e
j dd
� �Z
edd� �Z e j dd� �Z edd� �Z
e
j dd� �Z
edd� �Zej dd� �Zedd� �Zej dd� �Zedd � �Zej d d � �Zed d � �Zed d!� �Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd?d/d0�Z 2 2 . .d@d3d4�Zd?d5d6�Zd7d8� Z d9d:� Z d;d<� Z d=d>� Z d.S )A�Domaina�
A Cloudsearch domain.
:ivar name: The name of the domain.
:ivar id: The internally generated unique identifier for the domain.
:ivar created: A boolean which is True if the domain is
created. It can take several minutes to initialize a domain
when CreateDomain is called. Newly created search domains are
returned with a False value for Created until domain creation
is complete
:ivar deleted: A boolean which is True if the search domain has
been deleted. The system must clean up resources dedicated to
the search domain when delete is called. Newly deleted
search domains are returned from list_domains with a True
value for deleted for several minutes until resource cleanup
is complete.
:ivar processing: True if processing is being done to activate the
current domain configuration.
:ivar num_searchable_docs: The number of documents that have been
submittted to the domain and indexed.
:ivar requires_index_document: True if index_documents needs to be
called to activate the current domain configuration.
:ivar search_instance_count: The number of search instances that are
available to process search requests.
:ivar search_instance_type: The instance type that is being used to
process search requests.
:ivar search_partition_count: The number of partitions across which
the search index is spread.
c C s || _ | �|� dS )a#
Constructor - Create a domain object from a layer1 and data params
:type layer1: :class:`boto.cloudsearch2.layer1.Layer1` object
:param layer1: A :class:`boto.cloudsearch2.layer1.Layer1` object
which is used to perform operations on the domain.
N)�layer1�update_from_data)�selfr �datar r r �__init__N s zDomain.__init__c C s� |d | _ |d | _|d | _|d | _|d | _|d | _|d | _|�dd �| _|d | _ |d
| _
|d | _ |d | _ d S )
N�Created�Deleted�
Processing�RequiresIndexDocuments�DomainId�
DomainName�SearchInstanceCount�SearchInstanceType�SearchPartitionCount�
DocService�ARN�
SearchService)
�created�deleted�
processing�requires_index_documents� domain_id� domain_name�search_instance_count�get�search_instance_type�search_partition_count� _doc_service� _service_arn�_search_service)r r r r r r Y s
zDomain.update_from_datac C � | j S �N)r2 �r r r r � service_arng � zDomain.service_arnc C �
| j d S �N�Endpoint)r1 r6 r r r �doc_service_endpointk �
zDomain.doc_service_endpointc C r9 r: )r3 r6 r r r �search_service_endpointo r= z Domain.search_service_endpointc C r4 r5 )�_createdr6 r r r r' s r8 zDomain.createdc C � t |�| _d S r5 )r r? �r r r r r r' w � c C r4 r5 )�_deletedr6 r r r r( { r8 zDomain.deletedc C r@ r5 )r rC rA r r r r( rB c C r4 r5 )� _processingr6 r r r r) � r8 zDomain.processingc C r@ r5 )r rD rA r r r r) � rB c C r4 r5 )�_requires_index_documentsr6 r r r r* � r8 z Domain.requires_index_documentsc C r@ r5 )r rE rA r r r r* � rB c C r4 r5 )�_search_partition_countr6 r r r r0 � r8 z Domain.search_partition_countc C r@ r5 )�intrF rA r r r r0 � rB c C r4 r5 )�_search_instance_countr6 r r r r- � r8 z Domain.search_instance_countc C r@ r5 )rG rH rA r r r r- � rB c C r4 r5 �r, r6 r r r �name� r8 z Domain.namec C r4 r5 )r+ r6 r r r �id� r8 z Domain.idc C � | j �| j�S )zK
Delete this domain and all index data associated with it.
)r �
delete_domainrJ r6 r r r �delete� � z
Domain.deletec C rL )z;
Return a list of Analysis Scheme objects.
)r �describe_analysis_schemesrJ r6 r r r �get_analysis_schemes� rO zDomain.get_analysis_schemesc C � t | | jjg d�| jjd�S )a:
Return a :class:`boto.cloudsearch2.option.AvailabilityOptionsStatus`
object representing the currently defined availability options for
the domain.
:return: OptionsStatus object
:rtype: :class:`boto.cloudsearch2.option.AvailabilityOptionsStatus`
object
)�#DescribeAvailabilityOptionsResponse�!DescribeAvailabilityOptionsResult�AvailabilityOptions��
refresh_fn� refresh_key�save_fn)r r � describe_availability_options�update_availability_optionsr6 r r r �get_availability_options� �
�z Domain.get_availability_optionsc C rR )a;
Return a :class:`boto.cloudsearch2.option.ScalingParametersStatus`
object representing the currently defined scaling options for the
domain.
:return: ScalingParametersStatus object
:rtype: :class:`boto.cloudsearch2.option.ScalingParametersStatus`
object
)�!DescribeScalingParametersResponse� DescribeScalingParametersResult�ScalingParametersrV )r r �describe_scaling_parameters�update_scaling_parametersr6 r r r �get_scaling_options� r] zDomain.get_scaling_optionsc C rR )a)
Return a :class:`boto.cloudsearch2.option.ServicePoliciesStatus`
object representing the currently defined access policies for the
domain.
:return: ServicePoliciesStatus object
:rtype: :class:`boto.cloudsearch2.option.ServicePoliciesStatus` object
)�%DescribeServiceAccessPoliciesResponse�#DescribeServiceAccessPoliciesResult�AccessPoliciesrV )r r � describe_service_access_policies� update_service_access_policiesr6 r r r �get_access_policies� s
�zDomain.get_access_policiesc C s | j �| j� dS )a*
Tells the search domain to start indexing its documents using
the latest text processing options and IndexFields. This
operation must be invoked to make options whose OptionStatus
has OptionState of RequiresIndexDocuments visible in search
results.
N)r �index_documentsrJ r6 r r r rj � s zDomain.index_documentsNc s2 � j �� j|�}|d d d }� fdd�|D �S )z�
Return a list of index fields defined for this domain.
:return: list of IndexFieldStatus objects
:rtype: list of :class:`boto.cloudsearch2.option.IndexFieldStatus`
object
�DescribeIndexFieldsResponse�DescribeIndexFieldsResult� IndexFieldsc s g | ]}t � |��qS r r ��.0�dr6 r r �
<listcomp>� s z+Domain.get_index_fields.<locals>.<listcomp>)r �describe_index_fieldsrJ )r � field_namesr r r6 r �get_index_fields� s ��zDomain.get_index_fields� Fc
C s ||d�} |dkr$||||d�| d< |r|| d d< | r"| | d d< �nS|dkrE|||d�| d < |r8|| d d< | rCd
� | �| d d < �n2|d kre|||||d
�| d< |r[|| d d< | rc| | d d< �n|dkr�|||d�| d< |ry|| d d< | r�d
� | �| d d < n�|dkr�||||d�| d< |r�|| d d< | r�| | d d< n�|dkr�|||d�| d< |r�|| d d< | r�d
� | �| d d < n�|dkr�||||d�| d< |r�|| d d< | r�| | d d< n�|dk�r|||d�| d< |r�|| d d< | �rd
� | �| d d < nt|dk�r,|||d�| d< |�r|| d d< | �r"| | d d< |
�r+|
| d d < nK|d k�rW||d �| d < |�rA|| d d< | �rMd
� | �| d d < |
�rV|
| d d < n |d k�rw||||d�| d!< |�rn|| d! d< | �rw| | d! d< | j�| j| �} | d" d# d$ } t| | | jj�S )%a�
Defines an ``IndexField``, either replacing an existing
definition or creating a new one.
:type field_name: string
:param field_name: The name of a field in the search index.
:type field_type: string
:param field_type: The type of field. Valid values are
int | double | literal | text | date | latlon |
int-array | double-array | literal-array | text-array | date-array
:type default: string or int
:param default: The default value for the field. If the
field is of type ``int`` this should be an integer value.
Otherwise, it's a string.
:type facet: bool
:param facet: A boolean to indicate whether facets
are enabled for this field or not. Does not apply to
fields of type ``int, int-array, text, text-array``.
:type returnable: bool
:param returnable: A boolean to indicate whether values
of this field can be returned in search results or
used in ranking.
:type searchable: bool
:param searchable: A boolean to indicate whether search
is enabled for this field or not.
:type sortable: bool
:param sortable: A boolean to indicate whether sorting
is enabled for this field or not. Does not apply to
fields of array types.
:type highlight: bool
:param highlight: A boolean to indicate whether highlighting
is enabled for this field or not. Does not apply to
fields of type ``double, int, date, latlon``
:type source_field: list of strings or string
:param source_field: For array types, this is the list of fields
to treat as the source. For singular types, pass a string only.
:type analysis_scheme: string
:param analysis_scheme: The analysis scheme to use for this field.
Only applies to ``text | text-array`` field types
:return: IndexFieldStatus objects
:rtype: :class:`boto.cloudsearch2.option.IndexFieldStatus` object
:raises: BaseException, InternalException, LimitExceededException,
InvalidTypeException, ResourceNotFoundException
)�IndexFieldName�IndexFieldType�literal)� FacetEnabled�
ReturnEnabled�
SearchEnabled� SortEnabled�LiteralOptions� DefaultValue� SourceFieldz
literal-array)ry rz r{ �LiteralArrayOptions�,� SourceFieldsrG )r~ ry rz r{ r| �
IntOptionsz int-array�IntArrayOptions�date� DateOptionsz
date-array�DateArrayOptions�double�
DoubleOptionsz double-array�DoubleArrayOptions�text)rz �HighlightEnabledr| � TextOptions�AnalysisSchemez
text-array)rz r� �TextArrayOptions�latlon�
LatLonOptions�DefineIndexFieldResponse�DefineIndexFieldResult�
IndexField)�joinr �define_index_fieldrJ r rr )
r �
field_name�
field_type�default�facet�
returnable�
searchable�sortable� highlight� source_field�analysis_scheme�indexr r r r �create_index_field� s =�
� �
�
��
� �
�
��
� �
�
��
� �
�
��
� �
�
� �
� ���zDomain.create_index_fieldc s8 �j j� � �j|�}|d d d }� �fdd�|D �S )z�
Return a list of rank expressions defined for this domain.
:return: list of ExpressionStatus objects
:rtype: list of :class:`boto.cloudsearch2.option.ExpressionStatus`
object
�DescribeExpressionsResponse�DescribeExpressionsResult� Expressionsc s g | ]}t �|� ��qS r r rn ��fnr r r rq � s z*Domain.get_expressions.<locals>.<listcomp>)r �describe_expressionsrJ )r �namesr r r� r �get_expressions� s ��zDomain.get_expressionsc C s2 | j �| j||�}|d d d }t| || j j�S )az
Create a new expression.
:type name: string
:param name: The name of an expression for processing
during a search request.
:type value: string
:param value: The expression to evaluate for ranking
or thresholding while processing a search request. The
Expression syntax is based on JavaScript expressions
and supports:
* Single value, sort enabled numeric fields (int, double, date)
* Other expressions
* The _score variable, which references a document's relevance
score
* The _time variable, which references the current epoch time
* Integer, floating point, hex, and octal literals
* Arithmetic operators: + - * / %
* Bitwise operators: | & ^ ~ << >> >>>
* Boolean operators (including the ternary operator): && || ! ?:
* Comparison operators: < <= == >= >
* Mathematical functions: abs ceil exp floor ln log2 log10 logn
max min pow sqrt pow
* Trigonometric functions: acos acosh asin asinh atan atan2 atanh
cos cosh sin sinh tanh tan
* The haversin distance function
Expressions always return an integer value from 0 to the maximum
64-bit signed integer value (2^63 - 1). Intermediate results are
calculated as double-precision floating point values and the return
value is rounded to the nearest integer. If the expression is
invalid or evaluates to a negative value, it returns 0. If the
expression evaluates to a value greater than the maximum, it
returns the maximum value.
The source data for an Expression can be the name of an
IndexField of type int or double, another Expression or the
reserved name _score. The _score source is
defined to return as a double from 0 to 10.0 (inclusive) to
indicate how relevant a document is to the search request,
taking into account repetition of search terms in the
document and proximity of search terms to each other in
each matching IndexField in the document.
For more information about using rank expressions to
customize ranking, see the Amazon CloudSearch Developer
Guide.
:return: ExpressionStatus object
:rtype: :class:`boto.cloudsearch2.option.ExpressionStatus` object
:raises: BaseException, InternalException, LimitExceededException,
InvalidTypeException, ResourceNotFoundException
�DefineExpressionResponse�DefineExpressionResult�
Expression)r �define_expressionrJ r r� )r rJ r r r r r �create_expression� s 9���zDomain.create_expressionc C �
t | d�S �N)�domainr r6 r r r �get_document_service �
zDomain.get_document_servicec C r� r� r r6 r r r �get_search_service r� zDomain.get_search_servicec C s
d| j S )Nz <Domain: %s>rI r6 r r r �__repr__ r� zDomain.__repr__r5 )ru FFFFFNN) �__name__�
__module__� __qualname__�__doc__r r �propertyr7 r< r> r' �setterr( r) r* r0 r- rJ rK rN rQ r\ rc ri rj rt r� r� r� r� r� r� r r r r r & sp '
�
GB r N)
� boto.cloudsearch2.optionstatusr r r r r �boto.cloudsearch2.documentr
�boto.cloudsearch2.searchr r �objectr r r r r �<module> s