google.cloud.billing.budgets.v1beta1.Budget
*/
class Budget extends \Google\Protobuf\Internal\Message
{
/**
* Output only. Resource name of the budget.
* The resource name implies the scope of a budget. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
*
* Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
private $name = '';
/**
* User data for display name in UI.
* Validation: <= 60 chars.
*
* Generated from protobuf field string display_name = 2;
*/
private $display_name = '';
/**
* Optional. Filters that define which resources are used to compute the actual spend
* against the budget amount, such as projects, services, and the budget's
* time period, as well as other filters.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
*/
private $budget_filter = null;
/**
* Required. Budgeted amount.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
*/
private $amount = null;
/**
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
* Optional for `pubsubTopic` notifications.
* Required if using email notifications.
*
* Generated from protobuf field repeated .google.cloud.billing.budgets.v1beta1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*/
private $threshold_rules;
/**
* Optional. Rules to apply to notifications sent based on budget spend and thresholds.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.AllUpdatesRule all_updates_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
private $all_updates_rule = null;
/**
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
*
* Generated from protobuf field string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
*/
private $etag = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $name
* Output only. Resource name of the budget.
* The resource name implies the scope of a budget. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
* @type string $display_name
* User data for display name in UI.
* Validation: <= 60 chars.
* @type \Google\Cloud\Billing\Budgets\V1beta1\Filter $budget_filter
* Optional. Filters that define which resources are used to compute the actual spend
* against the budget amount, such as projects, services, and the budget's
* time period, as well as other filters.
* @type \Google\Cloud\Billing\Budgets\V1beta1\BudgetAmount $amount
* Required. Budgeted amount.
* @type array<\Google\Cloud\Billing\Budgets\V1beta1\ThresholdRule>|\Google\Protobuf\Internal\RepeatedField $threshold_rules
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
* Optional for `pubsubTopic` notifications.
* Required if using email notifications.
* @type \Google\Cloud\Billing\Budgets\V1beta1\AllUpdatesRule $all_updates_rule
* Optional. Rules to apply to notifications sent based on budget spend and thresholds.
* @type string $etag
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Billing\Budgets\V1Beta1\BudgetModel::initOnce();
parent::__construct($data);
}
/**
* Output only. Resource name of the budget.
* The resource name implies the scope of a budget. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
*
* Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. Resource name of the budget.
* The resource name implies the scope of a budget. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
*
* Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param string $var
* @return $this
*/
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
}
/**
* User data for display name in UI.
* Validation: <= 60 chars.
*
* Generated from protobuf field string display_name = 2;
* @return string
*/
public function getDisplayName()
{
return $this->display_name;
}
/**
* User data for display name in UI.
* Validation: <= 60 chars.
*
* Generated from protobuf field string display_name = 2;
* @param string $var
* @return $this
*/
public function setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
}
/**
* Optional. Filters that define which resources are used to compute the actual spend
* against the budget amount, such as projects, services, and the budget's
* time period, as well as other filters.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
* @return \Google\Cloud\Billing\Budgets\V1beta1\Filter|null
*/
public function getBudgetFilter()
{
return $this->budget_filter;
}
public function hasBudgetFilter()
{
return isset($this->budget_filter);
}
public function clearBudgetFilter()
{
unset($this->budget_filter);
}
/**
* Optional. Filters that define which resources are used to compute the actual spend
* against the budget amount, such as projects, services, and the budget's
* time period, as well as other filters.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
* @param \Google\Cloud\Billing\Budgets\V1beta1\Filter $var
* @return $this
*/
public function setBudgetFilter($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Billing\Budgets\V1beta1\Filter::class);
$this->budget_filter = $var;
return $this;
}
/**
* Required. Budgeted amount.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
* @return \Google\Cloud\Billing\Budgets\V1beta1\BudgetAmount|null
*/
public function getAmount()
{
return $this->amount;
}
public function hasAmount()
{
return isset($this->amount);
}
public function clearAmount()
{
unset($this->amount);
}
/**
* Required. Budgeted amount.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
* @param \Google\Cloud\Billing\Budgets\V1beta1\BudgetAmount $var
* @return $this
*/
public function setAmount($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Billing\Budgets\V1beta1\BudgetAmount::class);
$this->amount = $var;
return $this;
}
/**
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
* Optional for `pubsubTopic` notifications.
* Required if using email notifications.
*
* Generated from protobuf field repeated .google.cloud.billing.budgets.v1beta1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getThresholdRules()
{
return $this->threshold_rules;
}
/**
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
* Optional for `pubsubTopic` notifications.
* Required if using email notifications.
*
* Generated from protobuf field repeated .google.cloud.billing.budgets.v1beta1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
* @param array<\Google\Cloud\Billing\Budgets\V1beta1\ThresholdRule>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setThresholdRules($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Billing\Budgets\V1beta1\ThresholdRule::class);
$this->threshold_rules = $arr;
return $this;
}
/**
* Optional. Rules to apply to notifications sent based on budget spend and thresholds.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.AllUpdatesRule all_updates_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
* @return \Google\Cloud\Billing\Budgets\V1beta1\AllUpdatesRule|null
*/
public function getAllUpdatesRule()
{
return $this->all_updates_rule;
}
public function hasAllUpdatesRule()
{
return isset($this->all_updates_rule);
}
public function clearAllUpdatesRule()
{
unset($this->all_updates_rule);
}
/**
* Optional. Rules to apply to notifications sent based on budget spend and thresholds.
*
* Generated from protobuf field .google.cloud.billing.budgets.v1beta1.AllUpdatesRule all_updates_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
* @param \Google\Cloud\Billing\Budgets\V1beta1\AllUpdatesRule $var
* @return $this
*/
public function setAllUpdatesRule($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Billing\Budgets\V1beta1\AllUpdatesRule::class);
$this->all_updates_rule = $var;
return $this;
}
/**
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
*
* Generated from protobuf field string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
*
* Generated from protobuf field string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
* @param string $var
* @return $this
*/
public function setEtag($var)
{
GPBUtil::checkString($var, True);
$this->etag = $var;
return $this;
}
}