java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.apiaccesscontrol.model.PrivilegedApiRequest

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public final class PrivilegedApiRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control.
The privilegedApi request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.

You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi request. While creating an access request, the operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. An operator can also request for an extension. The approval for such an extension is processed the same way the original privilegedApi request was processed.
Note: Objects should always be created or deserialized using the PrivilegedApiRequest.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 PrivilegedApiRequest.Builder, which maintain a set of all explicitly set fields called PrivilegedApiRequest.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	Description
`static class`	`PrivilegedApiRequest.Builder`
`static class`	`PrivilegedApiRequest.LifecycleState`	The current state of the PrivilegedApiRequest.
`static class`	`PrivilegedApiRequest.State`	The current state of the Access Request.

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	Description
PrivilegedApiRequest(String id, String displayName, String requestId, String reasonSummary, String notificationTopicId, List<String> requestedBy, String resourceName, String resourceId, List<String> subResourceNameList, String compartmentId, String resourceType, String entityType, List<PrivilegedApiRequestOperationDetails> privilegedOperationList, String reasonDetail, PrivilegedApiRequestSeverity severity, Integer durationInHrs, List<String> ticketNumbers, PrivilegedApiRequest.State state, String stateDetails, PrivilegedApiRequest.LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, String closureComment, String privilegedApiControlId, String privilegedApiControlName, Integer numberOfApproversRequired, List<ApproverDetail> approverDetails, Date timeRequestedForFutureAccess, 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	Description
`static PrivilegedApiRequest.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`List<ApproverDetail>`	`getApproverDetails()`	Contains the approver details who have approved the privilegedApi Request during the initial request.
`String`	`getClosureComment()`	The comment entered by the operator while closing the request.
`String`	`getCompartmentId()`	The OCID of the compartment that contains the access request.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Defined tags for this resource.
`String`	`getDisplayName()`	Name of the privilegedApi control.
`Integer`	`getDurationInHrs()`	Duration in hours for which access is sought on the target resource.
`String`	`getEntityType()`	entityType of resource for which the AccessRequest is applicable
`Map<String,String>`	`getFreeformTags()`	Free-form tags for this resource.
`String`	`getId()`	The OCID of the privilegedApi request.
`String`	`getLifecycleDetails()`	more in detail about the lifeCycleState.
`PrivilegedApiRequest.LifecycleState`	`getLifecycleState()`	The current state of the PrivilegedApiRequest.
`String`	`getNotificationTopicId()`	The OCID of the OCI Notification topic to publish messages related to this privileged api request.
`Integer`	`getNumberOfApproversRequired()`	Number of approvers required to approve an privilegedApi request.
`String`	`getPrivilegedApiControlId()`	The OCID of the privilegedApi control governing the target resource.
`String`	`getPrivilegedApiControlName()`	Name of the privilegedApi control governing the target resource.
`List<PrivilegedApiRequestOperationDetails>`	`getPrivilegedOperationList()`	List of api names, attributes for which approval is sought by the user.
`String`	`getReasonDetail()`	Reason in Detail for which the operator is requesting access on the target resource.
`String`	`getReasonSummary()`	Summary comment by the operator creating the access request.
`List<String>`	`getRequestedBy()`	List of Users who has created this privilegedApiRequest.
`String`	`getRequestId()`	This is an automatic identifier generated by the system which is easier for human comprehension.
`String`	`getResourceId()`	The OCID of the target resource associated with the access request.
`String`	`getResourceName()`	resourceName for which the PrivilegedApiRequest is applicable
`String`	`getResourceType()`	resourceType for which the AccessRequest is applicable
`PrivilegedApiRequestSeverity`	`getSeverity()`	Priority assigned to the access request by the operator
`PrivilegedApiRequest.State`	`getState()`	The current state of the Access Request.
`String`	`getStateDetails()`	A message that describes the current state of the PrivilegedApiControl in more detail.
`List<String>`	`getSubResourceNameList()`	The subresource names requested for approval.
`Map<String,Map<String,Object>>`	`getSystemTags()`	System tags for this resource.
`List<String>`	`getTicketNumbers()`	A list of ticket numbers related to this Privileged Api Access Request, e.g.
`Date`	`getTimeCreated()`	Time when the privilegedApi request was created in RFC 3339timestamp format.
`Date`	`getTimeRequestedForFutureAccess()`	Time in future when the user for the privilegedApi request needs to be created in RFC 3339timestamp format.
`Date`	`getTimeUpdated()`	Time when the privilegedApi request was last modified in RFC 3339timestamp format.
`int`	`hashCode()`
`PrivilegedApiRequest.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

PrivilegedApiRequest

@Deprecated
@ConstructorProperties({"id","displayName","requestId","reasonSummary","notificationTopicId","requestedBy","resourceName","resourceId","subResourceNameList","compartmentId","resourceType","entityType","privilegedOperationList","reasonDetail","severity","durationInHrs","ticketNumbers","state","stateDetails","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","closureComment","privilegedApiControlId","privilegedApiControlName","numberOfApproversRequired","approverDetails","timeRequestedForFutureAccess","freeformTags","definedTags","systemTags"})
public PrivilegedApiRequest(String id,
                            String displayName,
                            String requestId,
                            String reasonSummary,
                            String notificationTopicId,
                            List<String> requestedBy,
                            String resourceName,
                            String resourceId,
                            List<String> subResourceNameList,
                            String compartmentId,
                            String resourceType,
                            String entityType,
                            List<PrivilegedApiRequestOperationDetails> privilegedOperationList,
                            String reasonDetail,
                            PrivilegedApiRequestSeverity severity,
                            Integer durationInHrs,
                            List<String> ticketNumbers,
                            PrivilegedApiRequest.State state,
                            String stateDetails,
                            PrivilegedApiRequest.LifecycleState lifecycleState,
                            String lifecycleDetails,
                            Date timeCreated,
                            Date timeUpdated,
                            String closureComment,
                            String privilegedApiControlId,
                            String privilegedApiControlName,
                            Integer numberOfApproversRequired,
                            List<ApproverDetail> approverDetails,
                            Date timeRequestedForFutureAccess,
                            Map<String,String> freeformTags,
                            Map<String,Map<String,Object>> definedTags,
                            Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static PrivilegedApiRequest.Builder builder()
```
  Create a new builder.
- toBuilder
```
public PrivilegedApiRequest.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the privilegedApi request.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  Name of the privilegedApi control.
  The name must be unique.
  
  Returns:
  
  the value
- getRequestId
```
public String getRequestId()
```
  This is an automatic identifier generated by the system which is easier for human comprehension.
  
  Returns:
  
  the value
- getReasonSummary
```
public String getReasonSummary()
```
  Summary comment by the operator creating the access request.
  
  Returns:
  
  the value
- getNotificationTopicId
```
public String getNotificationTopicId()
```
  The OCID of the OCI Notification topic to publish messages related to this privileged api request.
  
  Returns:
  
  the value
- getRequestedBy
```
public List<String> getRequestedBy()
```
  List of Users who has created this privilegedApiRequest.
  
  Returns:
  
  the value
- getResourceName
```
public String getResourceName()
```
  resourceName for which the PrivilegedApiRequest is applicable
  
  Returns:
  
  the value
- getResourceId
```
public String getResourceId()
```
  The OCID of the target resource associated with the access request.
  The operator raises an access request to get approval to access the target resource.
  
  Returns:
  
  the value
- getSubResourceNameList
```
public List<String> getSubResourceNameList()
```
  The subresource names requested for approval.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment that contains the access request.
  
  Returns:
  
  the value
- getResourceType
```
public String getResourceType()
```
  resourceType for which the AccessRequest is applicable
  
  Returns:
  
  the value
- getEntityType
```
public String getEntityType()
```
  entityType of resource for which the AccessRequest is applicable
  
  Returns:
  
  the value
- getPrivilegedOperationList
```
public List<PrivilegedApiRequestOperationDetails> getPrivilegedOperationList()
```
  List of api names, attributes for which approval is sought by the user.
  
  Returns:
  
  the value
- getReasonDetail
```
public String getReasonDetail()
```
  Reason in Detail for which the operator is requesting access on the target resource.
  
  Returns:
  
  the value
- getSeverity
```
public PrivilegedApiRequestSeverity getSeverity()
```
  Priority assigned to the access request by the operator
  
  Returns:
  
  the value
- getDurationInHrs
```
public Integer getDurationInHrs()
```
  Duration in hours for which access is sought on the target resource.
  
  Returns:
  
  the value
- getTicketNumbers
```
public List<String> getTicketNumbers()
```
  A list of ticket numbers related to this Privileged Api Access Request, e.g.
  Service Request (SR) number and JIRA ticket number.
  
  Returns:
  
  the value
- getState
```
public PrivilegedApiRequest.State getState()
```
  The current state of the Access Request.
  
  Returns:
  
  the value
- getStateDetails
```
public String getStateDetails()
```
  A message that describes the current state of the PrivilegedApiControl in more detail.
  For example, can be used to provide actionable information for a resource in the Failed state.
  
  Returns:
  
  the value
- getLifecycleState
```
public PrivilegedApiRequest.LifecycleState getLifecycleState()
```
  The current state of the PrivilegedApiRequest.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  more in detail about the lifeCycleState.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  Time when the privilegedApi request was created in RFC 3339timestamp format.
  Example: ‘2020-05-22T21:10:29.600Z’
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  Time when the privilegedApi request was last modified in RFC 3339timestamp format.
  Example: ‘2020-05-22T21:10:29.600Z’
  
  Returns:
  
  the value
- getClosureComment
```
public String getClosureComment()
```
  The comment entered by the operator while closing the request.
  
  Returns:
  
  the value
- getPrivilegedApiControlId
```
public String getPrivilegedApiControlId()
```
  The OCID of the privilegedApi control governing the target resource.
  
  Returns:
  
  the value
- getPrivilegedApiControlName
```
public String getPrivilegedApiControlName()
```
  Name of the privilegedApi control governing the target resource.
  
  Returns:
  
  the value
- getNumberOfApproversRequired
```
public Integer getNumberOfApproversRequired()
```
  Number of approvers required to approve an privilegedApi request.
  
  Returns:
  
  the value
- getApproverDetails
```
public List<ApproverDetail> getApproverDetails()
```
  Contains the approver details who have approved the privilegedApi Request during the initial request.
  
  Returns:
  
  the value
- getTimeRequestedForFutureAccess
```
public Date getTimeRequestedForFutureAccess()
```
  Time in future when the user for the privilegedApi request needs to be created in RFC 3339timestamp format.
  Example: ‘2020-05-22T21:10:29.600Z’
  
  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 PrivilegedApiRequest

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

PrivilegedApiRequest

Method Detail

builder

toBuilder

getId

getDisplayName

getRequestId

getReasonSummary

getNotificationTopicId

getRequestedBy

getResourceName

getResourceId

getSubResourceNameList

getCompartmentId

getResourceType

getEntityType

getPrivilegedOperationList

getReasonDetail

getSeverity

getDurationInHrs

getTicketNumbers

getState

getStateDetails

getLifecycleState

getLifecycleDetails

getTimeCreated

getTimeUpdated

getClosureComment

getPrivilegedApiControlId

getPrivilegedApiControlName

getNumberOfApproversRequired

getApproverDetails

getTimeRequestedForFutureAccess

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode