Package com.oracle.bmc.delegateaccesscontrol.model

Class DelegatedResourceAccessRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230801")
public final class DelegatedResourceAccessRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A support operator raises Delegated Resource Access Request when they need access to any infrastructure resource governed by Delegation Control.

    The Delegated Resource Access Request identifies the target resource and the set of Service Provider Actions. Delegated Resource Access Request handling depends upon the Delegation Control that governs the target resource, and the set of Service Provider Actions listed for approval in the Delegated Resource Access Request. If all of the Service Provider Actions listed in the Delegated Resource Access Request are in the pre-approved list in the Delegation Control that governs the target resource, then the Delegated Resource Access Request is automatically approved. If not, then the Delegated Resource Access Request requires explicit approval from the approver group specified by the Delegation Control governing the target resource.

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

    • Method Detail

      • getId

        public String getId()
        The OCID of the Delegated Resource Access Request.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the Delegated Resource Access Request.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Display name.

        This is generated by the system automatically.

        Returns:
        the value

      • getTicketNumbers

        public List<String> getTicketNumbers()
        A list of ticket numbers related to this Delegated Resource Access Request, e.g.

        Service Request (SR) number and JIRA ticket number.

        Returns:
        the value

      • getReasonForRequest

        public String getReasonForRequest()
        A short description explaining why this Delegated Resource Access Request is needed by the support operator.
        Returns:
        the value

      • getDescription

        public String getDescription()
        Detailed description of this Delegated Resource Access Request.
        Returns:
        the value

      • getTimeAccessRequested

        public Date getTimeAccessRequested()
        Requested access start time in UTC.
        Returns:
        the value

      • getResourceId

        public String getResourceId()
        The OCID of the target resource associated with the Delegated Resource Access Request.

        The support operator raises a Delegated Resource Access Request to get approval to access the target resource.

        Returns:
        the value

      • getResourceName

        public String getResourceName()
        The name of the target resource associated with the Delegated Resource Access Request.

        The support operator raises a Delegated Resource Access Request to get approval to access the target resource.

        Returns:
        the value

      • getResourceType

        public DelegationControlResourceType getResourceType()
        Resource type for which the associated Delegation Control is applicable to.
        Returns:
        the value

      • getRequestedActionNames

        public List<String> getRequestedActionNames()
        List of Service Provider Action names for which approval is sought by the support operator user.

        The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API.

        Returns:
        the value

      • getDatabaseNameList

        public List<String> getDatabaseNameList()
        List of Database unique names for which access is requested.

        This parameter is required for DLGT_MGMT_SYS_MAINT_ACCESS cage when database access in needed.

        Returns:
        the value

      • getProvidedServiceTypes

        public List<ServiceProviderServiceType> getProvidedServiceTypes()
        List of Service Provider Service Types being provided by the support operator user.
        Returns:
        the value

      • getDelegationSubscriptionIds

        public List<String> getDelegationSubscriptionIds()
        List of Delegation Subscription OCID that are associated with this Delegated Resource Access Request based on the service types being requested.
        Returns:
        the value

      • getDurationInHours

        public Integer getDurationInHours()
        Duration in hours for which access is sought on the target resource.
        Returns:
        the value

      • getExtendDurationInHours

        public Integer getExtendDurationInHours()
        Duration in hours for which extension access is sought on the target resource.
        Returns:
        the value

      • getIsAutoApproved

        public Boolean getIsAutoApproved()
        Set to true if the request is approved automatically based on preApprovedServiceProviderActionNames or isAutoApproveDuringMaintenance in the associated 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 Delegated Resource Access Request was created in RFC 3339timestamp format, e.g.

        ‘2020-05-22T21:10:29.600Z’.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        Time when the Delegated Resource Access Request was last modified in RFC 3339timestamp format, e.g.

        ‘2020-05-22T21:10:29.600Z’.

        Returns:
        the value

      • getNumInitialApprovals

        public Integer getNumInitialApprovals()
        Number of initial approvals that have been obtained so far.
        Returns:
        the value

      • getNumExtensionApprovals

        public Integer getNumExtensionApprovals()
        Number of extension approvals that have been obtained so far.
        Returns:
        the value

      • getClosureComment

        public String getClosureComment()
        The comment entered by the support operator while closing the request.
        Returns:
        the value

      • getDelegationControlId

        public String getDelegationControlId()
        The OCID of the Delegation Control governing the target resource.
        Returns:
        the value

      • getAuditTypes

        public List<DelegatedResourceAccessRequestAuditType> getAuditTypes()
        Specifies the type of auditing to be enabled.

        There are two levels of auditing: command-level and keystroke-level. By default, both command-level and keystroke-level auditing are enabled, i.e. commands and key strokes issued by the support operator are logged.

        Returns:
        the value

      • getIsPendingMoreInfo

        public Boolean getIsPendingMoreInfo()
        Indicates if the delegated resource access request is waiting on more information from the operator
        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