Package com.azure.resourcemanager.storage.models

Class StorageTaskReportProperties

java.lang.Object
com.azure.resourcemanager.storage.models.StorageTaskReportProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<StorageTaskReportProperties>
public final class StorageTaskReportProperties extends Object implements com.azure.json.JsonSerializable<StorageTaskReportProperties>
Storage task execution report for a run instance.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StorageTaskReportProperties()
    Creates an instance of StorageTaskReportProperties class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    finishTime()
    Get the finishTime property: End time of the run instance.
    static StorageTaskReportProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of StorageTaskReportProperties from the JsonReader.
    String
    objectFailedCount()
    Get the objectFailedCount property: Total number of objects where task operation failed when was attempted.
    String
    objectsOperatedOnCount()
    Get the objectsOperatedOnCount property: Total number of objects that meet the storage tasks condition and were operated upon.
    String
    objectsSucceededCount()
    Get the objectsSucceededCount property: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
    String
    objectsTargetedCount()
    Get the objectsTargetedCount property: Total number of objects that meet the condition as defined in the storage task assignment execution context.
    RunResult
    runResult()
    Get the runResult property: Represents the overall result of the execution for the run instance.
    RunStatusEnum
    runStatusEnum()
    Get the runStatusEnum property: Represents the status of the execution.
    String
    runStatusError()
    Get the runStatusError property: Well known Azure Storage error code that represents the error encountered during execution of the run instance.
    String
    startTime()
    Get the startTime property: Start time of the run instance.
    String
    storageAccountId()
    Get the storageAccountId property: Represents the Storage Account Id where the storage task definition was applied and executed.
    String
    summaryReportPath()
    Get the summaryReportPath property: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.
    String
    taskAssignmentId()
    Get the taskAssignmentId property: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context.
    String
    taskId()
    Get the taskId property: Storage Task Arm Id.
    String
    taskVersion()
    Get the taskVersion property: Storage Task Version.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • StorageTaskReportProperties

      public StorageTaskReportProperties()
      Creates an instance of StorageTaskReportProperties class.

  • Method Details

    • taskAssignmentId

      public String taskAssignmentId()
      Get the taskAssignmentId property: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context.
      Returns:
      the taskAssignmentId value.

    • storageAccountId

      public String storageAccountId()
      Get the storageAccountId property: Represents the Storage Account Id where the storage task definition was applied and executed.
      Returns:
      the storageAccountId value.

    • startTime

      public String startTime()
      Get the startTime property: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the startTime value.

    • finishTime

      public String finishTime()
      Get the finishTime property: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the finishTime value.

    • objectsTargetedCount

      public String objectsTargetedCount()
      Get the objectsTargetedCount property: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the objectsTargetedCount value.

    • objectsOperatedOnCount

      public String objectsOperatedOnCount()
      Get the objectsOperatedOnCount property: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the objectsOperatedOnCount value.

    • objectFailedCount

      public String objectFailedCount()
      Get the objectFailedCount property: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the objectFailedCount value.

    • objectsSucceededCount

      public String objectsSucceededCount()
      Get the objectsSucceededCount property: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.
      Returns:
      the objectsSucceededCount value.

    • runStatusError

      public String runStatusError()
      Get the runStatusError property: Well known Azure Storage error code that represents the error encountered during execution of the run instance.
      Returns:
      the runStatusError value.

    • runStatusEnum

      public RunStatusEnum runStatusEnum()
      Get the runStatusEnum property: Represents the status of the execution.
      Returns:
      the runStatusEnum value.

    • summaryReportPath

      public String summaryReportPath()
      Get the summaryReportPath property: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.
      Returns:
      the summaryReportPath value.

    • taskId

      public String taskId()
      Get the taskId property: Storage Task Arm Id.
      Returns:
      the taskId value.

    • taskVersion

      public String taskVersion()
      Get the taskVersion property: Storage Task Version.
      Returns:
      the taskVersion value.

    • runResult

      public RunResult runResult()
      Get the runResult property: Represents the overall result of the execution for the run instance.
      Returns:
      the runResult value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<StorageTaskReportProperties>
      Throws:
      IOException

    • fromJson

      public static StorageTaskReportProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of StorageTaskReportProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of StorageTaskReportProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the StorageTaskReportProperties.