google-cloud-billing-budgets-v1beta1 0.1.0

data/proto_docs/google/cloud/billing/budgets/v1beta1/budget_model.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Billing
+      module Budgets
+        module V1beta1
+          # A budget is a plan that describes what you expect to spend on Cloud
+          # projects, plus the rules to execute as spend is tracked against that plan,
+          # (for example, send an alert when 90% of the target spend is met).
+          # Currently all plans are monthly budgets so the usage period(s) tracked are
+          # implied (calendar months of usage back-to-back).
+          # @!attribute [r] name
+          #   @return [::String]
+          #     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}`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     User data for display name in UI.
+          #     Validation: <= 60 chars.
+          # @!attribute [rw] budget_filter
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter]
+          #     Optional. Filters that define which resources are used to compute
+          #     the actual spend against the budget.
+          # @!attribute [rw] amount
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::BudgetAmount]
+          #     Required. Budgeted amount.
+          # @!attribute [rw] threshold_rules
+          #   @return [::Array<::Google::Cloud::Billing::Budgets::V1beta1::ThresholdRule>]
+          #     Optional. Rules that trigger alerts (notifications of thresholds
+          #     being crossed) when spend exceeds the specified percentages of the budget.
+          # @!attribute [rw] all_updates_rule
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::AllUpdatesRule]
+          #     Optional. Rules to apply to notifications sent based on budget spend and
+          #     thresholds.
+          # @!attribute [rw] etag
+          #   @return [::String]
+          #     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.
+          class Budget
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The budgeted amount for each usage period.
+          # @!attribute [rw] specified_amount
+          #   @return [::Google::Type::Money]
+          #     A specified amount to use as the budget.
+          #     `currency_code` is optional. If specified, it must match the
+          #     currency of the billing account. The `currency_code` is provided on
+          #     output.
+          # @!attribute [rw] last_period_amount
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::LastPeriodAmount]
+          #     Use the last period's actual spend as the budget for the present period.
+          class BudgetAmount
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes a budget amount targeted to last period's spend.
+          # At this time, the amount is automatically 100% of last period's spend;
+          # that is, there are no other options yet.
+          # Future configuration will be described here (for example, configuring a
+          # percentage of last period's spend).
+          class LastPeriodAmount
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # 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`.
+          # @!attribute [rw] threshold_percent
+          #   @return [::Float]
+          #     Required. Send an alert when this threshold is exceeded.
+          #     This is a 1.0-based percentage, so 0.5 = 50%.
+          #     Validation: non-negative number.
+          # @!attribute [rw] spend_basis
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::ThresholdRule::Basis]
+          #     Optional. The type of basis used to determine if spend has passed the
+          #     threshold. Behavior defaults to CURRENT_SPEND if not set.
+          class ThresholdRule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of basis used to determine if spend has passed the threshold.
+            module Basis
+              # Unspecified threshold basis.
+              BASIS_UNSPECIFIED = 0
+
+              # Use current spend as the basis for comparison against the threshold.
+              CURRENT_SPEND = 1
+
+              # Use forecasted spend for the period as the basis for comparison against
+              # the threshold.
+              FORECASTED_SPEND = 2
+            end
+          end
+
+          # AllUpdatesRule defines notifications that are sent based on budget spend
+          # and thresholds.
+          # @!attribute [rw] pubsub_topic
+          #   @return [::String]
+          #     Required. The name of the Cloud 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#manage-notifications
+          #     for more details.
+          #     Caller is expected to have
+          #     `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
+          #     budget, otherwise, the API call will fail with PERMISSION_DENIED. See
+          #     https://cloud.google.com/pubsub/docs/access-control for more details on
+          #     Pub/Sub roles and permissions.
+          # @!attribute [rw] schema_version
+          #   @return [::String]
+          #     Required. The schema version of the notification sent to `pubsub_topic`.
+          #     Only "1.0" is accepted. It represents the JSON schema as defined in
+          #     https://cloud.google.com/billing/docs/how-to/budgets#notification_format
+          # @!attribute [rw] monitoring_notification_channels
+          #   @return [::Array<::String>]
+          #     Optional. Targets to send notifications to when a threshold is exceeded.
+          #     This is in addition to default recipients who have billing account 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.
+          class AllUpdatesRule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A filter for a budget, limiting the scope of the cost to calculate.
+          # @!attribute [rw] projects
+          #   @return [::Array<::String>]
+          #     Optional. A set of projects of the form `projects/{project}`,
+          #     specifying that usage from only this set of projects should be
+          #     included in the budget. If omitted, the report will include all usage for
+          #     the billing account, regardless of which project the usage occurred on.
+          #     Only zero or one project can be specified currently.
+          # @!attribute [rw] credit_types_treatment
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::Filter::CreditTypesTreatment]
+          #     Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
+          # @!attribute [rw] services
+          #   @return [::Array<::String>]
+          #     Optional. A set of services of the form `services/{service_id}`,
+          #     specifying that usage from only this set of services should be
+          #     included in the budget. If omitted, the report will include usage for
+          #     all the services.
+          #     The service names are available through the Catalog API:
+          #     https://cloud.google.com/billing/v1/how-tos/catalog-api.
+          # @!attribute [rw] subaccounts
+          #   @return [::Array<::String>]
+          #     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 reseller account,
+          #     usage from the reseller account will be included. If omitted, the report
+          #     will include usage from the reseller account and all subaccounts, if they
+          #     exist.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}]
+          #     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.
+          class Filter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Protobuf::ListValue]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specifies how credits should be treated when determining spend for
+            # threshold calculations.
+            module CreditTypesTreatment
+              CREDIT_TYPES_TREATMENT_UNSPECIFIED = 0
+
+              # All types of credit are subtracted from the gross cost to determine the
+              # spend for threshold calculations.
+              INCLUDE_ALL_CREDITS = 1
+
+              # All types of credit are added to the net cost to determine the spend for
+              # threshold calculations.
+              EXCLUDE_ALL_CREDITS = 2
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/billing/budgets/v1beta1/budget_service.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Billing
+      module Budgets
+        module V1beta1
+          # Request for CreateBudget
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The name of the billing account to create the budget in. Values
+          #     are of the form `billingAccounts/{billingAccountId}`.
+          # @!attribute [rw] budget
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::Budget]
+          #     Required. Budget to create.
+          class CreateBudgetRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for UpdateBudget
+          # @!attribute [rw] budget
+          #   @return [::Google::Cloud::Billing::Budgets::V1beta1::Budget]
+          #     Required. The updated budget object.
+          #     The budget to update is specified by the budget name in the budget.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. Indicates which fields in the provided budget to update.
+          #     Read-only fields (such as `name`) cannot be changed. If this is not
+          #     provided, then only fields with non-default values from the request are
+          #     updated. See
+          #     https://developers.google.com/protocol-buffers/docs/proto3#default for more
+          #     details about default values.
+          class UpdateBudgetRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for GetBudget
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of budget to get. Values are of the form
+          #     `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+          class GetBudgetRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for ListBudgets
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Name of billing account to list budgets under. Values
+          #     are of the form `billingAccounts/{billingAccountId}`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of budgets to return per page.
+          #     The default and maximum value are 100.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. The value returned by the last `ListBudgetsResponse` which
+          #     indicates that this is a continuation of a prior `ListBudgets` call,
+          #     and that the system should return the next page of data.
+          class ListBudgetsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response for ListBudgets
+          # @!attribute [rw] budgets
+          #   @return [::Array<::Google::Cloud::Billing::Budgets::V1beta1::Budget>]
+          #     List of the budgets owned by the requested billing account.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     If not empty, indicates that there may be more budgets that match the
+          #     request; this value should be passed in a new `ListBudgetsRequest`.
+          class ListBudgetsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request for DeleteBudget
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the budget to delete. Values are of the form
+          #     `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
+          class DeleteBudgetRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for `Empty` is empty JSON object `{}`.
+    class Empty
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end