Package jetbrains.buildServer.clouds

Interface CloudProfile

  • All Known Implementing Classes:
    CloudProfileImpl
    public interface CloudProfile
    Parameters of cloud profile that used in TeamCity.
    Since:
    5.0

    • Method Detail

      • getProfileId

        @NotNull
String getProfileId()
        Abstract identifier. Unique in the buildserver runtime instance scope.
        Returns:
        the profile identifier

      • getProjectId

        @NotNull
String getProjectId()
        Internal id of project containing that profile
        Returns:
        internal id of project containing that profile
        Since:
        2017.1

      • getProfileName

        @NotNull
String getProfileName()
        User defined profile name
        Returns:
        name.

      • getDescription

        @NotNull
String getDescription()
        User's comment for the profile.
        Returns:
        description

      • profileDescription

        @NotNull
@Deprecated
String profileDescription()
        Deprecated.
        use #toString()

      • getTerminateIdleTime

        @Nullable
Long getTerminateIdleTime()
        Time to wait before idle agent is terminated
        Returns:
        Time to wait before idle agent is terminated

      • isEnabled

        boolean isEnabled()
        Indicates whether the profile is enabled
        Returns:
        true, when profile is enabled. False otherwise

      • getProfileProperties

        @NotNull
Map<String,​String> getProfileProperties()
        returns all profile-level properties as map
        Returns:
        see above
        Since:
        2017.1

      • getParameters

        @NotNull
CloudClientParameters getParameters()
        Cloud implementation specific parameters
        Returns:
        connection parameters