config.io_helidon_common_configurable_Resource.adoc Maven / Gradle / Ivy

Go to download
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 Oracle and/or its affiliates.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.common.configurable.Resource
:keywords: helidon, config, io.helidon.common.configurable.Resource
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.common.configurable.Resource
include::{rootdir}/includes/attributes.adoc[]

= Resource (common.configurable) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/configurable/Resource.html[io.helidon.common.configurable.Resource]




== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`content` |string |{nbsp} |Binary content of the resource (base64 encoded).

 @return binary content
|`content-plain` |string |{nbsp} |Plain content of the resource (text).

 @return plain content
|`description` |string |{nbsp} |Description of this resource when configured through plain text or binary.

 @return description
|`path` |Path |{nbsp} |Resource is located on filesystem.

 @return path of the resource
|`proxy-host` |string |{nbsp} |Host of the proxy when using URI.

 @return proxy host
|`proxy-port` |int |`80` |Port of the proxy when using URI.

 @return proxy port
|`resource-path` |string |{nbsp} |Resource is located on classpath.

 @return classpath location of the resource
|`uri` |URI |{nbsp} |Resource is available on a java.net.URI.

 @return of the resource
 @see #proxy()
 @see #useProxy()
|`use-proxy` |boolean |`true` |Whether to use proxy. If set to `false`, proxy will not be used even if configured.
 When set to `true` (default), proxy will be used if configured.

 @return whether to use proxy if configured

|===

// end::config[]