Class ListManagementAgentsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.managementagent.requests.ListManagementAgentsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public class ListManagementAgentsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/managementagent/ListManagementAgentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementAgentsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListManagementAgentsRequest.Builderstatic classListManagementAgentsRequest.SortByThe field to sort by.static classListManagementAgentsRequest.SortOrderThe sort order to use, either ‘asc’ or ‘desc’.
-
Constructor Summary
Constructors Constructor Description ListManagementAgentsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListManagementAgentsRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetAccessLevel()When the value is “ACCESSIBLE”, insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.AvailabilityStatusgetAvailabilityStatus()Filter to return only Management Agents in the particular availability status.StringgetCompartmentId()The OCID of the compartment to which a request will be scoped.BooleangetCompartmentIdInSubtree()if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.List<String>getDataSourceName()Unique name of the dataSource.DataSourceTypesgetDataSourceType()The type of the dataSource.StringgetDisplayName()Filter to return only Management Agents having the particular display name.List<String>getGatewayId()Filter to return only results having the particular gatewayId.StringgetHostId()Filter to return only Management Agents having the particular agent host id.InstallTypesgetInstallType()A filter to return either agents or gateway types depending upon install type selected by user.BooleangetIsCustomerDeployed()true, if the agent image is manually downloaded and installed.LifecycleStatesgetLifecycleState()Filter to return only Management Agents in the particular lifecycle state.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.StringgetPage()The page token representing the page at which to start retrieving results.List<PlatformTypes>getPlatformType()Filter to return only results having the particular platform type.List<String>getPluginName()Filter to return only Management Agents having the particular Plugin installed.ListManagementAgentsRequest.SortBygetSortBy()The field to sort by.ListManagementAgentsRequest.SortOrdergetSortOrder()The sort order to use, either ‘asc’ or ‘desc’.List<String>getVersion()Filter to return only Management Agents having the particular agent version.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListManagementAgentsRequest.BuildertoBuilder()Return an instance ofListManagementAgentsRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment to which a request will be scoped.
-
getPluginName
public List<String> getPluginName()
Filter to return only Management Agents having the particular Plugin installed.A special pluginName of ‘None’ can be provided and this will return only Management Agents having no plugin installed.
-
getVersion
public List<String> getVersion()
Filter to return only Management Agents having the particular agent version.
-
getDisplayName
public String getDisplayName()
Filter to return only Management Agents having the particular display name.
-
getLifecycleState
public LifecycleStates getLifecycleState()
Filter to return only Management Agents in the particular lifecycle state.
-
getAvailabilityStatus
public AvailabilityStatus getAvailabilityStatus()
Filter to return only Management Agents in the particular availability status.
-
getHostId
public String getHostId()
Filter to return only Management Agents having the particular agent host id.
-
getPlatformType
public List<PlatformTypes> getPlatformType()
Filter to return only results having the particular platform type.
-
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.
-
getInstallType
public InstallTypes getInstallType()
A filter to return either agents or gateway types depending upon install type selected by user.By default both install type will be returned.
-
getGatewayId
public List<String> getGatewayId()
Filter to return only results having the particular gatewayId.
-
getLimit
public Integer getLimit()
The maximum number of items to return.
-
getPage
public String getPage()
The page token representing the page at which to start retrieving results.This is usually retrieved from a previous list call.
-
getSortOrder
public ListManagementAgentsRequest.SortOrder getSortOrder()
The sort order to use, either ‘asc’ or ‘desc’.
-
getSortBy
public ListManagementAgentsRequest.SortBy getSortBy()
The field to sort by.Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
-
getOpcRequestId
public String getOpcRequestId()
The client request ID for tracing.
-
getCompartmentIdInSubtree
public Boolean getCompartmentIdInSubtree()
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
-
getAccessLevel
public String getAccessLevel()
When the value is “ACCESSIBLE”, insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
-
getDataSourceType
public DataSourceTypes getDataSourceType()
The type of the dataSource.
-
toBuilder
public ListManagementAgentsRequest.Builder toBuilder()
Return an instance ofListManagementAgentsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListManagementAgentsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListManagementAgentsRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-