Package com.oracle.bmc.loganalytics.model

Class Rule

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class Rule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A generic rule object - represents an ingest time rule or a scheduled task.
    Note: Objects should always be created or deserialized using the Rule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Rule.Builder, which maintain a set of all explicitly set fields called Rule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Rule.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The log analytics entity OCID.

        This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Description for this resource.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment Identifier [OCID] (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the resource was created, in the format defined by RFC3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the resource was last updated, in the format defined by RFC3339.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getLifecycleState

        public ConfigLifecycleState getLifecycleState()
        The current state of the logging analytics rule.
        Returns:
        the value

      • getKind

        public RuleKind getKind()
        The kind of rule - either an ingest time rule or a scheduled task.
        Returns:
        the value

      • getTargetService

        public String getTargetService()
        The target service.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The ingest time rule or scheduled task display name.
        Returns:
        the value

      • getIsEnabled

        public Boolean getIsEnabled()
        A flag indicating whether or not the ingest time rule or scheduled task is enabled.
        Returns:
        the value

      • getLastExecutionStatus

        public Rule.LastExecutionStatus getLastExecutionStatus()
        The most recent task execution status.
        Returns:
        the value

      • getTimeLastExecuted

        public Date getTimeLastExecuted()
        The date and time the scheduled task last executed, in the format defined by RFC3339.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel