Package com.yahoo.config.application.api

Class DeploymentInstanceSpec

  • public class DeploymentInstanceSpec
extends DeploymentSpec.Step
    The deployment spec for an application instance
    Author:
    bratseth

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.yahoo.config.provision.AthenzDomain> athenzDomain()
      Returns the athenz domain if configured
      java.util.Optional<com.yahoo.config.provision.AthenzService> athenzService​(com.yahoo.config.provision.Environment environment, com.yahoo.config.provision.RegionName region)
      Returns the athenz service for environment/region if configured
      boolean canChangeRevisionAt​(java.time.Instant instant)
      Returns whether an application revision change for these instances can occur at the given instant
      boolean canUpgradeAt​(java.time.Instant instant)
      Returns whether the instances in this step can upgrade at the given instant
      java.util.List<DeploymentSpec.ChangeBlocker> changeBlocker()
      Returns time windows where upgrades are disallowed for these instances
      java.time.Duration delay()
      The delay introduced by this step (beyond the time it takes to execute the step).
      boolean deploysTo​(com.yahoo.config.provision.Environment environment, java.util.Optional<com.yahoo.config.provision.RegionName> region)
      Returns whether this deployment spec specifies the given zone, either implicitly or explicitly
      java.util.List<Endpoint> endpoints()
      Returns the rotations configuration of these instances
      boolean equals​(java.lang.Object o)  
      java.util.Optional<java.lang.String> globalServiceId()
      Returns the ID of the service to expose through global routing, if present
      int hashCode()  
      boolean includes​(com.yahoo.config.provision.Environment environment, java.util.Optional<com.yahoo.config.provision.RegionName> region)
      Returns whether this instances deployment specifies the given zone, either implicitly or explicitly
      com.yahoo.config.provision.InstanceName name()  
      Notifications notifications()
      Returns the notification configuration of these instances
      java.util.List<DeploymentSpec.Step> steps()
      Returns the deployment steps inside this in the order they will be performed
      java.lang.String toString()  
      DeploymentSpec.UpgradePolicy upgradePolicy()
      Returns the upgrade policy of this, which is defaultPolicy if none is specified
      java.util.List<DeploymentSpec.DeclaredZone> zones()
      Returns all the deployment steps which are zones in the order they are declared

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DeploymentInstanceSpec

        public DeploymentInstanceSpec​(com.yahoo.config.provision.InstanceName name,
                              java.util.List<DeploymentSpec.Step> steps,
                              DeploymentSpec.UpgradePolicy upgradePolicy,
                              java.util.List<DeploymentSpec.ChangeBlocker> changeBlockers,
                              java.util.Optional<java.lang.String> globalServiceId,
                              java.util.Optional<com.yahoo.config.provision.AthenzDomain> athenzDomain,
                              java.util.Optional<com.yahoo.config.provision.AthenzService> athenzService,
                              Notifications notifications,
                              java.util.List<Endpoint> endpoints)

    • Method Detail

      • name

        public com.yahoo.config.provision.InstanceName name()

      • delay

        public java.time.Duration delay()
        Description copied from class: DeploymentSpec.Step
        The delay introduced by this step (beyond the time it takes to execute the step). Default is zero.
        Overrides:
        delay in class DeploymentSpec.Step

      • upgradePolicy

        public DeploymentSpec.UpgradePolicy upgradePolicy()
        Returns the upgrade policy of this, which is defaultPolicy if none is specified

      • changeBlocker

        public java.util.List<DeploymentSpec.ChangeBlocker> changeBlocker()
        Returns time windows where upgrades are disallowed for these instances

      • globalServiceId

        public java.util.Optional<java.lang.String> globalServiceId()
        Returns the ID of the service to expose through global routing, if present

      • canUpgradeAt

        public boolean canUpgradeAt​(java.time.Instant instant)
        Returns whether the instances in this step can upgrade at the given instant

      • canChangeRevisionAt

        public boolean canChangeRevisionAt​(java.time.Instant instant)
        Returns whether an application revision change for these instances can occur at the given instant

      • deploysTo

        public boolean deploysTo​(com.yahoo.config.provision.Environment environment,
                         java.util.Optional<com.yahoo.config.provision.RegionName> region)
        Returns whether this deployment spec specifies the given zone, either implicitly or explicitly
        Specified by:
        deploysTo in class DeploymentSpec.Step

      • athenzDomain

        public java.util.Optional<com.yahoo.config.provision.AthenzDomain> athenzDomain()
        Returns the athenz domain if configured

      • athenzService

        public java.util.Optional<com.yahoo.config.provision.AthenzService> athenzService​(com.yahoo.config.provision.Environment environment,
                                                                                  com.yahoo.config.provision.RegionName region)
        Returns the athenz service for environment/region if configured

      • notifications

        public Notifications notifications()
        Returns the notification configuration of these instances

      • endpoints

        public java.util.List<Endpoint> endpoints()
        Returns the rotations configuration of these instances

      • includes

        public boolean includes​(com.yahoo.config.provision.Environment environment,
                        java.util.Optional<com.yahoo.config.provision.RegionName> region)
        Returns whether this instances deployment specifies the given zone, either implicitly or explicitly

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object