Class Simulation

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.Simulation
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel

@Generated("com.microsoft.kiota") public class Simulation extends Entity implements com.microsoft.kiota.serialization.Parsable
  • Constructor Details

    • Simulation

      public Simulation()
      Instantiates a new Simulation and sets the default values.
  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static Simulation createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a Simulation
    • getAttackTechnique

      @Nullable public SimulationAttackTechnique getAttackTechnique()
      Gets the attackTechnique property value. The social engineering technique used in the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, credentialHarvesting, attachmentMalware, driveByUrl, linkInAttachment, linkToMalwareFile, unknownFutureValue, oAuthConsentGrant. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: oAuthConsentGrant. For more information on the types of social engineering attack techniques, see simulations.
      Returns:
      a SimulationAttackTechnique
    • getAttackType

      @Nullable public SimulationAttackType getAttackType()
      Gets the attackType property value. Attack type of the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, social, cloud, endpoint, unknownFutureValue.
      Returns:
      a SimulationAttackType
    • getAutomationId

      @Nullable public String getAutomationId()
      Gets the automationId property value. Unique identifier for the attack simulation automation.
      Returns:
      a String
    • getCompletionDateTime

      @Nullable public OffsetDateTime getCompletionDateTime()
      Gets the completionDateTime property value. Date and time of completion of the attack simulation and training campaign. Supports $filter and $orderby.
      Returns:
      a OffsetDateTime
    • getCreatedBy

      @Nullable public EmailIdentity getCreatedBy()
      Gets the createdBy property value. Identity of the user who created the attack simulation and training campaign.
      Returns:
      a EmailIdentity
    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Date and time of creation of the attack simulation and training campaign.
      Returns:
      a OffsetDateTime
    • getDescription

      @Nullable public String getDescription()
      Gets the description property value. Description of the attack simulation and training campaign.
      Returns:
      a String
    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. Display name of the attack simulation and training campaign. Supports $filter and $orderby.
      Returns:
      a String
    • getDurationInDays

      @Nullable public Integer getDurationInDays()
      Gets the durationInDays property value. Simulation duration in days.
      Returns:
      a Integer
    • getEndUserNotificationSetting

      @Nullable public EndUserNotificationSetting getEndUserNotificationSetting()
      Gets the endUserNotificationSetting property value. Details about the end user notification setting.
      Returns:
      a EndUserNotificationSetting
    • getExcludedAccountTarget

      @Nullable public AccountTargetContent getExcludedAccountTarget()
      Gets the excludedAccountTarget property value. Users excluded from the simulation.
      Returns:
      a AccountTargetContent
    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>
    • getIncludedAccountTarget

      @Nullable public AccountTargetContent getIncludedAccountTarget()
      Gets the includedAccountTarget property value. Users targeted in the simulation.
      Returns:
      a AccountTargetContent
    • getIsAutomated

      @Nullable public Boolean getIsAutomated()
      Gets the isAutomated property value. Flag that represents if the attack simulation and training campaign was created from a simulation automation flow. Supports $filter and $orderby.
      Returns:
      a Boolean
    • getLandingPage

      @Nullable public LandingPage getLandingPage()
      Gets the landingPage property value. The landing page associated with a simulation during its creation.
      Returns:
      a LandingPage
    • getLastModifiedBy

      @Nullable public EmailIdentity getLastModifiedBy()
      Gets the lastModifiedBy property value. Identity of the user who most recently modified the attack simulation and training campaign.
      Returns:
      a EmailIdentity
    • getLastModifiedDateTime

      @Nullable public OffsetDateTime getLastModifiedDateTime()
      Gets the lastModifiedDateTime property value. Date and time of the most recent modification of the attack simulation and training campaign.
      Returns:
      a OffsetDateTime
    • getLaunchDateTime

      @Nullable public OffsetDateTime getLaunchDateTime()
      Gets the launchDateTime property value. Date and time of the launch/start of the attack simulation and training campaign. Supports $filter and $orderby.
      Returns:
      a OffsetDateTime
    • getLoginPage

      @Nullable public LoginPage getLoginPage()
      Gets the loginPage property value. The login page associated with a simulation during its creation.
      Returns:
      a LoginPage
    • getOAuthConsentAppDetail

      @Nullable public OAuthConsentAppDetail getOAuthConsentAppDetail()
      Gets the oAuthConsentAppDetail property value. OAuth app details for the OAuth technique.
      Returns:
      a OAuthConsentAppDetail
    • getPayload

      @Nullable public Payload getPayload()
      Gets the payload property value. The payload associated with a simulation during its creation.
      Returns:
      a Payload
    • getPayloadDeliveryPlatform

      @Nullable public PayloadDeliveryPlatform getPayloadDeliveryPlatform()
      Gets the payloadDeliveryPlatform property value. Method of delivery of the phishing payload used in the attack simulation and training campaign. Possible values are: unknown, sms, email, teams, unknownFutureValue.
      Returns:
      a PayloadDeliveryPlatform
    • getReport

      @Nullable public SimulationReport getReport()
      Gets the report property value. Report of the attack simulation and training campaign.
      Returns:
      a SimulationReport
    • getStatus

      @Nullable public SimulationStatus getStatus()
      Gets the status property value. Status of the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, draft, running, scheduled, succeeded, failed, cancelled, excluded, unknownFutureValue.
      Returns:
      a SimulationStatus
    • getTrainingSetting

      @Nullable public TrainingSetting getTrainingSetting()
      Gets the trainingSetting property value. Details about the training settings for a simulation.
      Returns:
      a TrainingSetting
    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model
    • setAttackTechnique

      public void setAttackTechnique(@Nullable SimulationAttackTechnique value)
      Sets the attackTechnique property value. The social engineering technique used in the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, credentialHarvesting, attachmentMalware, driveByUrl, linkInAttachment, linkToMalwareFile, unknownFutureValue, oAuthConsentGrant. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: oAuthConsentGrant. For more information on the types of social engineering attack techniques, see simulations.
      Parameters:
      value - Value to set for the attackTechnique property.
    • setAttackType

      public void setAttackType(@Nullable SimulationAttackType value)
      Sets the attackType property value. Attack type of the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, social, cloud, endpoint, unknownFutureValue.
      Parameters:
      value - Value to set for the attackType property.
    • setAutomationId

      public void setAutomationId(@Nullable String value)
      Sets the automationId property value. Unique identifier for the attack simulation automation.
      Parameters:
      value - Value to set for the automationId property.
    • setCompletionDateTime

      public void setCompletionDateTime(@Nullable OffsetDateTime value)
      Sets the completionDateTime property value. Date and time of completion of the attack simulation and training campaign. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the completionDateTime property.
    • setCreatedBy

      public void setCreatedBy(@Nullable EmailIdentity value)
      Sets the createdBy property value. Identity of the user who created the attack simulation and training campaign.
      Parameters:
      value - Value to set for the createdBy property.
    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. Date and time of creation of the attack simulation and training campaign.
      Parameters:
      value - Value to set for the createdDateTime property.
    • setDescription

      public void setDescription(@Nullable String value)
      Sets the description property value. Description of the attack simulation and training campaign.
      Parameters:
      value - Value to set for the description property.
    • setDisplayName

      public void setDisplayName(@Nullable String value)
      Sets the displayName property value. Display name of the attack simulation and training campaign. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the displayName property.
    • setDurationInDays

      public void setDurationInDays(@Nullable Integer value)
      Sets the durationInDays property value. Simulation duration in days.
      Parameters:
      value - Value to set for the durationInDays property.
    • setEndUserNotificationSetting

      public void setEndUserNotificationSetting(@Nullable EndUserNotificationSetting value)
      Sets the endUserNotificationSetting property value. Details about the end user notification setting.
      Parameters:
      value - Value to set for the endUserNotificationSetting property.
    • setExcludedAccountTarget

      public void setExcludedAccountTarget(@Nullable AccountTargetContent value)
      Sets the excludedAccountTarget property value. Users excluded from the simulation.
      Parameters:
      value - Value to set for the excludedAccountTarget property.
    • setIncludedAccountTarget

      public void setIncludedAccountTarget(@Nullable AccountTargetContent value)
      Sets the includedAccountTarget property value. Users targeted in the simulation.
      Parameters:
      value - Value to set for the includedAccountTarget property.
    • setIsAutomated

      public void setIsAutomated(@Nullable Boolean value)
      Sets the isAutomated property value. Flag that represents if the attack simulation and training campaign was created from a simulation automation flow. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the isAutomated property.
    • setLandingPage

      public void setLandingPage(@Nullable LandingPage value)
      Sets the landingPage property value. The landing page associated with a simulation during its creation.
      Parameters:
      value - Value to set for the landingPage property.
    • setLastModifiedBy

      public void setLastModifiedBy(@Nullable EmailIdentity value)
      Sets the lastModifiedBy property value. Identity of the user who most recently modified the attack simulation and training campaign.
      Parameters:
      value - Value to set for the lastModifiedBy property.
    • setLastModifiedDateTime

      public void setLastModifiedDateTime(@Nullable OffsetDateTime value)
      Sets the lastModifiedDateTime property value. Date and time of the most recent modification of the attack simulation and training campaign.
      Parameters:
      value - Value to set for the lastModifiedDateTime property.
    • setLaunchDateTime

      public void setLaunchDateTime(@Nullable OffsetDateTime value)
      Sets the launchDateTime property value. Date and time of the launch/start of the attack simulation and training campaign. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the launchDateTime property.
    • setLoginPage

      public void setLoginPage(@Nullable LoginPage value)
      Sets the loginPage property value. The login page associated with a simulation during its creation.
      Parameters:
      value - Value to set for the loginPage property.
    • setOAuthConsentAppDetail

      public void setOAuthConsentAppDetail(@Nullable OAuthConsentAppDetail value)
      Sets the oAuthConsentAppDetail property value. OAuth app details for the OAuth technique.
      Parameters:
      value - Value to set for the oAuthConsentAppDetail property.
    • setPayload

      public void setPayload(@Nullable Payload value)
      Sets the payload property value. The payload associated with a simulation during its creation.
      Parameters:
      value - Value to set for the payload property.
    • setPayloadDeliveryPlatform

      public void setPayloadDeliveryPlatform(@Nullable PayloadDeliveryPlatform value)
      Sets the payloadDeliveryPlatform property value. Method of delivery of the phishing payload used in the attack simulation and training campaign. Possible values are: unknown, sms, email, teams, unknownFutureValue.
      Parameters:
      value - Value to set for the payloadDeliveryPlatform property.
    • setReport

      public void setReport(@Nullable SimulationReport value)
      Sets the report property value. Report of the attack simulation and training campaign.
      Parameters:
      value - Value to set for the report property.
    • setStatus

      public void setStatus(@Nullable SimulationStatus value)
      Sets the status property value. Status of the attack simulation and training campaign. Supports $filter and $orderby. Possible values are: unknown, draft, running, scheduled, succeeded, failed, cancelled, excluded, unknownFutureValue.
      Parameters:
      value - Value to set for the status property.
    • setTrainingSetting

      public void setTrainingSetting(@Nullable TrainingSetting value)
      Sets the trainingSetting property value. Details about the training settings for a simulation.
      Parameters:
      value - Value to set for the trainingSetting property.