Package com.oracle.bmc.cloudbridge.model

Class Agent

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public final class Agent
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Description of Agent.
    Note: Objects should always be created or deserialized using the Agent.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 Agent.Builder, which maintain a set of all explicitly set fields called Agent.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 Agent.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        Unique identifier that is immutable on creation.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Agent identifier, can be renamed.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment identifier.
        Returns:
        the value

      • getAgentType

        public Agent.AgentType getAgentType()
        Type of the Agent.
        Returns:
        the value

      • getAgentVersion

        public String getAgentVersion()
        Agent identifier.
        Returns:
        the value

      • getOsVersion

        public String getOsVersion()
        OS version.
        Returns:
        the value

      • getTimeCreated

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeLastSyncReceived

        public Date getTimeLastSyncReceived()
        The time when the last heartbeat of the Agent was noted.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getHeartBeatStatus

        public Agent.HeartBeatStatus getHeartBeatStatus()
        The current heartbeat status of the Agent based on its timeLastSyncReceived value.
        Returns:
        the value

      • getEnvironmentId

        public String getEnvironmentId()
        Environment identifier.
        Returns:
        the value

      • getAgentPubKey

        public String getAgentPubKey()
        Resource principal public key.
        Returns:
        the value

      • getTimeExpireAgentKeyInMs

        public Date getTimeExpireAgentKeyInMs()
        The time since epoch for when the public key will expire.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getLifecycleState

        public Agent.LifecycleState getLifecycleState()
        The current state of the Agent.
        Returns:
        the value

      • getLifecycleDetails

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

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

        Returns:
        the value

      • getPluginList

        public List<PluginSummary> getPluginList()
        List of plugins associated with the agent.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        The freeform tags associated with this resource, if any.

        Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        The defined tags associated with this resource, if any.

        Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        The system tags associated with this resource, if any.

        The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

        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