Package org.gcube.informationsystem.resourceregistry.api.client

Class ResourceRegistryRequestOptions

java.lang.Object
org.gcube.informationsystem.resourceregistry.api.client.ResourceRegistryRequestOptions
public final class ResourceRegistryRequestOptions extends Object
Immutable per-invocation options shared by the Resource Registry Java clients.
Author:
Luca Frosini (ISTI - CNR)

  • Method Details

    • defaults

      public static ResourceRegistryRequestOptions defaults()
      Returns:
      an options object in which every value is omitted

    • builder

      public static ResourceRegistryRequestOptions.Builder builder()
      Returns:
      a new options builder

    • limit

      public Integer limit()
      Returns:
      explicit limit, or null when omitted

    • offset

      public Integer offset()
      Returns:
      explicit offset, or null when omitted

    • metadataPolicy

      public MetadataPolicy metadataPolicy()
      Returns:
      explicit metadata policy, or null when omitted

    • hierarchical

      public Boolean hierarchical()
      Returns:
      explicit hierarchical mode, or null when omitted

    • contextsPolicy

      public ContextsPolicy contextsPolicy()
      Returns:
      explicit contexts policy, or null when omitted

    • membershipScope

      public MembershipScope membershipScope()
      Returns:
      explicit membership scope, or null when omitted

    • polymorphic

      public Boolean polymorphic()
      Returns:
      explicit polymorphic mode, or null when omitted

    • depth

      public Integer depth()
      Returns:
      explicit hierarchy depth, or null when omitted

    • lifecycle

      public ContextLifecycle lifecycle()
      Returns:
      explicit Context lifecycle selection, or null when omitted

    • propagationMode

      public PropagationMode propagationMode()
      Returns:
      explicit propagation mode, or null when omitted

    • dryRun

      public Boolean dryRun()
      Returns:
      explicit dry-run mode, or null when omitted

    • sync

      public String sync()
      Returns:
      explicit sync wire value (Sync value or Context UUID), or null when omitted

    • preferReturn

      public PreferReturn preferReturn()
      Returns:
      explicit Prefer return mode, or null when omitted

    • customHeaders

      public Map<String,List<String>> customHeaders()
      Returns:
      immutable, case-preserving, multi-valued custom headers

    • queryParameters

      public Map<String,String> queryParameters()
      Returns the explicitly configured options as wire-level query parameters. Callers must set only options supported by the operation being executed.
      Returns:
      immutable query-parameter map