Class ListRunbooksRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.fleetappsmanagement.requests.ListRunbooksRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20250228") public class ListRunbooksRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/fleetappsmanagement/ListRunbooksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRunbooksRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListRunbooksRequest.Builder
-
Constructor Summary
Constructors Constructor Description ListRunbooksRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListRunbooksRequest.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’.StringgetCompartmentId()The ID of the compartment in which to list resources.StringgetDisplayName()A filter to return only resources that match the entire display name given.StringgetId()Unique identifier or OCID for listing a single Runbook by id.Runbook.LifecycleStategetLifecycleState()A filter to return only resources whose lifecycleState matches the given lifecycleState.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.StringgetOperation()A filter to return runbooks whose operation matches the given lifecycle operation.StringgetPage()A token representing the position at which to start retrieving results.StringgetPlatform()A filter to return runbooks whose platform matches the given platform.RunbookSortBygetSortBy()The field to sort by.SortOrdergetSortOrder()The sort order to use, either ‘ASC’ or ‘DESC’.Runbook.TypegetType()A filter to return runbooks whose type matches the given type.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListRunbooksRequest.BuildertoBuilder()Return an instance ofListRunbooksRequest.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 ID of the compartment in which to list resources.Empty only if the resource OCID query param is not specified.
-
getLifecycleState
public Runbook.LifecycleState getLifecycleState()
A filter to return only resources whose lifecycleState matches the given lifecycleState.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the entire display name given.
-
getId
public String getId()
Unique identifier or OCID for listing a single Runbook by id.Either compartmentId or id must be provided.
-
getType
public Runbook.Type getType()
A filter to return runbooks whose type matches the given type.
-
getPlatform
public String getPlatform()
A filter to return runbooks whose platform matches the given platform.
-
getOperation
public String getOperation()
A filter to return runbooks whose operation matches the given lifecycle operation.
-
getLimit
public Integer getLimit()
The maximum number of items to return.
-
getPage
public String getPage()
A token representing the position at which to start retrieving results.This must come from the opc-next-page header field of a previous response.
-
getSortOrder
public SortOrder getSortOrder()
The sort order to use, either ‘ASC’ or ‘DESC’.
-
getSortBy
public RunbookSortBy 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.
-
getOpcRequestId
public String getOpcRequestId()
The client request ID for tracing.
-
toBuilder
public ListRunbooksRequest.Builder toBuilder()
Return an instance ofListRunbooksRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListRunbooksRequest.Builderthat allows you to modify request properties.
-
builder
public static ListRunbooksRequest.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>
-
-