Class ManagementAgent
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.managementagent.model.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 theManagementAgent.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 theManagementAgent.Builder
, which maintain a set of all explicitly set fields calledManagementAgent.Builder.__explicitlySet__
. ThehashCode()
andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ManagementAgent.Builder
-
Constructor Summary
Constructors Constructor Description ManagementAgent(String id, String installKeyId, String displayName, PlatformTypes platformType, String platformName, String platformVersion, String version, String resourceArtifactVersion, String host, String hostId, String installPath, List<ManagementAgentPluginDetails> pluginList, String compartmentId, Boolean isAgentAutoUpgradable, Date timeCreated, Date timeUpdated, Date timeLastHeartbeat, AvailabilityStatus availabilityStatus, LifecycleStates lifecycleState, String lifecycleDetails, Boolean isCustomerDeployed, InstallTypes installType, List<ManagementAgentProperty> managementAgentProperties, List<DataSource> dataSourceList, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ManagementAgent.Builder
builder()
Create a new builder.boolean
equals(Object o)
AvailabilityStatus
getAvailabilityStatus()
The current availability status of managementAgentString
getCompartmentId()
Compartment IdentifierList<DataSource>
getDataSourceList()
list of dataSources associated with the agentMap<String,Map<String,Object>>
getDefinedTags()
Defined tags for this resource.String
getDisplayName()
Management Agent NameMap<String,String>
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.String
getHost()
Management Agent host machine nameString
getHostId()
Host resource ocidString
getId()
agent identifierString
getInstallKeyId()
agent install key identifierString
getInstallPath()
Path where Management Agent is installedInstallTypes
getInstallType()
The install type, either AGENT or GATEWAYBoolean
getIsAgentAutoUpgradable()
true if the agent can be upgraded automatically; false if it must be upgraded manually.Boolean
getIsCustomerDeployed()
true, if the agent image is manually downloaded and installed.String
getLifecycleDetails()
A message describing the current state in more detail.LifecycleStates
getLifecycleState()
The current state of managementAgentList<ManagementAgentProperty>
getManagementAgentProperties()
Additional properties for this Management AgentString
getPlatformName()
Platform NamePlatformTypes
getPlatformType()
Platform TypeString
getPlatformVersion()
Platform VersionList<ManagementAgentPluginDetails>
getPluginList()
list of managementAgentPlugins associated with the agentString
getResourceArtifactVersion()
Version of the deployment artifact instantiated by this Management Agent.Date
getTimeCreated()
The time the Management Agent was created.Date
getTimeLastHeartbeat()
The time the Management Agent has last recorded its health status in telemetry.Date
getTimeUpdated()
The time the Management Agent was updated.String
getVersion()
Management Agent Versionint
hashCode()
ManagementAgent.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
ManagementAgent
@Deprecated @ConstructorProperties({"id","installKeyId","displayName","platformType","platformName","platformVersion","version","resourceArtifactVersion","host","hostId","installPath","pluginList","compartmentId","isAgentAutoUpgradable","timeCreated","timeUpdated","timeLastHeartbeat","availabilityStatus","lifecycleState","lifecycleDetails","isCustomerDeployed","installType","managementAgentProperties","dataSourceList","freeformTags","definedTags"}) public ManagementAgent(String id, String installKeyId, String displayName, PlatformTypes platformType, String platformName, String platformVersion, String version, String resourceArtifactVersion, String host, String hostId, String installPath, List<ManagementAgentPluginDetails> pluginList, String compartmentId, Boolean isAgentAutoUpgradable, Date timeCreated, Date timeUpdated, Date timeLastHeartbeat, AvailabilityStatus availabilityStatus, LifecycleStates lifecycleState, String lifecycleDetails, Boolean isCustomerDeployed, InstallTypes installType, List<ManagementAgentProperty> managementAgentProperties, List<DataSource> dataSourceList, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
Deprecated.
-
-
Method Detail
-
builder
public static ManagementAgent.Builder builder()
Create a new builder.
-
toBuilder
public ManagementAgent.Builder toBuilder()
-
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
-
getPluginList
public List<ManagementAgentPluginDetails> getPluginList()
list of managementAgentPlugins associated with the agent- 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 classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-