-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.core.util.ConfigurationBuilder.yml
120 lines (120 loc) · 13.1 KB
/
com.azure.core.util.ConfigurationBuilder.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
### YamlMime:JavaType
uid: "com.azure.core.util.ConfigurationBuilder"
fullName: "com.azure.core.util.ConfigurationBuilder"
name: "ConfigurationBuilder"
nameWithType: "ConfigurationBuilder"
summary: "Builds <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> with external source."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ConfigurationBuilder**"
constructors:
- uid: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder()"
fullName: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder()"
name: "ConfigurationBuilder()"
nameWithType: "ConfigurationBuilder.ConfigurationBuilder()"
summary: "Creates `ConfigurationBuilder`."
syntax: "public ConfigurationBuilder()"
desc: "Creates `ConfigurationBuilder`.\n\n```java\nconfiguration = new ConfigurationBuilder()\n .putProperty(\"azure.sdk.client-name.connection-string\", \"...\")\n .root(\"azure.sdk\")\n .buildSection(\"client-name\");\n\n ConfigurationProperty<String> connectionStringProperty = ConfigurationPropertyBuilder.ofString(\"connection-string\")\n .build();\n\n System.out.println(configuration.get(connectionStringProperty));\n```"
- uid: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder(com.azure.core.util.ConfigurationSource)"
fullName: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder(ConfigurationSource source)"
name: "ConfigurationBuilder(ConfigurationSource source)"
nameWithType: "ConfigurationBuilder.ConfigurationBuilder(ConfigurationSource source)"
summary: "Creates `ConfigurationBuilder` with configuration source."
parameters:
- description: "Custom <xref uid=\"com.azure.core.util.ConfigurationSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSource\"></xref> containing known Azure SDK configuration properties."
name: "source"
type: "<xref href=\"com.azure.core.util.ConfigurationSource?alt=com.azure.core.util.ConfigurationSource&text=ConfigurationSource\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConfigurationBuilder(ConfigurationSource source)"
desc: "Creates `ConfigurationBuilder` with configuration source.\n\n```java\nConfiguration configuration = new ConfigurationBuilder(new SampleSource(properties))\n .root(\"azure.sdk\")\n .buildSection(\"client-name\");\n\n ConfigurationProperty<String> proxyHostnameProperty = ConfigurationPropertyBuilder.ofString(\"http.proxy.hostname\")\n .shared(true)\n .build();\n System.out.println(configuration.get(proxyHostnameProperty));\n```"
- uid: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder(com.azure.core.util.ConfigurationSource,com.azure.core.util.ConfigurationSource,com.azure.core.util.ConfigurationSource)"
fullName: "com.azure.core.util.ConfigurationBuilder.ConfigurationBuilder(ConfigurationSource source, ConfigurationSource systemPropertiesConfigurationSource, ConfigurationSource environmentConfigurationSource)"
name: "ConfigurationBuilder(ConfigurationSource source, ConfigurationSource systemPropertiesConfigurationSource, ConfigurationSource environmentConfigurationSource)"
nameWithType: "ConfigurationBuilder.ConfigurationBuilder(ConfigurationSource source, ConfigurationSource systemPropertiesConfigurationSource, ConfigurationSource environmentConfigurationSource)"
summary: "Creates `ConfigurationBuilder` with configuration sources for explicit configuration, system properties and environment configuration sources."
parameters:
- description: "Custom <xref uid=\"com.azure.core.util.ConfigurationSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSource\"></xref> containing known Azure SDK configuration properties"
name: "source"
type: "<xref href=\"com.azure.core.util.ConfigurationSource?alt=com.azure.core.util.ConfigurationSource&text=ConfigurationSource\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.azure.core.util.ConfigurationSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSource\"></xref> containing known Azure SDK system\n properties."
name: "systemPropertiesConfigurationSource"
type: "<xref href=\"com.azure.core.util.ConfigurationSource?alt=com.azure.core.util.ConfigurationSource&text=ConfigurationSource\" data-throw-if-not-resolved=\"False\" />"
- description: "<xref uid=\"com.azure.core.util.ConfigurationSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSource\"></xref> containing known Azure SDK environment\n variables."
name: "environmentConfigurationSource"
type: "<xref href=\"com.azure.core.util.ConfigurationSource?alt=com.azure.core.util.ConfigurationSource&text=ConfigurationSource\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConfigurationBuilder(ConfigurationSource source, ConfigurationSource systemPropertiesConfigurationSource, ConfigurationSource environmentConfigurationSource)"
desc: "Creates `ConfigurationBuilder` with configuration sources for explicit configuration, system properties and environment configuration sources. Use this constructor to customize known Azure SDK system properties and environment variables retrieval."
methods:
- uid: "com.azure.core.util.ConfigurationBuilder.build()"
fullName: "com.azure.core.util.ConfigurationBuilder.build()"
name: "build()"
nameWithType: "ConfigurationBuilder.build()"
summary: "Builds root <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> section."
syntax: "public Configuration build()"
desc: "Builds root <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> section. Use it for shared properties only. To read client-specific configuration, use <xref uid=\"com.azure.core.util.ConfigurationBuilder.buildSection(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationBuilder#buildSection(String)\"></xref> which can read per-client and shared properties.\n\n```java\n// Builds shared Configuration only.\n Configuration sharedConfiguration = new ConfigurationBuilder(new SampleSource(properties))\n .root(\"azure.sdk\")\n .build();\n```"
returns:
description: "Root <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> with shared properties."
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.ConfigurationBuilder.buildSection(java.lang.String)"
fullName: "com.azure.core.util.ConfigurationBuilder.buildSection(String path)"
name: "buildSection(String path)"
nameWithType: "ConfigurationBuilder.buildSection(String path)"
summary: "Builds <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> section that supports retrieving properties from client-specific section with fallback to root section for properties that can be shared between clients."
parameters:
- description: "relative path from <xref uid=\"com.azure.core.util.ConfigurationBuilder.root(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationBuilder#root(String)\"></xref> to client section."
name: "path"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Configuration buildSection(String path)"
desc: "Builds <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> section that supports retrieving properties from client-specific section with fallback to root section for properties that can be shared between clients.\n\n```java\n// Builds Configuration for <client-name> with fallback to shared properties.\n configuration = new ConfigurationBuilder(new SampleSource(properties))\n .root(\"azure.sdk\")\n .buildSection(\"client-name\");\n```"
returns:
description: "Client <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> capable of reading client-specific and shared properties."
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.ConfigurationBuilder.putProperty(java.lang.String,java.lang.String)"
fullName: "com.azure.core.util.ConfigurationBuilder.putProperty(String name, String value)"
name: "putProperty(String name, String value)"
nameWithType: "ConfigurationBuilder.putProperty(String name, String value)"
summary: "Adds property to the configuration source."
parameters:
- description: "Property name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Property value."
name: "value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ConfigurationBuilder putProperty(String name, String value)"
desc: "Adds property to the configuration source. In case the source already contains property with the same name, the value will be overwritten with the new value passed.\n\n```java\nconfiguration = new ConfigurationBuilder()\n .putProperty(\"azure.sdk.client-name.connection-string\", \"...\")\n .root(\"azure.sdk\")\n .buildSection(\"client-name\");\n\n ConfigurationProperty<String> connectionStringProperty = ConfigurationPropertyBuilder.ofString(\"connection-string\")\n .build();\n\n System.out.println(configuration.get(connectionStringProperty));\n```"
returns:
description: "<code>ConfigurationBuilder</code> instance for chaining."
type: "<xref href=\"com.azure.core.util.ConfigurationBuilder?alt=com.azure.core.util.ConfigurationBuilder&text=ConfigurationBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.ConfigurationBuilder.root(java.lang.String)"
fullName: "com.azure.core.util.ConfigurationBuilder.root(String rootPath)"
name: "root(String rootPath)"
nameWithType: "ConfigurationBuilder.root(String rootPath)"
summary: "Sets path to root configuration properties where shared Azure SDK properties are defined."
parameters:
- description: "absolute root path, can be <code>null</code>."
name: "rootPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ConfigurationBuilder root(String rootPath)"
desc: "Sets path to root configuration properties where shared Azure SDK properties are defined. When local per-client property is missing, <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> falls back to shared properties.\n\n```java\nConfiguration configuration = new ConfigurationBuilder(new SampleSource(properties))\n .root(\"azure.sdk\")\n .buildSection(\"client-name\");\n\n ConfigurationProperty<String> proxyHostnameProperty = ConfigurationPropertyBuilder.ofString(\"http.proxy.hostname\")\n .shared(true)\n .build();\n System.out.println(configuration.get(proxyHostnameProperty));\n```"
returns:
description: "<code>ConfigurationBuilder</code> instance for chaining."
type: "<xref href=\"com.azure.core.util.ConfigurationBuilder?alt=com.azure.core.util.ConfigurationBuilder&text=ConfigurationBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Builds <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> with external source."
metadata: {}
package: "com.azure.core.util"
artifact: com.azure:azure-core:1.49.1