DelegationControl (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.delegateaccesscontrol.model.DelegationControl

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230801")
public final class DelegationControl
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Delegation Control enables you to grant, audit, or revoke the access Oracle has to your Exadata Cloud infrastructure, and obtain audit reports of all actions taken by a human operator, in a near real-time manner.
Note: Objects should always be created or deserialized using the DelegationControl.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 DelegationControl.Builder, which maintain a set of all explicitly set fields called DelegationControl.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).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DelegationControl.Builder`
`static class`	`DelegationControl.LifecycleState` The current lifecycle state of the Delegation Control.
`static class`	`DelegationControl.NotificationMessageFormat` The format of the OCI Notification messages for this Delegation Control.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
DelegationControl(String id, String compartmentId, String displayName, String description, Integer numApprovalsRequired, List<String> preApprovedServiceProviderActionNames, List<String> delegationSubscriptionIds, Boolean isAutoApproveDuringMaintenance, List<String> resourceIds, DelegationControlResourceType resourceType, String notificationTopicId, DelegationControl.NotificationMessageFormat notificationMessageFormat, String vaultId, String vaultKeyId, DelegationControl.LifecycleState lifecycleState, String lifecycleStateDetails, Date timeCreated, Date timeUpdated, Date timeDeleted, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags) Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DelegationControl.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment that contains the Delegation Control.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`List<String>`	`getDelegationSubscriptionIds()` List of Delegation Subscription OCID that are allowed for this Delegation Control.
`String`	`getDescription()` Description of the Delegation Control.
`String`	`getDisplayName()` Name of the Delegation Control.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the Delegation Control.
`Boolean`	`getIsAutoApproveDuringMaintenance()` Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance.
`DelegationControl.LifecycleState`	`getLifecycleState()` The current lifecycle state of the Delegation Control.
`String`	`getLifecycleStateDetails()` Description of the current lifecycle state in more detail.
`DelegationControl.NotificationMessageFormat`	`getNotificationMessageFormat()` The format of the OCI Notification messages for this Delegation Control.
`String`	`getNotificationTopicId()` The OCID of the OCI Notification topic to publish messages related to this Delegation Control.
`Integer`	`getNumApprovalsRequired()` number of approvals required.
`List<String>`	`getPreApprovedServiceProviderActionNames()` List of pre-approved Service Provider Action names.
`List<String>`	`getResourceIds()` The OCID of the selected resources that this Delegation Control is applicable to.
`DelegationControlResourceType`	`getResourceType()` Resource type for which the Delegation Control is applicable to.
`Map<String,Map<String,Object>>`	`getSystemTags()` System tags for this resource.
`Date`	`getTimeCreated()` Time when the Delegation Control was created expressed in RFC 3339 timestamp format, e.g.
`Date`	`getTimeDeleted()` Time when the Delegation Control was deleted expressed in RFC 3339timestamp format, e.g.
`Date`	`getTimeUpdated()` Time when the Delegation Control was last modified expressed in RFC 3339 timestamp format, e.g.
`String`	`getVaultId()` The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service.
`String`	`getVaultKeyId()` The OCID of the Master Encryption Key in the OCI Vault specified by vaultId.
`int`	`hashCode()`
`DelegationControl.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DelegationControl

@Deprecated
 @ConstructorProperties(value={"id","compartmentId","displayName","description","numApprovalsRequired","preApprovedServiceProviderActionNames","delegationSubscriptionIds","isAutoApproveDuringMaintenance","resourceIds","resourceType","notificationTopicId","notificationMessageFormat","vaultId","vaultKeyId","lifecycleState","lifecycleStateDetails","timeCreated","timeUpdated","timeDeleted","freeformTags","definedTags","systemTags"})
public DelegationControl(String id,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String compartmentId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String displayName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String description,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Integer numApprovalsRequired,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List<String> preApprovedServiceProviderActionNames,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List<String> delegationSubscriptionIds,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Boolean isAutoApproveDuringMaintenance,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List<String> resourceIds,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DelegationControlResourceType resourceType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String notificationTopicId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DelegationControl.NotificationMessageFormat notificationMessageFormat,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String vaultId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String vaultKeyId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DelegationControl.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String lifecycleStateDetails,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Date timeCreated,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Date timeUpdated,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Date timeDeleted,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static DelegationControl.Builder builder()
```
  Create a new builder.
- toBuilder
```
public DelegationControl.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the Delegation Control.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment that contains the Delegation Control.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  Name of the Delegation Control. The name does not need to be unique.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  Description of the Delegation Control.
  
  Returns:
  
  the value
- getNumApprovalsRequired
```
public Integer getNumApprovalsRequired()
```
  number of approvals required.
  
  Returns:
  
  the value
- getPreApprovedServiceProviderActionNames
```
public List<String> getPreApprovedServiceProviderActionNames()
```
  List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list.
  
  Returns:
  
  the value
- getDelegationSubscriptionIds
```
public List<String> getDelegationSubscriptionIds()
```
  List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request.
  
  Returns:
  
  the value
- getIsAutoApproveDuringMaintenance
```
public Boolean getIsAutoApproveDuringMaintenance()
```
  Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance.
  
  Returns:
  
  the value
- getResourceIds
```
public List<String> getResourceIds()
```
  The OCID of the selected resources that this Delegation Control is applicable to.
  
  Returns:
  
  the value
- getResourceType
```
public DelegationControlResourceType getResourceType()
```
  Resource type for which the Delegation Control is applicable to.
  
  Returns:
  
  the value
- getNotificationTopicId
```
public String getNotificationTopicId()
```
  The OCID of the OCI Notification topic to publish messages related to this Delegation Control.
  
  Returns:
  
  the value
- getNotificationMessageFormat
```
public DelegationControl.NotificationMessageFormat getNotificationMessageFormat()
```
  The format of the OCI Notification messages for this Delegation Control.
  
  Returns:
  
  the value
- getVaultId
```
public String getVaultId()
```
  The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. Delegate Access Control Service will generate the SSH keys and store them as secrets in the OCI Vault.
  
  Returns:
  
  the value
- getVaultKeyId
```
public String getVaultKeyId()
```
  The OCID of the Master Encryption Key in the OCI Vault specified by vaultId. This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER.
  
  Returns:
  
  the value
- getLifecycleState
```
public DelegationControl.LifecycleState getLifecycleState()
```
  The current lifecycle state of the Delegation Control.
  
  Returns:
  
  the value
- getLifecycleStateDetails
```
public String getLifecycleStateDetails()
```
  Description of the current lifecycle state in more detail.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  Time when the Delegation Control was created expressed in RFC 3339 timestamp format, e.g. ‘2020-05-22T21:10:29.600Z’
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  Time when the Delegation Control was last modified expressed in RFC 3339 timestamp format, e.g. ‘2020-05-22T21:10:29.600Z’
  
  Returns:
  
  the value
- getTimeDeleted
```
public Date getTimeDeleted()
```
  Time when the Delegation Control was deleted expressed in RFC 3339timestamp format, e.g. ‘2020-05-22T21:10:29.600Z’. Note a deleted Delegation Control still stays in the system, so that you can still audit Service Provider Actions associated with Delegated Resource Access Requests raised on target resources governed by the deleted Delegation Control.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
  
  Example: {"Department": "Finance"}
  
  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. For more information, see Resource Tags.
  
  Example: {"Operations": {"CostCenter": "42"}}
  
  Returns:
  
  the value
- getSystemTags
```
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"}}
  
  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

Class DelegationControl

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

DelegationControl

Method Detail

builder

toBuilder

getId

getCompartmentId

getDisplayName

getDescription

getNumApprovalsRequired

getPreApprovedServiceProviderActionNames

getDelegationSubscriptionIds

getIsAutoApproveDuringMaintenance

getResourceIds

getResourceType

getNotificationTopicId

getNotificationMessageFormat

getVaultId

getVaultKeyId

getLifecycleState

getLifecycleStateDetails

getTimeCreated

getTimeUpdated

getTimeDeleted

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode