BrokeredAccessRequest (safeguardjava 2.10.0 API)

java.lang.Object
- com.oneidentity.safeguard.safeguardjava.data.BrokeredAccessRequest

All Implemented Interfaces:

JsonObject
```
public class BrokeredAccessRequest
extends Object
implements JsonObject
```
This class is used to define a brokered access request.

Constructor Summary

Constructors
Constructor and Description

BrokeredAccessRequest()

Constructors
Constructor and Description
`BrokeredAccessRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BrokeredAccessRequestType`	`getAccessType()` Get the type of access request to create.
`Integer`	`getAccountAssetId()` Get the ID of the asset the account is from to create the access request for.
`String`	`getAccountAssetName()` Get the name of the asset the account is from to create the access request for.
`Integer`	`getAccountId()` Get the ID of the account to create the access request for.
`String`	`getAccountName()` Get the name of the account to create the access request for.
`Integer`	`getAssetId()` Get the ID of the asset to create the access request for.
`String`	`getAssetName()` Get the name of the asset to create the access request for.
`Integer`	`getForUserId()` Get the ID of the user to create the access request for.
`String`	`getForUserIdentityProvider()` Get the name of the identity provider to create the access request for.
`String`	`getForUserName()` Get the name of the user to create the access request for.
`boolean`	`getIsEmergency()` Whether or not this is an emergency access request.
`String`	`getReasonCode()` Get the name of the pre-defined reason code to include in the access request.
`Integer`	`getReasonCodeId()` Get the ID of the pre-defined reason code to include in the access request.
`String`	`getReasonComment()` Get a reason comment to include in the access request.
`Long`	`getRequestedDurationDays()` Get the number of days the access request should be requested for.
`Long`	`getRequestedDurationHours()` Get the number of hours the access request should be requested for.
`Long`	`getRequestedDurationMinutes()` Get the number of minutes the access request should be requested for.
`Instant`	`getRequestedFor()` Get the time when the access request should be requested for.
`String`	`getTicketNumber()` Get a ticket number associated with the new access request.
`void`	`setAccessType(BrokeredAccessRequestType AccessType)` Set the type of access request to create.
`void`	`setAccountAssetId(Integer AccountAssetId)` Set the ID of the asset the account is from to create the access request for.
`void`	`setAccountAssetName(String AccountAssetName)` Set the name of the asset the account is from to create the access request for.
`void`	`setAccountId(Integer AccountId)` Set the ID of the account to create the access request for.
`void`	`setAccountName(String AccountName)` Set the name of the account to create the access request for.
`void`	`setAssetId(Integer AssetId)` Set the ID of the asset to create the access request for.
`void`	`setAssetName(String AssetName)` Set the name of the asset to create the access request for.
`void`	`setForUserId(Integer ForUserId)` Set the ID of the user to create the access request for.
`void`	`setForUserIdentityProvider(String ForUserIdentityProvider)` Set the name of the identity provider to create the access request for.
`void`	`setForUserName(String ForUserName)` Set the name of the user to create the access request for.
`void`	`setIsEmergency(boolean IsEmergency)` Set whether or not this is an emergency access request.
`void`	`setReasonCode(String ReasonCode)` Set the name of the pre-defined reason code to include in the access request.
`void`	`setReasonCodeId(Integer ReasonCodeId)` Set the ID of the pre-defined reason code to include in the access request.
`void`	`setReasonComment(String ReasonComment)` Set a reason comment to include in the access request.
`void`	`setRequestedDurationDays(Long RequestedDurationDays)` Set the number of days the access request should be requested for.
`void`	`setRequestedDurationHours(Long RequestedDurationHours)` Set the number of hours the access request should be requested for.
`void`	`setRequestedDurationMinutes(Long RequestedDurationMinutes)` Set the number of minutes the access request should be requested for.
`void`	`setRequestedFor(Instant RequestedFor)` Set the time when the access request should be requested for.
`void`	`setTicketNumber(String TicketNumber)` Set a ticket number associated with the new access request.
`String`	`toJson()`

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

- Constructor Detail
  - BrokeredAccessRequest
```
public BrokeredAccessRequest()
```
- Method Detail
  - getAccessType
```
public BrokeredAccessRequestType getAccessType()
```
    Get the type of access request to create.
    
    Returns:
    
    BrokeredAccessRequestType
  - setAccessType
```
public void setAccessType(BrokeredAccessRequestType AccessType)
```
    Set the type of access request to create.
    
    Parameters:
    
    AccessType - BrokeredAccessRequestType
  - getForUserName
```
public String getForUserName()
```
    Get the name of the user to create the access request for. If the ForUserId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setForUserName
```
public void setForUserName(String ForUserName)
```
    Set the name of the user to create the access request for. If the ForUserId property is set, then this property will be ignored.
    
    Parameters:
    
    ForUserName - For user name
  - getForUserIdentityProvider
```
public String getForUserIdentityProvider()
```
    Get the name of the identity provider to create the access request for. If the ForUserId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setForUserIdentityProvider
```
public void setForUserIdentityProvider(String ForUserIdentityProvider)
```
    Set the name of the identity provider to create the access request for. If the ForUserId property is set, then this property will be ignored.
    
    Parameters:
    
    ForUserIdentityProvider - Identity provider
  - getForUserId
```
public Integer getForUserId()
```
    Get the ID of the user to create the access request for.
    
    Returns:
    
    Integer
  - setForUserId
```
public void setForUserId(Integer ForUserId)
```
    Set the ID of the user to create the access request for.
    
    Parameters:
    
    ForUserId - For user id.
  - getAssetName
```
public String getAssetName()
```
    Get the name of the asset to create the access request for. If the AssetId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setAssetName
```
public void setAssetName(String AssetName)
```
    Set the name of the asset to create the access request for. If the AssetId property is set, then this property will be ignored.
    
    Parameters:
    
    AssetName - Asset name.
  - getAssetId
```
public Integer getAssetId()
```
    Get the ID of the asset to create the access request for.
    
    Returns:
    
    Integer
  - setAssetId
```
public void setAssetId(Integer AssetId)
```
    Set the ID of the asset to create the access request for.
    
    Parameters:
    
    AssetId - Asset id.
  - getAccountName
```
public String getAccountName()
```
    Get the name of the account to create the access request for. If the AccountId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setAccountName
```
public void setAccountName(String AccountName)
```
    Set the name of the account to create the access request for. If the AccountId property is set, then this property will be ignored.
    
    Parameters:
    
    AccountName - Account name.
  - getAccountId
```
public Integer getAccountId()
```
    Get the ID of the account to create the access request for.
    
    Returns:
    
    Integer
  - setAccountId
```
public void setAccountId(Integer AccountId)
```
    Set the ID of the account to create the access request for.
    
    Parameters:
    
    AccountId - Account id.
  - getAccountAssetName
```
public String getAccountAssetName()
```
    Get the name of the asset the account is from to create the access request for. If the AccountAssetId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setAccountAssetName
```
public void setAccountAssetName(String AccountAssetName)
```
    Set the name of the asset the account is from to create the access request for. If the AccountAssetId property is set, then this property will be ignored.
    
    Parameters:
    
    AccountAssetName - Account asset name.
  - getAccountAssetId
```
public Integer getAccountAssetId()
```
    Get the ID of the asset the account is from to create the access request for.
    
    Returns:
    
    Integer
  - setAccountAssetId
```
public void setAccountAssetId(Integer AccountAssetId)
```
    Set the ID of the asset the account is from to create the access request for.
    
    Parameters:
    
    AccountAssetId - Account asset id.
  - getIsEmergency
```
public boolean getIsEmergency()
```
    Whether or not this is an emergency access request.
    
    Returns:
    
    boolean
  - setIsEmergency
```
public void setIsEmergency(boolean IsEmergency)
```
    Set whether or not this is an emergency access request.
    
    Parameters:
    
    IsEmergency - Is emergency
  - getReasonCode
```
public String getReasonCode()
```
    Get the name of the pre-defined reason code to include in the access request. If the ReasonCodeId property is set, then this property will be ignored.
    
    Returns:
    
    String
  - setReasonCode
```
public void setReasonCode(String ReasonCode)
```
    Set the name of the pre-defined reason code to include in the access request. If the ReasonCodeId property is set, then this property will be ignored.
    
    Parameters:
    
    ReasonCode - Reason code.
  - getReasonCodeId
```
public Integer getReasonCodeId()
```
    Get the ID of the pre-defined reason code to include in the access request.
    
    Returns:
    
    Integer
  - setReasonCodeId
```
public void setReasonCodeId(Integer ReasonCodeId)
```
    Set the ID of the pre-defined reason code to include in the access request.
    
    Parameters:
    
    ReasonCodeId - Reason code id.
  - getReasonComment
```
public String getReasonComment()
```
    Get a reason comment to include in the access request.
    
    Returns:
    
    String
  - setReasonComment
```
public void setReasonComment(String ReasonComment)
```
    Set a reason comment to include in the access request.
    
    Parameters:
    
    ReasonComment - Reason comment.
  - getTicketNumber
```
public String getTicketNumber()
```
    Get a ticket number associated with the new access request.
    
    Returns:
    
    String
  - setTicketNumber
```
public void setTicketNumber(String TicketNumber)
```
    Set a ticket number associated with the new access request.
    
    Parameters:
    
    TicketNumber - Ticket number.
  - getRequestedFor
```
public Instant getRequestedFor()
```
    Get the time when the access request should be requested for. All values will be converted to UTC date and time before being sent to the server.
    
    Returns:
    
    Instant
  - setRequestedFor
```
public void setRequestedFor(Instant RequestedFor)
```
    Set the time when the access request should be requested for. All values will be converted to UTC date and time before being sent to the server.
    
    Parameters:
    
    RequestedFor - Requested for.
  - getRequestedDurationDays
```
public Long getRequestedDurationDays()
```
    Get the number of days the access request should be requested for.
    
    Returns:
    
    Long
  - setRequestedDurationDays
```
public void setRequestedDurationDays(Long RequestedDurationDays)
```
    Set the number of days the access request should be requested for.
    
    Parameters:
    
    RequestedDurationDays - Requested duration days
  - getRequestedDurationHours
```
public Long getRequestedDurationHours()
```
    Get the number of hours the access request should be requested for.
    
    Returns:
    
    Long
  - setRequestedDurationHours
```
public void setRequestedDurationHours(Long RequestedDurationHours)
```
    Set the number of hours the access request should be requested for.
    
    Parameters:
    
    RequestedDurationHours - Requested duration hours
  - getRequestedDurationMinutes
```
public Long getRequestedDurationMinutes()
```
    Get the number of minutes the access request should be requested for.
    
    Returns:
    
    Long
  - setRequestedDurationMinutes
```
public void setRequestedDurationMinutes(Long RequestedDurationMinutes)
```
    Set the number of minutes the access request should be requested for.
    
    Parameters:
    
    RequestedDurationMinutes - Requested duration minutes
  - toJson
```
public String toJson()
```
    Specified by:
    
    toJson in interface JsonObject

Class BrokeredAccessRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrokeredAccessRequest

Method Detail

getAccessType

setAccessType

getForUserName

setForUserName

getForUserIdentityProvider

setForUserIdentityProvider

getForUserId

setForUserId

getAssetName

setAssetName

getAssetId

setAssetId

getAccountName

setAccountName

getAccountId

setAccountId

getAccountAssetName

setAccountAssetName

getAccountAssetId

setAccountAssetId

getIsEmergency

setIsEmergency

getReasonCode

setReasonCode

getReasonCodeId

setReasonCodeId

getReasonComment

setReasonComment

getTicketNumber

setTicketNumber

getRequestedFor

setRequestedFor

getRequestedDurationDays

setRequestedDurationDays

getRequestedDurationHours

setRequestedDurationHours

getRequestedDurationMinutes

setRequestedDurationMinutes

toJson