Package com.oracle.bmc.apiaccesscontrol.model

Class PrivilegedApiRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public PrivilegedApiRequest.Builder displayName​(String displayName)
        Name of the privilegedApi control.

        The name must be unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • requestId

        public PrivilegedApiRequest.Builder requestId​(String requestId)
        This is an automatic identifier generated by the system which is easier for human comprehension.
        Parameters:
        requestId - the value to set
        Returns:
        this builder

      • reasonSummary

        public PrivilegedApiRequest.Builder reasonSummary​(String reasonSummary)
        Summary comment by the operator creating the access request.
        Parameters:
        reasonSummary - the value to set
        Returns:
        this builder

      • notificationTopicId

        public PrivilegedApiRequest.Builder notificationTopicId​(String notificationTopicId)
        The OCID of the OCI Notification topic to publish messages related to this privileged api request.
        Parameters:
        notificationTopicId - the value to set
        Returns:
        this builder

      • requestedBy

        public PrivilegedApiRequest.Builder requestedBy​(List<String> requestedBy)
        List of Users who has created this privilegedApiRequest.
        Parameters:
        requestedBy - the value to set
        Returns:
        this builder

      • resourceName

        public PrivilegedApiRequest.Builder resourceName​(String resourceName)
        resourceName for which the PrivilegedApiRequest is applicable
        Parameters:
        resourceName - the value to set
        Returns:
        this builder

      • resourceId

        public PrivilegedApiRequest.Builder resourceId​(String resourceId)
        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.

        Parameters:
        resourceId - the value to set
        Returns:
        this builder

      • subResourceNameList

        public PrivilegedApiRequest.Builder subResourceNameList​(List<String> subResourceNameList)
        The subresource names requested for approval.
        Parameters:
        subResourceNameList - the value to set
        Returns:
        this builder

      • compartmentId

        public PrivilegedApiRequest.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the access request.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • resourceType

        public PrivilegedApiRequest.Builder resourceType​(String resourceType)
        resourceType for which the AccessRequest is applicable
        Parameters:
        resourceType - the value to set
        Returns:
        this builder

      • entityType

        public PrivilegedApiRequest.Builder entityType​(String entityType)
        entityType of resource for which the AccessRequest is applicable
        Parameters:
        entityType - the value to set
        Returns:
        this builder

      • reasonDetail

        public PrivilegedApiRequest.Builder reasonDetail​(String reasonDetail)
        Reason in Detail for which the operator is requesting access on the target resource.
        Parameters:
        reasonDetail - the value to set
        Returns:
        this builder

      • durationInHrs

        public PrivilegedApiRequest.Builder durationInHrs​(Integer durationInHrs)
        Duration in hours for which access is sought on the target resource.
        Parameters:
        durationInHrs - the value to set
        Returns:
        this builder

      • ticketNumbers

        public PrivilegedApiRequest.Builder ticketNumbers​(List<String> ticketNumbers)
        A list of ticket numbers related to this Privileged Api Access Request, e.g.

        Service Request (SR) number and JIRA ticket number.

        Parameters:
        ticketNumbers - the value to set
        Returns:
        this builder

      • stateDetails

        public PrivilegedApiRequest.Builder stateDetails​(String stateDetails)
        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.

        Parameters:
        stateDetails - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public PrivilegedApiRequest.Builder lifecycleDetails​(String lifecycleDetails)
        more in detail about the lifeCycleState.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • timeCreated

        public PrivilegedApiRequest.Builder timeCreated​(Date timeCreated)
        Time when the privilegedApi request was created in RFC 3339timestamp format.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public PrivilegedApiRequest.Builder timeUpdated​(Date timeUpdated)
        Time when the privilegedApi request was last modified in RFC 3339timestamp format.

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

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • closureComment

        public PrivilegedApiRequest.Builder closureComment​(String closureComment)
        The comment entered by the operator while closing the request.
        Parameters:
        closureComment - the value to set
        Returns:
        this builder

      • privilegedApiControlId

        public PrivilegedApiRequest.Builder privilegedApiControlId​(String privilegedApiControlId)
        The OCID of the privilegedApi control governing the target resource.
        Parameters:
        privilegedApiControlId - the value to set
        Returns:
        this builder

      • privilegedApiControlName

        public PrivilegedApiRequest.Builder privilegedApiControlName​(String privilegedApiControlName)
        Name of the privilegedApi control governing the target resource.
        Parameters:
        privilegedApiControlName - the value to set
        Returns:
        this builder

      • numberOfApproversRequired

        public PrivilegedApiRequest.Builder numberOfApproversRequired​(Integer numberOfApproversRequired)
        Number of approvers required to approve an privilegedApi request.
        Parameters:
        numberOfApproversRequired - the value to set
        Returns:
        this builder

      • approverDetails

        public PrivilegedApiRequest.Builder approverDetails​(List<ApproverDetail> approverDetails)
        Contains the approver details who have approved the privilegedApi Request during the initial request.
        Parameters:
        approverDetails - the value to set
        Returns:
        this builder

      • timeRequestedForFutureAccess

        public PrivilegedApiRequest.Builder timeRequestedForFutureAccess​(Date timeRequestedForFutureAccess)
        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’

        Parameters:
        timeRequestedForFutureAccess - the value to set
        Returns:
        this builder

      • freeformTags

        public PrivilegedApiRequest.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public PrivilegedApiRequest.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public PrivilegedApiRequest.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder