Package com.azure.resourcemanager.costmanagement.models

Interface Export

public interface Export
An immutable client-side representation of Export.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Export.Definition
    The entirety of the Export definition.
    static interface 
    Export.DefinitionStages
    The Export definition stages.
    static interface 
    Export.Update
    The template for Export update.
    static interface 
    Export.UpdateStages
    The Export update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    ExportDefinition
    definition()
    Gets the definition property: Has the definition for the export.
    ExportDeliveryInfo
    deliveryInfo()
    Gets the deliveryInfo property: Has delivery information for the export.
    String
    etag()
    Gets the etag property: eTag of the resource.
    void
    execute()
    The operation to run an export.
    com.azure.core.http.rest.Response<Void>
    executeWithResponse(com.azure.core.util.Context context)
    The operation to run an export.
    FormatType
    format()
    Gets the format property: The format of the export being delivered.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    ExportInner
    innerModel()
    Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ExportInner object.
    String
    name()
    Gets the name property: The name of the resource.
    OffsetDateTime
    nextRunTimeEstimate()
    Gets the nextRunTimeEstimate property: If the export has an active schedule, provides an estimate of the next run time.
    Boolean
    partitionData()
    Gets the partitionData property: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file.
    Export
    refresh()
    Refreshes the resource to sync with Azure.
    Export
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    ExportExecutionListResult
    runHistory()
    Gets the runHistory property: If requested, has the most recent run history for the export.
    ExportSchedule
    schedule()
    Gets the schedule property: Has schedule information for the export.
    String
    type()
    Gets the type property: The type of the resource.
    Export.Update
    update()
    Begins update for the Export resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • etag

      String etag()
      Gets the etag property: eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
      Returns:
      the etag value.

    • schedule

      ExportSchedule schedule()
      Gets the schedule property: Has schedule information for the export.
      Returns:
      the schedule value.

    • format

      FormatType format()
      Gets the format property: The format of the export being delivered. Currently only 'Csv' is supported.
      Returns:
      the format value.

    • deliveryInfo

      ExportDeliveryInfo deliveryInfo()
      Gets the deliveryInfo property: Has delivery information for the export.
      Returns:
      the deliveryInfo value.

    • definition

      ExportDefinition definition()
      Gets the definition property: Has the definition for the export.
      Returns:
      the definition value.

    • runHistory

      ExportExecutionListResult runHistory()
      Gets the runHistory property: If requested, has the most recent run history for the export.
      Returns:
      the runHistory value.

    • partitionData

      Boolean partitionData()
      Gets the partitionData property: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes.
      Returns:
      the partitionData value.

    • nextRunTimeEstimate

      OffsetDateTime nextRunTimeEstimate()
      Gets the nextRunTimeEstimate property: If the export has an active schedule, provides an estimate of the next run time.
      Returns:
      the nextRunTimeEstimate value.

    • innerModel

      ExportInner innerModel()
      Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ExportInner object.
      Returns:
      the inner object.

    • update

      Export.Update update()
      Begins update for the Export resource.
      Returns:
      the stage of resource update.

    • refresh

      Export refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Export refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • executeWithResponse

      com.azure.core.http.rest.Response<Void> executeWithResponse(com.azure.core.util.Context context)
      The operation to run an export.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • execute

      void execute()
      The operation to run an export.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.