Class ReaderCreateParams.Builder

  • Enclosing class:
    ReaderCreateParams

    public static class ReaderCreateParams.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • build

        public ReaderCreateParams build()
        Finalize and obtain parameter instance from this builder.
      • addExpand

        public ReaderCreateParams.Builder addExpand​(java.lang.String element)
        Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ReaderCreateParams.expand for the field documentation.
      • addAllExpand

        public ReaderCreateParams.Builder addAllExpand​(java.util.List<java.lang.String> elements)
        Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ReaderCreateParams.expand for the field documentation.
      • putExtraParam

        public ReaderCreateParams.Builder putExtraParam​(java.lang.String key,
                                                        java.lang.Object value)
        Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ReaderCreateParams.extraParams for the field documentation.
      • putAllExtraParam

        public ReaderCreateParams.Builder putAllExtraParam​(java.util.Map<java.lang.String,​java.lang.Object> map)
        Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ReaderCreateParams.extraParams for the field documentation.
      • setLabel

        public ReaderCreateParams.Builder setLabel​(java.lang.String label)
        Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
      • setLocation

        public ReaderCreateParams.Builder setLocation​(java.lang.String location)
        The location to assign the reader to.
      • putMetadata

        public ReaderCreateParams.Builder putMetadata​(java.lang.String key,
                                                      java.lang.String value)
        Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ReaderCreateParams.metadata for the field documentation.
      • putAllMetadata

        public ReaderCreateParams.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.String> map)
        Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ReaderCreateParams.metadata for the field documentation.
      • setMetadata

        public ReaderCreateParams.Builder setMetadata​(EmptyParam metadata)
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
      • setMetadata

        public ReaderCreateParams.Builder setMetadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
      • setRegistrationCode

        public ReaderCreateParams.Builder setRegistrationCode​(java.lang.String registrationCode)
        A code generated by the reader used for registering to an account.