Package com.azure.resourcemanager.costmanagement.fluent.models

Class ScheduledActionProperties

java.lang.Object
com.azure.resourcemanager.costmanagement.fluent.models.ScheduledActionProperties
public final class ScheduledActionProperties extends Object
The properties of the scheduled action.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    displayName()
    Get the displayName property: Scheduled action name.
    FileDestination
    fileDestination()
    Get the fileDestination property: Destination format of the view data.
    NotificationProperties
    notification()
    Get the notification property: Notification properties based on scheduled action kind.
    String
    notificationEmail()
    Get the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
    ScheduleProperties
    schedule()
    Get the schedule property: Schedule of the scheduled action.
    String
    scope()
    Get the scope property: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    ScheduledActionStatus
    status()
    Get the status property: Status of the scheduled action.
    void
    validate()
    Validates the instance.
    String
    viewId()
    Get the viewId property: Cost analysis viewId used for scheduled action.
    ScheduledActionProperties
    withDisplayName(String displayName)
    Set the displayName property: Scheduled action name.
    ScheduledActionProperties
    withFileDestination(FileDestination fileDestination)
    Set the fileDestination property: Destination format of the view data.
    ScheduledActionProperties
    withNotification(NotificationProperties notification)
    Set the notification property: Notification properties based on scheduled action kind.
    ScheduledActionProperties
    withNotificationEmail(String notificationEmail)
    Set the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
    ScheduledActionProperties
    withSchedule(ScheduleProperties schedule)
    Set the schedule property: Schedule of the scheduled action.
    ScheduledActionProperties
    withScope(String scope)
    Set the scope property: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    ScheduledActionProperties
    withStatus(ScheduledActionStatus status)
    Set the status property: Status of the scheduled action.
    ScheduledActionProperties
    withViewId(String viewId)
    Set the viewId property: Cost analysis viewId used for scheduled action.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ScheduledActionProperties

      public ScheduledActionProperties()
      Creates an instance of ScheduledActionProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: Scheduled action name.
      Returns:
      the displayName value.

    • withDisplayName

      public ScheduledActionProperties withDisplayName(String displayName)
      Set the displayName property: Scheduled action name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • fileDestination

      public FileDestination fileDestination()
      Get the fileDestination property: Destination format of the view data. This is optional.
      Returns:
      the fileDestination value.

    • withFileDestination

      public ScheduledActionProperties withFileDestination(FileDestination fileDestination)
      Set the fileDestination property: Destination format of the view data. This is optional.
      Parameters:
      fileDestination - the fileDestination value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • notification

      public NotificationProperties notification()
      Get the notification property: Notification properties based on scheduled action kind.
      Returns:
      the notification value.

    • withNotification

      public ScheduledActionProperties withNotification(NotificationProperties notification)
      Set the notification property: Notification properties based on scheduled action kind.
      Parameters:
      notification - the notification value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • notificationEmail

      public String notificationEmail()
      Get the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
      Returns:
      the notificationEmail value.

    • withNotificationEmail

      public ScheduledActionProperties withNotificationEmail(String notificationEmail)
      Set the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
      Parameters:
      notificationEmail - the notificationEmail value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • schedule

      public ScheduleProperties schedule()
      Get the schedule property: Schedule of the scheduled action.
      Returns:
      the schedule value.

    • withSchedule

      public ScheduledActionProperties withSchedule(ScheduleProperties schedule)
      Set the schedule property: Schedule of the scheduled action.
      Parameters:
      schedule - the schedule value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • scope

      public String scope()
      Get the scope property: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
      Returns:
      the scope value.

    • withScope

      public ScheduledActionProperties withScope(String scope)
      Set the scope property: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
      Parameters:
      scope - the scope value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • status

      public ScheduledActionStatus status()
      Get the status property: Status of the scheduled action.
      Returns:
      the status value.

    • withStatus

      public ScheduledActionProperties withStatus(ScheduledActionStatus status)
      Set the status property: Status of the scheduled action.
      Parameters:
      status - the status value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • viewId

      public String viewId()
      Get the viewId property: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'.
      Returns:
      the viewId value.

    • withViewId

      public ScheduledActionProperties withViewId(String viewId)
      Set the viewId property: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'.
      Parameters:
      viewId - the viewId value to set.
      Returns:
      the ScheduledActionProperties object itself.

    • validate

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