Class AuditEvent

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class AuditEvent
    extends Entity
    implements com.github.davidmoten.odata.client.ODataEntityType
    “A class containing the properties for Audit Event.”
    • Field Detail

      • activity

        protected String activity
      • activityOperationType

        protected String activityOperationType
      • activityResult

        protected String activityResult
      • activityType

        protected String activityType
      • category

        protected String category
      • componentName

        protected String componentName
      • correlationId

        protected UUID correlationId
      • displayName

        protected String displayName
      • resourcesNextLink

        protected String resourcesNextLink
    • Constructor Detail

      • AuditEvent

        protected AuditEvent()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class Entity
      • builderAuditEvent

        public static AuditEvent.Builder builderAuditEvent()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class Entity
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class Entity
      • getActivity

        public Optional<String> getActivity()
        “Friendly name of the activity.”
        Returns:
        property activity
      • withActivity

        public AuditEvent withActivity​(String activity)
        Returns an immutable copy of this with just the activity field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Friendly name of the activity.”

        Parameters:
        activity - new value of activity field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activity field changed
      • getActivityDateTime

        public Optional<OffsetDateTime> getActivityDateTime()
        “The date time in UTC when the activity was performed.”
        Returns:
        property activityDateTime
      • withActivityDateTime

        public AuditEvent withActivityDateTime​(OffsetDateTime activityDateTime)
        Returns an immutable copy of this with just the activityDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The date time in UTC when the activity was performed.”

        Parameters:
        activityDateTime - new value of activityDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activityDateTime field changed
      • getActivityOperationType

        public Optional<String> getActivityOperationType()
        “The HTTP operation type of the activity.”
        Returns:
        property activityOperationType
      • withActivityOperationType

        public AuditEvent withActivityOperationType​(String activityOperationType)
        Returns an immutable copy of this with just the activityOperationType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The HTTP operation type of the activity.”

        Parameters:
        activityOperationType - new value of activityOperationType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activityOperationType field changed
      • getActivityResult

        public Optional<String> getActivityResult()
        “The result of the activity.”
        Returns:
        property activityResult
      • withActivityResult

        public AuditEvent withActivityResult​(String activityResult)
        Returns an immutable copy of this with just the activityResult field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The result of the activity.”

        Parameters:
        activityResult - new value of activityResult field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activityResult field changed
      • getActivityType

        public Optional<String> getActivityType()
        “The type of activity that was being performed.”
        Returns:
        property activityType
      • withActivityType

        public AuditEvent withActivityType​(String activityType)
        Returns an immutable copy of this with just the activityType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The type of activity that was being performed.”

        Parameters:
        activityType - new value of activityType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activityType field changed
      • getActor

        public Optional<AuditActor> getActor()
        “AAD user and application that are associated with the audit event.”
        Returns:
        property actor
      • withActor

        public AuditEvent withActor​(AuditActor actor)
        Returns an immutable copy of this with just the actor field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “AAD user and application that are associated with the audit event.”

        Parameters:
        actor - new value of actor field (as defined in service metadata)
        Returns:
        immutable copy of this with just the actor field changed
      • getCategory

        public Optional<String> getCategory()
        “Audit category.”
        Returns:
        property category
      • withCategory

        public AuditEvent withCategory​(String category)
        Returns an immutable copy of this with just the category field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Audit category.”

        Parameters:
        category - new value of category field (as defined in service metadata)
        Returns:
        immutable copy of this with just the category field changed
      • getComponentName

        public Optional<String> getComponentName()
        “Component name.”
        Returns:
        property componentName
      • withComponentName

        public AuditEvent withComponentName​(String componentName)
        Returns an immutable copy of this with just the componentName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Component name.”

        Parameters:
        componentName - new value of componentName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the componentName field changed
      • getCorrelationId

        public Optional<UUID> getCorrelationId()
        “The client request Id that is used to correlate activity within the system.”
        Returns:
        property correlationId
      • withCorrelationId

        public AuditEvent withCorrelationId​(UUID correlationId)
        Returns an immutable copy of this with just the correlationId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The client request Id that is used to correlate activity within the system.”

        Parameters:
        correlationId - new value of correlationId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the correlationId field changed
      • getDisplayName

        public Optional<String> getDisplayName()
        “Event display name.”
        Returns:
        property displayName
      • withDisplayName

        public AuditEvent withDisplayName​(String displayName)
        Returns an immutable copy of this with just the displayName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Event display name.”

        Parameters:
        displayName - new value of displayName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the displayName field changed
      • getResources

        public com.github.davidmoten.odata.client.CollectionPage<AuditResource> getResources()
        “Resources being modified.”
        Returns:
        property resources
      • withResources

        public AuditEvent withResources​(List<AuditResource> resources)
        Returns an immutable copy of this with just the resources field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Resources being modified.”

        Parameters:
        resources - new value of resources field (as defined in service metadata)
        Returns:
        immutable copy of this with just the resources field changed
      • getResources

        public com.github.davidmoten.odata.client.CollectionPage<AuditResource> getResources​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Resources being modified.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property resources
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class Entity
      • patch

        public AuditEvent patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public AuditEvent put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected