Skip to content

Commit

Permalink
docs: Formatting change from HTML to markdown; Additional clarifications
Browse files Browse the repository at this point in the history 
PiperOrigin-RevId: 427761663

Source-Link: googleapis/googleapis@46c5d65

Source-Link: googleapis/googleapis-gen@f86bdde
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuQmlsbGluZy5CdWRnZXRzLlYxQmV0YTEvLk93bEJvdC55YW1sIiwiaCI6ImY4NmJkZGUyOWRiNTMwMzcyODlhYzJkYWEyMDQ3Nzc5ZDg5MWQzNGUifQ==
  • Loading branch information
@gcf-owl-bot @jskeet
gcf-owl-bot[bot] authored and jskeet committed Feb 10, 2022
1 parent 67a6ae0 commit f022157
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 68 deletions.
132 changes: 75 additions & 57 deletions ...oogle.Cloud.Billing.Budgets.V1Beta1/Google.Cloud.Billing.Budgets.V1Beta1/BudgetModel.g.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ public static partial class BudgetModelReflection {
/// Pacific Time (UTC-8).
/// </summary>
public enum CalendarPeriod {
/// <summary>
/// Calendar period is unset. This is the default if the budget is for a
/// custom time period (CustomPeriod).
/// </summary>
[pbr::OriginalName("CALENDAR_PERIOD_UNSPECIFIED")] Unspecified = 0,
/// <summary>
/// A month. Month starts on the first day of each month, such as January 1,
Expand Down Expand Up @@ -212,9 +216,9 @@ public sealed partial class Budget : pb::IMessage<Budget>
public const int BudgetFilterFieldNumber = 3;
private global::Google.Cloud.Billing.Budgets.V1Beta1.Filter budgetFilter_;
/// <summary>
/// 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.
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -248,6 +252,10 @@ public sealed partial class Budget : pb::IMessage<Budget>
/// <summary>
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -259,8 +267,7 @@ public sealed partial class Budget : pb::IMessage<Budget>
public const int AllUpdatesRuleFieldNumber = 6;
private global::Google.Cloud.Billing.Budgets.V1Beta1.AllUpdatesRule allUpdatesRule_;
/// <summary>
/// Optional. Rules to apply to notifications sent based on budget spend and
/// thresholds.
/// Optional. Rules to apply to notifications sent based on budget spend and thresholds.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -661,8 +668,7 @@ public sealed partial class BudgetAmount : pb::IMessage<BudgetAmount>
/// <summary>
/// Use the last period's actual spend as the budget for the present period.
/// LastPeriodAmount can only be set when the budget's time period is a
/// [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period].
/// It cannot be set in combination with
/// [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period]. It cannot be set in combination with
/// [Filter.custom_period][google.cloud.billing.budgets.v1beta1.Filter.custom_period].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand Down Expand Up @@ -885,15 +891,13 @@ public enum BudgetAmountOneofCase {
}

/// <summary>
/// Describes a budget amount targeted to the last
/// [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period]
/// Describes a budget amount targeted to the last [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period]
/// spend. At this time, the amount is automatically 100% of the last calendar
/// period's spend; that is, there are no other options yet.
/// Future configuration options will be described here (for example, configuring
/// a percentage of last period's spend).
/// LastPeriodAmount cannot be set for a budget configured with
/// a
/// [Filter.custom_period][google.cloud.billing.budgets.v1beta1.Filter.custom_period].
/// a [Filter.custom_period][google.cloud.billing.budgets.v1beta1.Filter.custom_period].
/// </summary>
public sealed partial class LastPeriodAmount : pb::IMessage<LastPeriodAmount>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -1048,13 +1052,28 @@ public sealed partial class LastPeriodAmount : pb::IMessage<LastPeriodAmount>
}

/// <summary>
/// ThresholdRule contains a definition of a threshold which triggers
/// an alert (a notification of a threshold being crossed) to be sent when
/// spend goes above the specified amount.
/// Alerts are automatically e-mailed to users with the Billing Account
/// Administrator role or the Billing Account User role.
/// The thresholds here have no effect on notifications sent to anything
/// configured under `Budget.all_updates_rule`.
/// ThresholdRule contains the definition of a threshold. Threshold rules define
/// the triggering events used to generate a budget notification email. When a
/// threshold is crossed (spend exceeds the specified percentages of the
/// budget), budget alert emails are sent to the email recipients you specify
/// in the
/// [NotificationsRule](#notificationsrule).
///
/// Threshold rules also affect the fields included in the
/// [JSON data
/// object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
/// sent to a Pub/Sub topic.
///
/// Threshold rules are _required_ if using email notifications.
///
/// Threshold rules are _optional_ if only setting a
/// [`pubsubTopic` NotificationsRule](#NotificationsRule),
/// unless you want your JSON data object to include data about the thresholds
/// you set.
///
/// For more information, see
/// [set budget threshold rules and
/// actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).
/// </summary>
public sealed partial class ThresholdRule : pb::IMessage<ThresholdRule>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -1310,8 +1329,7 @@ public enum Basis {
/// Use forecasted spend for the period as the basis for comparison against
/// the threshold.
/// FORECASTED_SPEND can only be set when the budget's time period is a
/// [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period].
/// It cannot be set in combination with
/// [Filter.calendar_period][google.cloud.billing.budgets.v1beta1.Filter.calendar_period]. It cannot be set in combination with
/// [Filter.custom_period][google.cloud.billing.budgets.v1beta1.Filter.custom_period].
/// </summary>
[pbr::OriginalName("FORECASTED_SPEND")] ForecastedSpend = 2,
Expand Down Expand Up @@ -1377,10 +1395,10 @@ public sealed partial class AllUpdatesRule : pb::IMessage<AllUpdatesRule>
public const int PubsubTopicFieldNumber = 1;
private string pubsubTopic_ = "";
/// <summary>
/// Optional. The name of the Pub/Sub topic where budget related messages will
/// be published, in the form `projects/{project_id}/topics/{topic_id}`.
/// Updates are sent at regular intervals to the topic. The topic needs to be
/// created before the budget is created; see
/// Optional. The name of the Pub/Sub topic where budget related messages will be
/// published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
/// are sent at regular intervals to the topic.
/// The topic needs to be created before the budget is created; see
/// https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications
/// for more details.
/// Caller is expected to have
Expand All @@ -1402,11 +1420,9 @@ public sealed partial class AllUpdatesRule : pb::IMessage<AllUpdatesRule>
public const int SchemaVersionFieldNumber = 2;
private string schemaVersion_ = "";
/// <summary>
/// Optional. Required when
/// [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic]
/// is set. The schema version of the notification sent to
/// [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic].
/// Only "1.0" is accepted. It represents the JSON schema as defined in
/// Optional. Required when [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic] is set. The schema version of
/// the notification sent to [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic]. Only "1.0" is
/// accepted. It represents the JSON schema as defined in
/// https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand All @@ -1424,10 +1440,10 @@ public sealed partial class AllUpdatesRule : pb::IMessage<AllUpdatesRule>
= pb::FieldCodec.ForString(26);
private readonly pbc::RepeatedField<string> monitoringNotificationChannels_ = new pbc::RepeatedField<string>();
/// <summary>
/// Optional. Targets to send notifications to when a threshold is exceeded.
/// This is in addition to default recipients who have billing account IAM
/// roles. The value is the full REST resource name of a monitoring
/// notification channel with the form
/// Optional. Targets to send notifications to when a threshold is exceeded. This is in
/// addition to default recipients who have billing account IAM roles.
/// The value is the full REST resource name of a monitoring notification
/// channel with the form
/// `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5
/// channels are allowed. See
/// https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients
Expand All @@ -1443,10 +1459,9 @@ public sealed partial class AllUpdatesRule : pb::IMessage<AllUpdatesRule>
public const int DisableDefaultIamRecipientsFieldNumber = 4;
private bool disableDefaultIamRecipients_;
/// <summary>
/// Optional. When set to true, disables default notifications sent when a
/// threshold is exceeded. Default notifications are sent to those with Billing
/// Account Administrator and Billing Account User IAM roles for the target
/// account.
/// Optional. When set to true, disables default notifications sent when a threshold is
/// exceeded. Default notifications are sent to those with Billing Account
/// Administrator and Billing Account User IAM roles for the target account.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1737,16 +1752,14 @@ public sealed partial class Filter : pb::IMessage<Filter>
= pb::FieldCodec.ForString(58);
private readonly pbc::RepeatedField<string> creditTypes_ = new pbc::RepeatedField<string>();
/// <summary>
/// Optional. If
/// [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment]
/// is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be
/// subtracted from gross cost to determine the spend for threshold
/// calculations. See [a list of acceptable credit type
/// Optional. If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment] is INCLUDE_SPECIFIED_CREDITS, this is
/// a list of credit types to be subtracted from gross cost to determine the
/// spend for threshold calculations. See
/// [a list of acceptable credit type
/// values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).
///
/// If
/// [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment]
/// is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
/// If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment] is **not** INCLUDE_SPECIFIED_CREDITS,
/// this field must be empty.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1794,9 +1807,9 @@ public sealed partial class Filter : pb::IMessage<Filter>
= pb::FieldCodec.ForString(42);
private readonly pbc::RepeatedField<string> subaccounts_ = new pbc::RepeatedField<string>();
/// <summary>
/// Optional. A set of subaccounts of the form `billingAccounts/{account_id}`,
/// specifying that usage from only this set of subaccounts should be included
/// in the budget. If a subaccount is set to the name of the parent account,
/// Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying
/// that usage from only this set of subaccounts should be included in the
/// budget. If a subaccount is set to the name of the parent account,
/// usage from the parent account will be included. If omitted, the
/// report will include usage from the parent account and all
/// subaccounts, if they exist.
Expand All @@ -1813,10 +1826,15 @@ public sealed partial class Filter : pb::IMessage<Filter>
= new pbc::MapField<string, global::Google.Protobuf.WellKnownTypes.ListValue>.Codec(pb::FieldCodec.ForString(10, ""), pb::FieldCodec.ForMessage(18, global::Google.Protobuf.WellKnownTypes.ListValue.Parser), 50);
private readonly pbc::MapField<string, global::Google.Protobuf.WellKnownTypes.ListValue> labels_ = new pbc::MapField<string, global::Google.Protobuf.WellKnownTypes.ListValue>();
/// <summary>
/// Optional. A single label and value pair specifying that usage from only
/// this set of labeled resources should be included in the budget. Currently,
/// multiple entries or multiple values per entry are not allowed. If omitted,
/// the report will include all labeled and unlabeled usage.
/// Optional. A single label and value pair specifying that usage from only this set of
/// labeled resources should be included in the budget. If omitted, the
/// report will include all labeled and unlabeled usage.
///
/// An object containing a single `"key": value` pair. Example: `{ "name":
/// "wrench" }`.
///
/// _Currently, multiple entries or multiple values per entry are not
/// allowed._
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1847,8 +1865,8 @@ public sealed partial class Filter : pb::IMessage<Filter>
/// <summary>Field number for the "custom_period" field.</summary>
public const int CustomPeriodFieldNumber = 9;
/// <summary>
/// Optional. Specifies to track usage from any start date (required) to any
/// end date (optional). This time period is static, it does not recur.
/// Optional. Specifies to track usage from any start date (required) to any end date
/// (optional). This time period is static, it does not recur.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -2255,9 +2273,9 @@ public sealed partial class CustomPeriod : pb::IMessage<CustomPeriod>
public const int EndDateFieldNumber = 2;
private global::Google.Type.Date endDate_;
/// <summary>
/// Optional. The end date of the time period. Budgets with elapsed end date
/// won't be processed. If unset, specifies to track all usage incurred since
/// the start_date.
/// Optional. The end date of the time period. Budgets with elapsed end date won't be
/// processed. If unset, specifies to track all usage
/// incurred since the start_date.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
10 changes: 5 additions & 5 deletions ...oud.Billing.Budgets.V1Beta1/Google.Cloud.Billing.Budgets.V1Beta1/BudgetServiceClient.g.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ internal static BudgetServiceClient Create(grpccore::CallInvoker callInvoker, Bu

/// <summary>
/// Creates a new budget. See
/// &amp;lt;a href="https://cloud.google.com/billing/quotas"&amp;gt;Quotas and limits&amp;lt;/a&amp;gt;
/// [Quotas and limits](https://cloud.google.com/billing/quotas)
/// for more information on the limits of the number of budgets you can create.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
Expand All @@ -328,7 +328,7 @@ internal static BudgetServiceClient Create(grpccore::CallInvoker callInvoker, Bu

/// <summary>
/// Creates a new budget. See
/// &amp;lt;a href="https://cloud.google.com/billing/quotas"&amp;gt;Quotas and limits&amp;lt;/a&amp;gt;
/// [Quotas and limits](https://cloud.google.com/billing/quotas)
/// for more information on the limits of the number of budgets you can create.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
Expand All @@ -339,7 +339,7 @@ internal static BudgetServiceClient Create(grpccore::CallInvoker callInvoker, Bu

/// <summary>
/// Creates a new budget. See
/// &amp;lt;a href="https://cloud.google.com/billing/quotas"&amp;gt;Quotas and limits&amp;lt;/a&amp;gt;
/// [Quotas and limits](https://cloud.google.com/billing/quotas)
/// for more information on the limits of the number of budgets you can create.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
Expand Down Expand Up @@ -559,7 +559,7 @@ public BudgetServiceClientImpl(BudgetService.BudgetServiceClient grpcClient, Bud

/// <summary>
/// Creates a new budget. See
/// &amp;lt;a href="https://cloud.google.com/billing/quotas"&amp;gt;Quotas and limits&amp;lt;/a&amp;gt;
/// [Quotas and limits](https://cloud.google.com/billing/quotas)
/// for more information on the limits of the number of budgets you can create.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
Expand All @@ -573,7 +573,7 @@ public override Budget CreateBudget(CreateBudgetRequest request, gaxgrpc::CallSe

/// <summary>
/// Creates a new budget. See
/// &amp;lt;a href="https://cloud.google.com/billing/quotas"&amp;gt;Quotas and limits&amp;lt;/a&amp;gt;
/// [Quotas and limits](https://cloud.google.com/billing/quotas)
/// for more information on the limits of the number of budgets you can create.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
Expand Down
Loading

0 comments on commit f022157

Please sign in to comment.