Package com.oracle.bmc.managementagent.model

Class ManagementAgent

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200202")
public final class ManagementAgent
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of the Management Agent inventory including the associated plugins.
    Note: Objects should always be created or deserialized using the ManagementAgent.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 ManagementAgent.Builder, which maintain a set of all explicitly set fields called ManagementAgent.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

      • getId

        public String getId()
        agent identifier
        Returns:
        the value

      • getInstallKeyId

        public String getInstallKeyId()
        agent install key identifier
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Management Agent Name
        Returns:
        the value

      • getPlatformType

        public PlatformTypes getPlatformType()
        Platform Type
        Returns:
        the value

      • getPlatformName

        public String getPlatformName()
        Platform Name
        Returns:
        the value

      • getPlatformVersion

        public String getPlatformVersion()
        Platform Version
        Returns:
        the value

      • getVersion

        public String getVersion()
        Management Agent Version
        Returns:
        the value

      • getResourceArtifactVersion

        public String getResourceArtifactVersion()
        Version of the deployment artifact instantiated by this Management Agent.

        The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999

        Returns:
        the value

      • getHost

        public String getHost()
        Management Agent host machine name
        Returns:
        the value

      • getHostId

        public String getHostId()
        Host resource ocid
        Returns:
        the value

      • getInstallPath

        public String getInstallPath()
        Path where Management Agent is installed
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment Identifier
        Returns:
        the value

      • getIsAgentAutoUpgradable

        public Boolean getIsAgentAutoUpgradable()
        true if the agent can be upgraded automatically; false if it must be upgraded manually.

        This flag is derived from the tenancy level auto upgrade preference.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the Management Agent was created.

        An RFC3339 formatted datetime string

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the Management Agent was updated.

        An RFC3339 formatted datetime string

        Returns:
        the value

      • getTimeLastHeartbeat

        public Date getTimeLastHeartbeat()
        The time the Management Agent has last recorded its health status in telemetry.

        This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string

        Returns:
        the value

      • getAvailabilityStatus

        public AvailabilityStatus getAvailabilityStatus()
        The current availability status of managementAgent
        Returns:
        the value

      • getLifecycleState

        public LifecycleStates getLifecycleState()
        The current state of managementAgent
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

        For example, can be used to provide actionable information for a resource in Failed state.

        Returns:
        the value

      • getIsCustomerDeployed

        public Boolean getIsCustomerDeployed()
        true, if the agent image is manually downloaded and installed.

        false, if the agent is deployed as a plugin in Oracle Cloud Agent.

        Returns:
        the value

      • getInstallType

        public InstallTypes getInstallType()
        The install type, either AGENT or GATEWAY
        Returns:
        the value

      • getManagementAgentProperties

        public List<ManagementAgentProperty> getManagementAgentProperties()
        Additional properties for this Management Agent
        Returns:
        the value

      • getDataSourceList

        public List<DataSource> getDataSourceList()
        list of dataSources associated with the agent
        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

      • 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