java.lang.Object
- org.gcube.informationsystem.resourceregistry.api.rest.InstancePath

```
public class InstancePath
extends Object
```
The Class InstancePath.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER`	When `true` on Add to Context, waives destination containment so that IS-Manager, Infrastructure-Manager and IS-Admin can target any live Context instead of only the token Context subtree and its siblings.
`static String`	`BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER` query parameter (`"false"`).
`static String`	`CONTEXTS_PATH_PART`	The path part used for instance Context membership sub-resources.
`static String`	`CONTEXTS_POLICY_QUERY_PARAMETER`	Canonical query parameter controlling where `contexts` membership maps appear.
`static String`	`CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `CONTEXTS_POLICY_QUERY_PARAMETER` query parameter.
`static String`	`DRY_RUN_QUERY_PARAMETER`	When `true`, the operation is simulated and not persisted to the database.
`static String`	`DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `DRY_RUN_QUERY_PARAMETER` query parameter (`"false"`).
`static String`	`HIERARCHICAL_MODE_QUERY_PARAMETER`	The Constant HIERARCHICAL_MODE_QUERY_PARAMETER.
`static String`	`HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `HIERARCHICAL_MODE_QUERY_PARAMETER` query parameter (`"false"`).
`static String`	`INSTANCES_PATH_PART`	The Constant INSTANCES_PATH_PART.
`static String`	`LIMIT_QUERY_PARAMETER`	The Constant LIMIT_QUERY_PARAMETER.
`static int`	`LIMIT_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `LIMIT_QUERY_PARAMETER` query parameter (`10`).
`static String`	`MEMBERSHIP_SCOPE_QUERY_PARAMETER`	Canonical query parameter selecting the Context boundary of `contexts` membership maps.
`static String`	`MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `MEMBERSHIP_SCOPE_QUERY_PARAMETER` query parameter.
`static String`	`METADATA_POLICY_QUERY_PARAMETER`	Canonical query parameter controlling metadata inclusion strategy.
`static String`	`METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `METADATA_POLICY_QUERY_PARAMETER` query parameter.
`static String`	`OFFSET_QUERY_PARAMETER`	The Constant OFFSET_QUERY_PARAMETER.
`static int`	`OFFSET_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `OFFSET_QUERY_PARAMETER` query parameter (`0`).
`static String`	`POLYMORPHIC_QUERY_PARAMETER`	The Constant POLYMORPHIC_QUERY_PARAMETER.
`static String`	`POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `POLYMORPHIC_QUERY_PARAMETER` query parameter (`"true"`).
`static String`	`PROPAGATION_MODE_QUERY_PARAMETER`	Controls how the avalanche effect propagates when adding an instance to a Context.
`static String`	`PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `PROPAGATION_MODE_QUERY_PARAMETER` query parameter (derived from `PropagationMode.DEFAULT`).
`static String`	`SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER`	Deprecated.
`static String`	`SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE`	Deprecated.
`static String`	`SYNC_QUERY_PARAMETER`	The Contexts a write of a Resource reaches besides the token Context, on `POST /instances/{type}` and `PUT /instances/{type}/{uuid}`: one of the `Sync` values or the UUID of a Context.
`static String`	`SYNC_QUERY_PARAMETER_DEFAULT_VALUE`	Default value for the `SYNC_QUERY_PARAMETER` query parameter (`"none"`).

Constructor Summary

Constructors
Constructor Description

InstancePath()

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

- Field Detail
  - INSTANCES_PATH_PART
```
public static final String INSTANCES_PATH_PART
```
    The Constant INSTANCES_PATH_PART.
    
    See Also:
    
    Constant Field Values
  - CONTEXTS_PATH_PART
```
public static final String CONTEXTS_PATH_PART
```
    The path part used for instance Context membership sub-resources.
    
    See Also:
    
    Constant Field Values
  - LIMIT_QUERY_PARAMETER
```
public static final String LIMIT_QUERY_PARAMETER
```
    The Constant LIMIT_QUERY_PARAMETER.
    
    See Also:
    
    Constant Field Values
  - LIMIT_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final int LIMIT_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the LIMIT_QUERY_PARAMETER query parameter (10).
    
    See Also:
    
    Constant Field Values
  - OFFSET_QUERY_PARAMETER
```
public static final String OFFSET_QUERY_PARAMETER
```
    The Constant OFFSET_QUERY_PARAMETER.
    
    See Also:
    
    Constant Field Values
  - OFFSET_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final int OFFSET_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the OFFSET_QUERY_PARAMETER query parameter (0).
    
    See Also:
    
    Constant Field Values
  - POLYMORPHIC_QUERY_PARAMETER
```
public static final String POLYMORPHIC_QUERY_PARAMETER
```
    The Constant POLYMORPHIC_QUERY_PARAMETER.
    
    See Also:
    
    Constant Field Values
  - POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the POLYMORPHIC_QUERY_PARAMETER query parameter ("true").
    
    See Also:
    
    Constant Field Values
  - HIERARCHICAL_MODE_QUERY_PARAMETER
```
public static final String HIERARCHICAL_MODE_QUERY_PARAMETER
```
    The Constant HIERARCHICAL_MODE_QUERY_PARAMETER.
    
    See Also:
    
    Constant Field Values
  - HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the HIERARCHICAL_MODE_QUERY_PARAMETER query parameter ("false").
    
    See Also:
    
    Constant Field Values
  - METADATA_POLICY_QUERY_PARAMETER
```
public static final String METADATA_POLICY_QUERY_PARAMETER
```
    Canonical query parameter controlling metadata inclusion strategy. Accepted values are derived from MetadataPolicy.
    
    See Also:
    
    Constant Field Values
  - METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the METADATA_POLICY_QUERY_PARAMETER query parameter.
    
    See Also:
    
    Constant Field Values
  - CONTEXTS_POLICY_QUERY_PARAMETER
```
public static final String CONTEXTS_POLICY_QUERY_PARAMETER
```
    Canonical query parameter controlling where contexts membership maps appear. Accepted values are derived from ContextsPolicy.
    
    See Also:
    
    Constant Field Values
  - CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the CONTEXTS_POLICY_QUERY_PARAMETER query parameter.
    
    See Also:
    
    Constant Field Values
  - MEMBERSHIP_SCOPE_QUERY_PARAMETER
```
public static final String MEMBERSHIP_SCOPE_QUERY_PARAMETER
```
    Canonical query parameter selecting the Context boundary of contexts membership maps. Accepted values are derived from MembershipScope.
    
    See Also:
    
    Constant Field Values
  - MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the MEMBERSHIP_SCOPE_QUERY_PARAMETER query parameter.
    
    See Also:
    
    Constant Field Values
  - PROPAGATION_MODE_QUERY_PARAMETER
```
public static final String PROPAGATION_MODE_QUERY_PARAMETER
```
    Controls how the avalanche effect propagates when adding an instance to a Context. Accepted values: surgical (restricted to IS-Manager, Infrastructure-Manager and IS-Admin), shallow (default), deep.
    
    See Also:
    
    Constant Field Values
  - PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the PROPAGATION_MODE_QUERY_PARAMETER query parameter (derived from PropagationMode.DEFAULT).
    
    See Also:
    
    Constant Field Values
  - BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER
```
public static final String BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER
```
    When true on Add to Context, waives destination containment so that IS-Manager, Infrastructure-Manager and IS-Admin can target any live Context instead of only the token Context subtree and its siblings. It never changes the source lookup.
    
    See Also:
    
    Constant Field Values
  - BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER query parameter ("false").
    
    See Also:
    
    Constant Field Values
  - SYNC_QUERY_PARAMETER
```
public static final String SYNC_QUERY_PARAMETER
```
    The Contexts a write of a Resource reaches besides the token Context, on POST /instances/{type} and PUT /instances/{type}/{uuid}: one of the Sync values or the UUID of a Context.
    
    See Also:
    
    Constant Field Values
  - SYNC_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String SYNC_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the SYNC_QUERY_PARAMETER query parameter ("none").
    
    See Also:
    
    Constant Field Values
  - SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER
```
@Deprecated
public static final String SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER
```
    Deprecated.
    
    Not read by the Resource Registry 6.0.0 on a write, which ignores it with an X-Warning: use SYNC_QUERY_PARAMETER with Sync.EXISTING.
    
    See Also:
    
    Constant Field Values
  - SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE
```
@Deprecated
public static final String SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE
```
    Deprecated.
    
    Not read by the Resource Registry 6.0.0 on a write, which ignores it with an X-Warning: use SYNC_QUERY_PARAMETER with Sync.EXISTING.
    
    See Also:
    
    Constant Field Values
  - DRY_RUN_QUERY_PARAMETER
```
public static final String DRY_RUN_QUERY_PARAMETER
```
    When true, the operation is simulated and not persisted to the database.
    
    See Also:
    
    Constant Field Values
  - DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE
```
public static final String DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE
```
    Default value for the DRY_RUN_QUERY_PARAMETER query parameter ("false").
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InstancePath
```
public InstancePath()
```

Class InstancePath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCES_PATH_PART

CONTEXTS_PATH_PART

LIMIT_QUERY_PARAMETER

LIMIT_QUERY_PARAMETER_DEFAULT_VALUE

OFFSET_QUERY_PARAMETER

OFFSET_QUERY_PARAMETER_DEFAULT_VALUE

POLYMORPHIC_QUERY_PARAMETER

POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE

HIERARCHICAL_MODE_QUERY_PARAMETER

HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE

METADATA_POLICY_QUERY_PARAMETER

METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE

CONTEXTS_POLICY_QUERY_PARAMETER

CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE

MEMBERSHIP_SCOPE_QUERY_PARAMETER

MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE

PROPAGATION_MODE_QUERY_PARAMETER

PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE

BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER

BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE

SYNC_QUERY_PARAMETER

SYNC_QUERY_PARAMETER_DEFAULT_VALUE

SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER

SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE

DRY_RUN_QUERY_PARAMETER

DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE

Constructor Detail

InstancePath