saker.sdk.support Documentation TaskDoc JavaDoc Packages
public interface UserSDKDescription extends SDKDescription
SDKDescription that encloses a predefined set of paths and properties.

An user SDK description is a fixed set of paths and properties for the defined identifiers. It also contains an environment qualifier that specifies the environment for which the SDK is defined for.

Using user SDKs may cause tasks use only build environments that the environment qualifier deems suitable. This may cause remote dispatchable tasks to not use build clusters, or tasks that are not remote dispatchable to fail.

Clients shouldn't implement this interface.

Use create(EnvironmentQualifier, Map<String, SakerPath>, Map<String, String>) to create a new instance.

Methods
public default void
Accepts a visitor and calls an appropriate visit method on it.
public static UserSDKDescription
create(EnvironmentQualifier qualifier, Map<String, SakerPath> paths, Map<String, String> properties)
Creates a new SDK description for the specified properties.
public static SDKReference
Creates a new SDKReference for the given paths and properties.
public Map<String, SakerPath>
Gets the paths mapped to their identifiers for this SDK.
public Map<String, String>
Gets the properties mapped to their identifiers for this SDK.
public EnvironmentQualifier
Gets the qualifier for this user SDK.
Inherited methods
public default void accept(SDKDescriptionVisitor visitor)
Overridden from: SDKDescription
Accepts a visitor and calls an appropriate visit method on it.
visitorThe visitor.
public static UserSDKDescription create(EnvironmentQualifier qualifier, Map<String, SakerPath> paths, Map<String, String> properties)
Creates a new SDK description for the specified properties.

If any of the Map arguments are null, an empty map is used in place of them.

qualifierThe environment qualifier.
pathsThe SDK paths.
propertiesThe SDK properties.
The created SDK description.
public static SDKReference createSDKReference(Map<String, SakerPath> paths, Map<String, String> properties)
Creates a new SDKReference for the given paths and properties.
pathsThe SDK paths.
propertiesThe SDK properties
The created SDK reference.
public abstract Map<String, SakerPath> getPaths()
Gets the paths mapped to their identifiers for this SDK.
The paths for the associated identifiers.
public abstract Map<String, String> getProperties()
Gets the properties mapped to their identifiers for this SDK.
The properties for the associated identifiers.
Gets the qualifier for this user SDK.

The returned qualifier may be null, in which case the user SDK should be interpreted to be associated with the local environment.

The qualifier or null if only the local environment should be used.