java.lang.Object
- org.gcube.informationsystem.resourceregistry.api.client.ResourceRegistryRequestOptions.Builder

Enclosing class:

ResourceRegistryRequestOptions
```
public static final class ResourceRegistryRequestOptions.Builder
extends Object
```
Builder for immutable per-request options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ResourceRegistryRequestOptions.Builder`	`addCustomHeader(String name, String value)`	Sets a value for a non-reserved custom header.
`ResourceRegistryRequestOptions`	`build()`
`ResourceRegistryRequestOptions.Builder`	`contextsPolicy(ContextsPolicy contextsPolicy)`
`ResourceRegistryRequestOptions.Builder`	`depth(Integer depth)`
`ResourceRegistryRequestOptions.Builder`	`dryRun(Boolean dryRun)`
`ResourceRegistryRequestOptions.Builder`	`hierarchical(Boolean hierarchical)`
`ResourceRegistryRequestOptions.Builder`	`lifecycle(ContextLifecycle lifecycle)`
`ResourceRegistryRequestOptions.Builder`	`limit(Integer limit)`
`ResourceRegistryRequestOptions.Builder`	`membershipScope(MembershipScope membershipScope)`
`ResourceRegistryRequestOptions.Builder`	`metadataPolicy(MetadataPolicy metadataPolicy)`
`ResourceRegistryRequestOptions.Builder`	`offset(Integer offset)`
`ResourceRegistryRequestOptions.Builder`	`polymorphic(Boolean polymorphic)`
`ResourceRegistryRequestOptions.Builder`	`preferReturn(PreferReturn preferReturn)`
`ResourceRegistryRequestOptions.Builder`	`propagationMode(PropagationMode propagationMode)`
`ResourceRegistryRequestOptions.Builder`	`sync(UUID context)`
`ResourceRegistryRequestOptions.Builder`	`sync(Sync sync)`

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

- Method Detail
  - limit
```
public ResourceRegistryRequestOptions.Builder limit(Integer limit)
```
    Parameters:
    
    limit - positive page size, -1, or null
    
    Returns:
    
    this builder
  - offset
```
public ResourceRegistryRequestOptions.Builder offset(Integer offset)
```
    Parameters:
    
    offset - non-negative offset, or null
    
    Returns:
    
    this builder
  - metadataPolicy
```
public ResourceRegistryRequestOptions.Builder metadataPolicy(MetadataPolicy metadataPolicy)
```
    Parameters:
    
    metadataPolicy - metadata projection
    
    Returns:
    
    this builder
  - hierarchical
```
public ResourceRegistryRequestOptions.Builder hierarchical(Boolean hierarchical)
```
    Parameters:
    
    hierarchical - whether supported reads include descendants
    
    Returns:
    
    this builder
  - contextsPolicy
```
public ResourceRegistryRequestOptions.Builder contextsPolicy(ContextsPolicy contextsPolicy)
```
    Parameters:
    
    contextsPolicy - where supported responses carry the membership map
    
    Returns:
    
    this builder
  - membershipScope
```
public ResourceRegistryRequestOptions.Builder membershipScope(MembershipScope membershipScope)
```
    Parameters:
    
    membershipScope - the Context boundary of the memberships listed by supported responses
    
    Returns:
    
    this builder
  - polymorphic
```
public ResourceRegistryRequestOptions.Builder polymorphic(Boolean polymorphic)
```
    Parameters:
    
    polymorphic - whether supported operations include subtypes
    
    Returns:
    
    this builder
  - depth
```
public ResourceRegistryRequestOptions.Builder depth(Integer depth)
```
    Parameters:
    
    depth - requested hierarchy depth
    
    Returns:
    
    this builder
  - lifecycle
```
public ResourceRegistryRequestOptions.Builder lifecycle(ContextLifecycle lifecycle)
```
    Parameters:
    
    lifecycle - requested Context lifecycle set
    
    Returns:
    
    this builder
  - propagationMode
```
public ResourceRegistryRequestOptions.Builder propagationMode(PropagationMode propagationMode)
```
    Parameters:
    
    propagationMode - requested structural propagation
    
    Returns:
    
    this builder
  - dryRun
```
public ResourceRegistryRequestOptions.Builder dryRun(Boolean dryRun)
```
    Parameters:
    
    dryRun - whether a supported mutation is simulated
    
    Returns:
    
    this builder
  - sync
```
public ResourceRegistryRequestOptions.Builder sync(Sync sync)
```
    Parameters:
    
    sync - the Contexts a Resource write reaches besides the token Context, or null
    
    Returns:
    
    this builder
  - sync
```
public ResourceRegistryRequestOptions.Builder sync(UUID context)
```
    Parameters:
    
    context - the one Context a Resource write reaches besides the token Context (sync=<UUID>), or null
    
    Returns:
    
    this builder
  - preferReturn
```
public ResourceRegistryRequestOptions.Builder preferReturn(PreferReturn preferReturn)
```
    Parameters:
    
    preferReturn - requested successful-response representation
    
    Returns:
    
    this builder
  - addCustomHeader
```
public ResourceRegistryRequestOptions.Builder addCustomHeader(String name,
                                                              String value)
```
    Sets a value for a non-reserved custom header. Header-name comparison is case-insensitive; setting the same name again replaces its previous value. Authentication headers are validated by the client against its active authorization provider.
    
    Parameters:
    
    name - header name
    
    value - header value
    
    Returns:
    
    this builder
  - build
```
public ResourceRegistryRequestOptions build()
```
    Returns:
    
    immutable request options

Class ResourceRegistryRequestOptions.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

limit

offset

metadataPolicy

hierarchical

contextsPolicy

membershipScope

polymorphic

depth

lifecycle

propagationMode

dryRun

sync

sync

preferReturn

addCustomHeader

build