Class PipelineTopologyPropertiesUpdate


  • public final class PipelineTopologyPropertiesUpdate
    extends Object
    Describes the properties of a pipeline topology.
    • Constructor Detail

      • PipelineTopologyPropertiesUpdate

        public PipelineTopologyPropertiesUpdate()
    • Method Detail

      • description

        public String description()
        Get the description property: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
        Returns:
        the description value.
      • withDescription

        public PipelineTopologyPropertiesUpdate withDescription​(String description)
        Set the description property: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
        Parameters:
        description - the description value to set.
        Returns:
        the PipelineTopologyPropertiesUpdate object itself.
      • parameters

        public List<ParameterDeclaration> parameters()
        Get the parameters property: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
        Returns:
        the parameters value.
      • withParameters

        public PipelineTopologyPropertiesUpdate withParameters​(List<ParameterDeclaration> parameters)
        Set the parameters property: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
        Parameters:
        parameters - the parameters value to set.
        Returns:
        the PipelineTopologyPropertiesUpdate object itself.
      • sources

        public List<SourceNodeBase> sources()
        Get the sources property: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
        Returns:
        the sources value.
      • withSources

        public PipelineTopologyPropertiesUpdate withSources​(List<SourceNodeBase> sources)
        Set the sources property: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
        Parameters:
        sources - the sources value to set.
        Returns:
        the PipelineTopologyPropertiesUpdate object itself.
      • processors

        public List<ProcessorNodeBase> processors()
        Get the processors property: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
        Returns:
        the processors value.
      • withProcessors

        public PipelineTopologyPropertiesUpdate withProcessors​(List<ProcessorNodeBase> processors)
        Set the processors property: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
        Parameters:
        processors - the processors value to set.
        Returns:
        the PipelineTopologyPropertiesUpdate object itself.
      • sinks

        public List<SinkNodeBase> sinks()
        Get the sinks property: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
        Returns:
        the sinks value.
      • withSinks

        public PipelineTopologyPropertiesUpdate withSinks​(List<SinkNodeBase> sinks)
        Set the sinks property: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
        Parameters:
        sinks - the sinks value to set.
        Returns:
        the PipelineTopologyPropertiesUpdate object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.