Creates a reference to a property in a given SDK.
An SDK property is a String value derived from the SDKs that are used in a given operation. The task can be used in two ways. By directly referencing an SDK via Name and its property Identifier, or using as a compound value by specifying a Format string and its Arguments.
A property Identifier that specifies the property that is contained in the SDK.
SDK property references can be passed to tasks which support it. They are resolved against the SDKs which are also passed to the associated task as input.
SDK property references are not useful on their own and they should always be used with other SDK inputs. They can be used to specify inputs which are not directly part of the build execution but are installed in the supported build environment.
Summary
| Arguments | The input arguments for the Format parameter. |
| Format | The format of how the property value should be computed. |
| Identifier | Specifies the property Identifier in the SDK. |
| Name | Specifies the SDK name that the property should be resolved against. |
Parameters
Collection of SDKPropertyFormatArgument
The input arguments for the Format parameter.
If this parameter is specified, Format must be as well. Each argument can be other SDK property and path references. They will be evaluated and passed to the formatter as the input.
The format of how the property value should be computed.
The input for the formatter is the value of the Arguments parameter. If it is not specified, then the single argument will be passed to it based on Name and Identifier.
It is recommended to use the %s format placeholder for the arguments. Non-string inputs are automatically handled by the formatter.
A simple example for passing a formatted value with some version information:
sdk.property(Format: "-version=%s", Name: MySdk, Identifier: sdk.version)
Specifies the property Identifier in the SDK.
The specified Identifier will be used to retrieve the property from the associated SDK. The available supported identifiers are based on the associated SDK.