Class BudgetSummary

A budget.

Inheritance

object

BudgetSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.BudgetService.Models

Assembly: OCI.DotNetSDK.Budget.dll

Syntax

public class BudgetSummary

Properties

ActualSpend

Declaration

[JsonProperty(PropertyName = "actualSpend")]
public decimal? ActualSpend { get; set; }

Property Value

Type	Description
decimal?	The actual spend in currency for the current budget cycle.

AlertRuleCount

Declaration

[Required(ErrorMessage = "AlertRuleCount is required.")]
[JsonProperty(PropertyName = "alertRuleCount")]
public int? AlertRuleCount { get; set; }

Property Value

Type	Description
int?	The total number of alert rules in the budget.

Remarks

Required

Amount

Declaration

[Required(ErrorMessage = "Amount is required.")]
[JsonProperty(PropertyName = "amount")]
public decimal? Amount { get; set; }

Property Value

Type	Description
decimal?	The amount of the budget, expressed in the currency of the customer's rate card.

Remarks

Required

BudgetProcessingPeriodStartOffset

Declaration

[JsonProperty(PropertyName = "budgetProcessingPeriodStartOffset")]
public int? BudgetProcessingPeriodStartOffset { get; set; }

Property Value

Type	Description
int?	The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the budget.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the budget. Avoid entering confidential information.

Remarks

Required

EndDate

Declaration

[JsonProperty(PropertyName = "endDate")]
public DateTime? EndDate { get; set; }

Property Value

Type	Description
DateTime?	The time when the one-time budget concludes. For example, - 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

ForecastedSpend

Declaration

[JsonProperty(PropertyName = "forecastedSpend")]
public decimal? ForecastedSpend { get; set; }

Property Value

Type	Description
decimal?	The forecasted spend in currency by the end of the current budget cycle.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the budget.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the budget.

Remarks

Required

ProcessingPeriodType

Declaration

[JsonProperty(PropertyName = "processingPeriodType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ProcessingPeriodType? ProcessingPeriodType { get; set; }

Property Value

Type	Description
ProcessingPeriodType?	The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.

ResetPeriod

Declaration

[Required(ErrorMessage = "ResetPeriod is required.")]
[JsonProperty(PropertyName = "resetPeriod")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ResetPeriod? ResetPeriod { get; set; }

Property Value

Type	Description
ResetPeriod?	The reset period for the budget.

Remarks

Required

StartDate

Declaration

[JsonProperty(PropertyName = "startDate")]
public DateTime? StartDate { get; set; }

Property Value

Type	Description
DateTime?	The date when the one-time budget begins. For example, 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

TargetCompartmentId

Declaration

[JsonProperty(PropertyName = "targetCompartmentId")]
public string TargetCompartmentId { get; set; }

Property Value

Type	Description
string	This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and the targets contain the specific target compartment OCID. For all other scenarios, this property is left empty.

TargetType

Declaration

[JsonProperty(PropertyName = "targetType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TargetType? TargetType { get; set; }

Property Value

Type	Description
TargetType?	The type of target on which the budget is applied.

Targets

Declaration

[JsonProperty(PropertyName = "targets")]
public List<string> Targets { get; set; }

Property Value

Type	Description
List<string>	The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the budget was created.

Remarks

Required

TimeSpendComputed

Declaration

[JsonProperty(PropertyName = "timeSpendComputed")]
public DateTime? TimeSpendComputed { get; set; }

Property Value

Type	Description
DateTime?	The time the budget spend was last computed.

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the budget was updated.

Remarks

Required

Version

Declaration

[JsonProperty(PropertyName = "version")]
public int? Version { get; set; }

Property Value

Type	Description
int?	The version of the budget. Starts from 1 and increments by 1.