Package com.oracle.bmc.healthchecks.model

Class HttpProbeResultSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • key

        public HttpProbeResultSummary.Builder key​(String key)
        A value identifying this specific probe result.

        The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

        Parameters:
        key - the value to set
        Returns:
        this builder

      • probeConfigurationId

        public HttpProbeResultSummary.Builder probeConfigurationId​(String probeConfigurationId)
        The OCID of the monitor or on-demand probe responsible for creating this result.
        Parameters:
        probeConfigurationId - the value to set
        Returns:
        this builder

      • startTime

        public HttpProbeResultSummary.Builder startTime​(Double startTime)
        The date and time the probe was executed, expressed in milliseconds since the POSIX epoch.

        This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see Resource Timing.

        Parameters:
        startTime - the value to set
        Returns:
        this builder

      • target

        public HttpProbeResultSummary.Builder target​(String target)
        The target hostname or IP address of the probe.
        Parameters:
        target - the value to set
        Returns:
        this builder

      • vantagePointName

        public HttpProbeResultSummary.Builder vantagePointName​(String vantagePointName)
        The name of the vantage point that executed the probe.
        Parameters:
        vantagePointName - the value to set
        Returns:
        this builder

      • isTimedOut

        public HttpProbeResultSummary.Builder isTimedOut​(Boolean isTimedOut)
        True if the probe did not complete before the configured timeoutInSeconds value.
        Parameters:
        isTimedOut - the value to set
        Returns:
        this builder

      • isHealthy

        public HttpProbeResultSummary.Builder isHealthy​(Boolean isHealthy)
        True if the probe result is determined to be healthy based on probe type-specific criteria.

        For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300.

        Parameters:
        isHealthy - the value to set
        Returns:
        this builder

      • errorCategory

        public HttpProbeResultSummary.Builder errorCategory​(HttpProbeResultSummary.ErrorCategory errorCategory)
        The category of error if an error occurs executing the probe.

        The errorMessage field provides a message with the error details. * NONE - No error * DNS - DNS errors * TRANSPORT - Transport-related errors, for example a “TLS certificate expired” error. * NETWORK - Network-related errors, for example a “network unreachable” error. * SYSTEM - Internal system errors.

        Parameters:
        errorCategory - the value to set
        Returns:
        this builder

      • errorMessage

        public HttpProbeResultSummary.Builder errorMessage​(String errorMessage)
        The error information indicating why a probe execution failed.
        Parameters:
        errorMessage - the value to set
        Returns:
        this builder

      • domainLookupStart

        public HttpProbeResultSummary.Builder domainLookupStart​(Double domainLookupStart)
        The time immediately before the vantage point starts the domain name lookup for the resource.
        Parameters:
        domainLookupStart - the value to set
        Returns:
        this builder

      • domainLookupEnd

        public HttpProbeResultSummary.Builder domainLookupEnd​(Double domainLookupEnd)
        The time immediately before the vantage point finishes the domain name lookup for the resource.
        Parameters:
        domainLookupEnd - the value to set
        Returns:
        this builder

      • connectStart

        public HttpProbeResultSummary.Builder connectStart​(Double connectStart)
        The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.
        Parameters:
        connectStart - the value to set
        Returns:
        this builder

      • secureConnectionStart

        public HttpProbeResultSummary.Builder secureConnectionStart​(Double secureConnectionStart)
        The time immediately before the vantage point starts the handshake process to secure the current connection.
        Parameters:
        secureConnectionStart - the value to set
        Returns:
        this builder

      • connectEnd

        public HttpProbeResultSummary.Builder connectEnd​(Double connectEnd)
        The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.
        Parameters:
        connectEnd - the value to set
        Returns:
        this builder

      • fetchStart

        public HttpProbeResultSummary.Builder fetchStart​(Double fetchStart)
        The time immediately before the vantage point starts to fetch the resource.
        Parameters:
        fetchStart - the value to set
        Returns:
        this builder

      • requestStart

        public HttpProbeResultSummary.Builder requestStart​(Double requestStart)
        The time immediately before the vantage point starts requesting the resource from the server.
        Parameters:
        requestStart - the value to set
        Returns:
        this builder

      • responseStart

        public HttpProbeResultSummary.Builder responseStart​(Double responseStart)
        The time immediately after the vantage point’s HTTP parser receives the first byte of the response.
        Parameters:
        responseStart - the value to set
        Returns:
        this builder

      • responseEnd

        public HttpProbeResultSummary.Builder responseEnd​(Double responseEnd)
        The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first.
        Parameters:
        responseEnd - the value to set
        Returns:
        this builder

      • duration

        public HttpProbeResultSummary.Builder duration​(Double duration)
        The total duration from start of request until response is fully consumed or the connection is closed.
        Parameters:
        duration - the value to set
        Returns:
        this builder

      • encodedBodySize

        public HttpProbeResultSummary.Builder encodedBodySize​(Integer encodedBodySize)
        The size, in octets, of the payload body prior to removing any applied content-codings.
        Parameters:
        encodedBodySize - the value to set
        Returns:
        this builder