Package com.microsoft.graph.models

Class Payload

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.Payload
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class Payload extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

    • Payload

      public Payload()
      Instantiates a new Payload and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static Payload 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 Payload

    • getBrand

      @Nullable public PayloadBrand getBrand()
      Gets the brand property value. The branch of a payload. Possible values are: unknown, other, americanExpress, capitalOne, dhl, docuSign, dropbox, facebook, firstAmerican, microsoft, netflix, scotiabank, sendGrid, stewartTitle, tesco, wellsFargo, syrinxCloud, adobe, teams, zoom, unknownFutureValue.
      Returns:
      a PayloadBrand

    • getComplexity

      @Nullable public PayloadComplexity getComplexity()
      Gets the complexity property value. The complexity of a payload. Possible values are: unknown, low, medium, high, unknownFutureValue.
      Returns:
      a PayloadComplexity

    • getCreatedBy

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

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Date and time when the attack simulation and training campaign payload. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Returns:
      a OffsetDateTime

    • getDescription

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

    • getDetail

      @Nullable public PayloadDetail getDetail()
      Gets the detail property value. Additional details about the payload.
      Returns:
      a PayloadDetail

    • getDisplayName

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

    • 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>>

    • getIndustry

      @Nullable public PayloadIndustry getIndustry()
      Gets the industry property value. Industry of a payload. Possible values are: unknown, other, banking, businessServices, consumerServices, education, energy, construction, consulting, financialServices, government, hospitality, insurance, legal, courierServices, IT, healthcare, manufacturing, retail, telecom, realEstate, unknownFutureValue.
      Returns:
      a PayloadIndustry

    • getIsAutomated

      @Nullable public Boolean getIsAutomated()
      Gets the isAutomated property value. Indicates whether the attack simulation and training campaign payload was created from an automation flow. Supports $filter and $orderby.
      Returns:
      a Boolean

    • getIsControversial

      @Nullable public Boolean getIsControversial()
      Gets the isControversial property value. Indicates whether the payload is controversial.
      Returns:
      a Boolean

    • getIsCurrentEvent

      @Nullable public Boolean getIsCurrentEvent()
      Gets the isCurrentEvent property value. Indicates whether the payload is from any recent event.
      Returns:
      a Boolean

    • getLanguage

      @Nullable public String getLanguage()
      Gets the language property value. Payload language.
      Returns:
      a String

    • getLastModifiedBy

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

    • getLastModifiedDateTime

      @Nullable public OffsetDateTime getLastModifiedDateTime()
      Gets the lastModifiedDateTime property value. Date and time when the attack simulation and training campaign payload was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Returns:
      a OffsetDateTime

    • getPayloadTags

      @Nullable public List<String> getPayloadTags()
      Gets the payloadTags property value. Free text tags for a payload.
      Returns:
      a List<String>

    • getPlatform

      @Nullable public PayloadDeliveryPlatform getPlatform()
      Gets the platform property value. The payload delivery platform for a simulation. Possible values are: unknown, sms, email, teams, unknownFutureValue.
      Returns:
      a PayloadDeliveryPlatform

    • getPredictedCompromiseRate

      @Nullable public Double getPredictedCompromiseRate()
      Gets the predictedCompromiseRate property value. Predicted probability for a payload to phish a targeted user.
      Returns:
      a Double

    • getSimulationAttackType

      @Nullable public SimulationAttackType getSimulationAttackType()
      Gets the simulationAttackType 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

    • getSource

      @Nullable public SimulationContentSource getSource()
      Gets the source property value. The source property
      Returns:
      a SimulationContentSource

    • getStatus

      @Nullable public SimulationContentStatus getStatus()
      Gets the status property value. Simulation content status. Supports $filter and $orderby. Possible values are: unknown, draft, ready, archive, delete, unknownFutureValue.
      Returns:
      a SimulationContentStatus

    • getTechnique

      @Nullable public SimulationAttackTechnique getTechnique()
      Gets the technique 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

    • getTheme

      @Nullable public PayloadTheme getTheme()
      Gets the theme property value. The theme of a payload. Possible values are: unknown, other, accountActivation, accountVerification, billing, cleanUpMail, controversial, documentReceived, expense, fax, financeReport, incomingMessages, invoice, itemReceived, loginAlert, mailReceived, password, payment, payroll, personalizedOffer, quarantine, remoteWork, reviewMessage, securityUpdate, serviceSuspended, signatureRequired, upgradeMailboxStorage, verifyMailbox, voicemail, advertisement, employeeEngagement, unknownFutureValue.
      Returns:
      a PayloadTheme

    • 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

    • setBrand

      public void setBrand(@Nullable PayloadBrand value)
      Sets the brand property value. The branch of a payload. Possible values are: unknown, other, americanExpress, capitalOne, dhl, docuSign, dropbox, facebook, firstAmerican, microsoft, netflix, scotiabank, sendGrid, stewartTitle, tesco, wellsFargo, syrinxCloud, adobe, teams, zoom, unknownFutureValue.
      Parameters:
      value - Value to set for the brand property.

    • setComplexity

      public void setComplexity(@Nullable PayloadComplexity value)
      Sets the complexity property value. The complexity of a payload. Possible values are: unknown, low, medium, high, unknownFutureValue.
      Parameters:
      value - Value to set for the complexity 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 payload.
      Parameters:
      value - Value to set for the createdBy property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. Date and time when the attack simulation and training campaign payload. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      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 payload.
      Parameters:
      value - Value to set for the description property.

    • setDetail

      public void setDetail(@Nullable PayloadDetail value)
      Sets the detail property value. Additional details about the payload.
      Parameters:
      value - Value to set for the detail property.

    • setDisplayName

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

    • setIndustry

      public void setIndustry(@Nullable PayloadIndustry value)
      Sets the industry property value. Industry of a payload. Possible values are: unknown, other, banking, businessServices, consumerServices, education, energy, construction, consulting, financialServices, government, hospitality, insurance, legal, courierServices, IT, healthcare, manufacturing, retail, telecom, realEstate, unknownFutureValue.
      Parameters:
      value - Value to set for the industry property.

    • setIsAutomated

      public void setIsAutomated(@Nullable Boolean value)
      Sets the isAutomated property value. Indicates whether the attack simulation and training campaign payload was created from an automation flow. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the isAutomated property.

    • setIsControversial

      public void setIsControversial(@Nullable Boolean value)
      Sets the isControversial property value. Indicates whether the payload is controversial.
      Parameters:
      value - Value to set for the isControversial property.

    • setIsCurrentEvent

      public void setIsCurrentEvent(@Nullable Boolean value)
      Sets the isCurrentEvent property value. Indicates whether the payload is from any recent event.
      Parameters:
      value - Value to set for the isCurrentEvent property.

    • setLanguage

      public void setLanguage(@Nullable String value)
      Sets the language property value. Payload language.
      Parameters:
      value - Value to set for the language 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 payload.
      Parameters:
      value - Value to set for the lastModifiedBy property.

    • setLastModifiedDateTime

      public void setLastModifiedDateTime(@Nullable OffsetDateTime value)
      Sets the lastModifiedDateTime property value. Date and time when the attack simulation and training campaign payload was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
      Parameters:
      value - Value to set for the lastModifiedDateTime property.

    • setPayloadTags

      public void setPayloadTags(@Nullable List<String> value)
      Sets the payloadTags property value. Free text tags for a payload.
      Parameters:
      value - Value to set for the payloadTags property.

    • setPlatform

      public void setPlatform(@Nullable PayloadDeliveryPlatform value)
      Sets the platform property value. The payload delivery platform for a simulation. Possible values are: unknown, sms, email, teams, unknownFutureValue.
      Parameters:
      value - Value to set for the platform property.

    • setPredictedCompromiseRate

      public void setPredictedCompromiseRate(@Nullable Double value)
      Sets the predictedCompromiseRate property value. Predicted probability for a payload to phish a targeted user.
      Parameters:
      value - Value to set for the predictedCompromiseRate property.

    • setSimulationAttackType

      public void setSimulationAttackType(@Nullable SimulationAttackType value)
      Sets the simulationAttackType 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 simulationAttackType property.

    • setSource

      public void setSource(@Nullable SimulationContentSource value)
      Sets the source property value. The source property
      Parameters:
      value - Value to set for the source property.

    • setStatus

      public void setStatus(@Nullable SimulationContentStatus value)
      Sets the status property value. Simulation content status. Supports $filter and $orderby. Possible values are: unknown, draft, ready, archive, delete, unknownFutureValue.
      Parameters:
      value - Value to set for the status property.

    • setTechnique

      public void setTechnique(@Nullable SimulationAttackTechnique value)
      Sets the technique 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 technique property.

    • setTheme

      public void setTheme(@Nullable PayloadTheme value)
      Sets the theme property value. The theme of a payload. Possible values are: unknown, other, accountActivation, accountVerification, billing, cleanUpMail, controversial, documentReceived, expense, fax, financeReport, incomingMessages, invoice, itemReceived, loginAlert, mailReceived, password, payment, payroll, personalizedOffer, quarantine, remoteWork, reviewMessage, securityUpdate, serviceSuspended, signatureRequired, upgradeMailboxStorage, verifyMailbox, voicemail, advertisement, employeeEngagement, unknownFutureValue.
      Parameters:
      value - Value to set for the theme property.