Class AvailabilityStatusProperties


  • public final class AvailabilityStatusProperties
    extends Object
    Properties of availability state.
    • Constructor Detail

      • AvailabilityStatusProperties

        public AvailabilityStatusProperties()
    • Method Detail

      • availabilityState

        public AvailabilityStateValues availabilityState()
        Get the availabilityState property: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event.
        Returns:
        the availabilityState value.
      • withAvailabilityState

        public AvailabilityStatusProperties withAvailabilityState​(AvailabilityStateValues availabilityState)
        Set the availabilityState property: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event.
        Parameters:
        availabilityState - the availabilityState value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • title

        public String title()
        Get the title property: Title description of the availability status.
        Returns:
        the title value.
      • withTitle

        public AvailabilityStatusProperties withTitle​(String title)
        Set the title property: Title description of the availability status.
        Parameters:
        title - the title value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • summary

        public String summary()
        Get the summary property: Summary description of the availability status.
        Returns:
        the summary value.
      • withSummary

        public AvailabilityStatusProperties withSummary​(String summary)
        Set the summary property: Summary description of the availability status.
        Parameters:
        summary - the summary value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • detailedStatus

        public String detailedStatus()
        Get the detailedStatus property: Details of the availability status.
        Returns:
        the detailedStatus value.
      • withDetailedStatus

        public AvailabilityStatusProperties withDetailedStatus​(String detailedStatus)
        Set the detailedStatus property: Details of the availability status.
        Parameters:
        detailedStatus - the detailedStatus value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • reasonType

        public String reasonType()
        Get the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.
        Returns:
        the reasonType value.
      • withReasonType

        public AvailabilityStatusProperties withReasonType​(String reasonType)
        Set the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.
        Parameters:
        reasonType - the reasonType value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • rootCauseAttributionTime

        public OffsetDateTime rootCauseAttributionTime()
        Get the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
        Returns:
        the rootCauseAttributionTime value.
      • withRootCauseAttributionTime

        public AvailabilityStatusProperties withRootCauseAttributionTime​(OffsetDateTime rootCauseAttributionTime)
        Set the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
        Parameters:
        rootCauseAttributionTime - the rootCauseAttributionTime value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • healthEventType

        public String healthEventType()
        Get the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.
        Returns:
        the healthEventType value.
      • withHealthEventType

        public AvailabilityStatusProperties withHealthEventType​(String healthEventType)
        Set the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.
        Parameters:
        healthEventType - the healthEventType value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • healthEventCause

        public String healthEventCause()
        Get the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.
        Returns:
        the healthEventCause value.
      • withHealthEventCause

        public AvailabilityStatusProperties withHealthEventCause​(String healthEventCause)
        Set the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.
        Parameters:
        healthEventCause - the healthEventCause value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • healthEventCategory

        public String healthEventCategory()
        Get the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.
        Returns:
        the healthEventCategory value.
      • withHealthEventCategory

        public AvailabilityStatusProperties withHealthEventCategory​(String healthEventCategory)
        Set the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.
        Parameters:
        healthEventCategory - the healthEventCategory value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • healthEventId

        public String healthEventId()
        Get the healthEventId property: It is a unique Id that identifies the event.
        Returns:
        the healthEventId value.
      • withHealthEventId

        public AvailabilityStatusProperties withHealthEventId​(String healthEventId)
        Set the healthEventId property: It is a unique Id that identifies the event.
        Parameters:
        healthEventId - the healthEventId value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • resolutionEta

        public OffsetDateTime resolutionEta()
        Get the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.
        Returns:
        the resolutionEta value.
      • withResolutionEta

        public AvailabilityStatusProperties withResolutionEta​(OffsetDateTime resolutionEta)
        Set the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.
        Parameters:
        resolutionEta - the resolutionEta value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • occurredTime

        public OffsetDateTime occurredTime()
        Get the occurredTime property: Timestamp for when last change in health status occurred.
        Returns:
        the occurredTime value.
      • withOccurredTime

        public AvailabilityStatusProperties withOccurredTime​(OffsetDateTime occurredTime)
        Set the occurredTime property: Timestamp for when last change in health status occurred.
        Parameters:
        occurredTime - the occurredTime value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • reasonChronicity

        public ReasonChronicityTypes reasonChronicity()
        Get the reasonChronicity property: Chronicity of the availability transition.
        Returns:
        the reasonChronicity value.
      • withReasonChronicity

        public AvailabilityStatusProperties withReasonChronicity​(ReasonChronicityTypes reasonChronicity)
        Set the reasonChronicity property: Chronicity of the availability transition.
        Parameters:
        reasonChronicity - the reasonChronicity value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • reportedTime

        public OffsetDateTime reportedTime()
        Get the reportedTime property: Timestamp for when the health was last checked.
        Returns:
        the reportedTime value.
      • withReportedTime

        public AvailabilityStatusProperties withReportedTime​(OffsetDateTime reportedTime)
        Set the reportedTime property: Timestamp for when the health was last checked.
        Parameters:
        reportedTime - the reportedTime value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • recentlyResolved

        public AvailabilityStatusPropertiesRecentlyResolved recentlyResolved()
        Get the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned.
        Returns:
        the recentlyResolved value.
      • withRecentlyResolved

        public AvailabilityStatusProperties withRecentlyResolved​(AvailabilityStatusPropertiesRecentlyResolved recentlyResolved)
        Set the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned.
        Parameters:
        recentlyResolved - the recentlyResolved value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • recommendedActions

        public List<RecommendedAction> recommendedActions()
        Get the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource.
        Returns:
        the recommendedActions value.
      • withRecommendedActions

        public AvailabilityStatusProperties withRecommendedActions​(List<RecommendedAction> recommendedActions)
        Set the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource.
        Parameters:
        recommendedActions - the recommendedActions value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • serviceImpactingEvents

        public List<ServiceImpactingEvent> serviceImpactingEvents()
        Get the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource.
        Returns:
        the serviceImpactingEvents value.
      • withServiceImpactingEvents

        public AvailabilityStatusProperties withServiceImpactingEvents​(List<ServiceImpactingEvent> serviceImpactingEvents)
        Set the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource.
        Parameters:
        serviceImpactingEvents - the serviceImpactingEvents value to set.
        Returns:
        the AvailabilityStatusProperties object itself.
      • validate

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