Class TimeSeriesParameter

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataType

    public class TimeSeriesParameter
    extends Object
    implements com.github.davidmoten.odata.client.ODataType
    “Parameter passed to GetHealthMetricTimeSeries when requesting snapshot time series.”
    • Field Detail

      • contextPath

        protected com.github.davidmoten.odata.client.ContextPath contextPath
      • unmappedFields

        protected com.github.davidmoten.odata.client.internal.UnmappedFieldsImpl unmappedFields
      • odataType

        protected String odataType
      • metricName

        protected String metricName
    • Constructor Detail

      • TimeSeriesParameter

        protected TimeSeriesParameter()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
      • getEndDateTime

        public Optional<OffsetDateTime> getEndDateTime()
        “End time of the series being requested. Optional; if not specified, current time is used.”
        Returns:
        property endDateTime
      • withEndDateTime

        public TimeSeriesParameter withEndDateTime​(OffsetDateTime endDateTime)
        Returns an immutable copy of this with just the endDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “End time of the series being requested. Optional; if not specified, current time is used.”

        Parameters:
        endDateTime - new value of endDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the endDateTime field changed
      • getMetricName

        public Optional<String> getMetricName()
        “The name of the metric for which a time series is requested.”
        Returns:
        property metricName
      • withMetricName

        public TimeSeriesParameter withMetricName​(String metricName)
        Returns an immutable copy of this with just the metricName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The name of the metric for which a time series is requested.”

        Parameters:
        metricName - new value of metricName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the metricName field changed
      • getStartDateTime

        public Optional<OffsetDateTime> getStartDateTime()
        “Start time of the series being requested.”
        Returns:
        property startDateTime
      • withStartDateTime

        public TimeSeriesParameter withStartDateTime​(OffsetDateTime startDateTime)
        Returns an immutable copy of this with just the startDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Start time of the series being requested.”

        Parameters:
        startDateTime - new value of startDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the startDateTime field changed
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
      • builder

        public static TimeSeriesParameter.Builder builder()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class