# PropertyDefinedNode

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/ast/query/PropertyDefinedNode.java+class:androidx.appsearch.ast.query.PropertyDefinedNode) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
@ExperimentalAppSearchApi
class PropertyDefinedNode : FunctionNode
```

<br />

*** ** * ** ***

`https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode` representing the \`propertyDefined\` query function.

The \`propertyDefined\` query function will return all documents of types that define the given property. This will include documents that do not have the property itself, so long as that property is a part of the document's schema.

If you need to restrict to documents that have \>=1 value(s) populated for that property, see `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/HasPropertyNode`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#PropertyDefinedNode(androidx.appsearch.app.PropertyPath)(propertyPath: https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath)` Constructor for a `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode` representing the query function \`propertyDefined\` that takes in a `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath`. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#equals(java.lang.Object)(o: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html!)` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#getFunctionName()()` Returns the name of the function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#getPropertyPath()()` Returns the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath` representing the property being checked for in the document. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#hashCode()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#setPropertyPath(androidx.appsearch.app.PropertyPath)(property: https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath)` Sets the property being checked for in the document, as represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode#toString()()` Get the string representation of `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`. |

| ### Inherited Constants |
|---|
| From [androidx.appsearch.ast.FunctionNode](https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode) |---|---| | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode#FUNCTION_NAME_GET_SEARCH_STRING_PARAMETER() = "getSearchStringParameter"` Name of the query function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/GetSearchStringParameterNode`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode#FUNCTION_NAME_HAS_PROPERTY() = "hasProperty"` Name of the query function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/HasPropertyNode`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode#FUNCTION_NAME_PROPERTY_DEFINED() = "propertyDefined"` Name of the query function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode#FUNCTION_NAME_SEARCH() = "search"` Name of the query function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/SearchNode`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/FunctionNode#FUNCTION_NAME_SEMANTIC_SEARCH() = "semanticSearch"` Name of the query function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/SemanticSearchNode`. | |

| ### Inherited functions |
|---|
| From [androidx.appsearch.ast.Node](https://developer.android.com/reference/kotlin/androidx/appsearch/ast/Node) |---|---| | `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/appsearch/ast/Node!>` | `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/Node#getChildren()()` Get a list of the node's child `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/Node`s. | |

## Public constructors

### PropertyDefinedNode

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
PropertyDefinedNode(propertyPath: PropertyPath)
```

Constructor for a `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode` representing the query function \`propertyDefined\` that takes in a `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath`.

## Public functions

### equals

```
fun equals(o: Any!): Boolean
```

### getFunctionName

```
fun getFunctionName(): String
```

Returns the name of the function represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`.

### getPropertyPath

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getPropertyPath(): PropertyPath
```

Returns the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/PropertyPath` representing the property being checked for in the document.

### hashCode

```
fun hashCode(): Int
```

### setPropertyPath

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun setPropertyPath(property: PropertyPath): Unit
```

Sets the property being checked for in the document, as represented by `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`.

### toString

```
fun toString(): String
```

Get the string representation of `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode`.

The string representation of `https://developer.android.com/reference/kotlin/androidx/appsearch/ast/query/PropertyDefinedNode` is the function name followed by the property path in quotes surrounded by parentheses.