@Generated(value="OracleSDKGenerator",
comments="API Version: 20230831")
public final class Runbook
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Runbook definition. Runbooks allow you to capture procedural tasks for handling a workflow.
Note: Objects should always be created or deserialized using the Runbook.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 Runbook.Builder, which maintain a
set of all explicitly set fields called Runbook.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Runbook.Builder |
static class |
Runbook.LifecycleState
The current state of the Runbook.
|
static class |
Runbook.RunbookRelevance
Relevance of the runbook.
|
static class |
Runbook.Type
The type of the runbook.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Runbook(String id,
String displayName,
String description,
Runbook.Type type,
Runbook.RunbookRelevance runbookRelevance,
String operation,
OsType osType,
String platform,
Boolean isDefault,
String estimatedTime,
Runbook.LifecycleState lifecycleState,
String lifecycleDetails,
Date timeCreated,
Date timeUpdated,
Associations associations,
String compartmentId,
String resourceRegion,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Runbook.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Associations |
getAssociations() |
String |
getCompartmentId()
OCID of the compartment to which the resource belongs to.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A user-friendly description.
|
String |
getDisplayName()
A user-friendly name.
|
String |
getEstimatedTime()
Estimated time to successfully complete the runbook execution.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The OCID of the resource.
|
Boolean |
getIsDefault()
Is the runbook default? Sets this runbook as the default for the chosen product/product stack
for the specified lifecycle operation.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
Runbook.LifecycleState |
getLifecycleState()
The current state of the Runbook.
|
String |
getOperation()
The lifecycle operation performed by the runbook.
|
OsType |
getOsType()
The OS type for the runbook.
|
String |
getPlatform()
The platform of the runbook.
|
String |
getResourceRegion()
Associated region
|
Runbook.RunbookRelevance |
getRunbookRelevance()
Relevance of the runbook.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The time this resource was created.
|
Date |
getTimeUpdated()
The time this resource was last updated.
|
Runbook.Type |
getType()
The type of the runbook.
|
int |
hashCode() |
Runbook.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","type","runbookRelevance","operation","osType","platform","isDefault","estimatedTime","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","associations","compartmentId","resourceRegion","freeformTags","definedTags","systemTags"}) public Runbook(String id, String displayName, String description, Runbook.Type type, Runbook.RunbookRelevance runbookRelevance, String operation, OsType osType, String platform, Boolean isDefault, String estimatedTime, Runbook.LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, Associations associations, String compartmentId, String resourceRegion, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static Runbook.Builder builder()
Create a new builder.
public Runbook.Builder toBuilder()
public String getId()
The OCID of the resource.
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: My new resource
public String getDescription()
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
public Runbook.Type getType()
The type of the runbook.
public Runbook.RunbookRelevance getRunbookRelevance()
Relevance of the runbook.
public String getOperation()
The lifecycle operation performed by the runbook.
public OsType getOsType()
The OS type for the runbook.
public String getPlatform()
The platform of the runbook.
public Boolean getIsDefault()
Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
public String getEstimatedTime()
Estimated time to successfully complete the runbook execution.
public Runbook.LifecycleState getLifecycleState()
The current state of the Runbook.
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.
public Date getTimeCreated()
The time this resource was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The time this resource was last updated. An RFC3339 formatted datetime string.
public Associations getAssociations()
public String getCompartmentId()
OCID of the compartment to which the resource belongs to.
public String getResourceRegion()
Associated region
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"}
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"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.