mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
starting point for adding python sdk docs
This commit is contained in:
36
docs/tools/sdk/python/Reference/V3/Models/InnerHit.md
Normal file
36
docs/tools/sdk/python/Reference/V3/Models/InnerHit.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: inner-hit
|
||||
title: InnerHit
|
||||
pagination_label: InnerHit
|
||||
sidebar_label: InnerHit
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'InnerHit', 'InnerHit']
|
||||
slug: /tools/sdk/python/v3/models/inner-hit
|
||||
tags: ['SDK', 'Software Development Kit', 'InnerHit', 'InnerHit']
|
||||
---
|
||||
|
||||
# InnerHit
|
||||
|
||||
Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**query** | **str** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required]
|
||||
**type** | **str** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v3.models.inner_hit import InnerHit
|
||||
|
||||
inner_hit = InnerHit(
|
||||
query='source.name:\"Active Directory\"',
|
||||
type='access'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user