SpatialSpec (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.cosmos.models.SpatialSpec

public final class SpatialSpec
extends Object

The SpatialSpec model.

Constructor Summary

Constructors
Constructor Description

SpatialSpec()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`path()`	Get the path property: The path for which the indexing behavior applies to.
`List<SpatialType>`	`types()`	Get the types property: List of path's spatial type.
`void`	`validate()`	Validates the instance.
`SpatialSpec`	`withPath(String path)`	Set the path property: The path for which the indexing behavior applies to.
`SpatialSpec`	`withTypes(List<SpatialType> types)`	Set the types property: List of path's spatial type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpatialSpec
```
public SpatialSpec()
```
- Method Detail
  - path
```
public String path()
```
    Get the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
    
    Returns:
    
    the path value.
  - withPath
```
public SpatialSpec withPath(String path)
```
    Set the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
    
    Parameters:
    
    path - the path value to set.
    
    Returns:
    
    the SpatialSpec object itself.
  - types
```
public List<SpatialType> types()
```
    Get the types property: List of path's spatial type.
    
    Returns:
    
    the types value.
  - withTypes
```
public SpatialSpec withTypes(List<SpatialType> types)
```
    Set the types property: List of path's spatial type.
    
    Parameters:
    
    types - the types value to set.
    
    Returns:
    
    the SpatialSpec object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.