com.spotify.helios.common.descriptors

Class ServicePortParameters

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.ServicePortParameters

public class ServicePortParameters
extends Descriptor

Stores metadata for a service port. Currently, only tags are supported.

The tags can be used in service registration plugins trough ServiceRegistration.Endpoint.

An example expression of a Helios job with service port metadata might be:

 {
   "ports" : {
     "http" : {
       "externalPort" : 8060,
       "internalPort" : 8080,
       "protocol" : "tcp"
     }
   },
   "registration" : {
     "service/http" : {
       "ports" : {
         "http" : {
           "tags" : ["tag-1", "tag-2"]
         }
       }
     }
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
ServicePortParameters(List<String> tags)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getTags()
int	hashCode()
String	toString()

Methods inherited from class com.spotify.helios.common.descriptors.Descriptor

parse, parse, toJsonBytes, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePortParameters

public ServicePortParameters(@Nullable
                             List<String> tags)

Method Detail

getTags

public List<String> getTags()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object