billingbudgets

package
v1.76.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Copyright 2024 Google LLC. All Rights Reserved.

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 

http://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. Package billingbudgets defines functions and types for handling billingbudgets GCP resources.

Copyright 2024 Google LLC. All Rights Reserved.

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 

http://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.

Copyright 2024 Google LLC. All Rights Reserved.

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 

http://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.

Copyright 2024 Google LLC. All Rights Reserved.

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 

http://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.

Copyright 2024 Google LLC. All Rights Reserved.

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 

http://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. Package billingbudgets defines operations in the declarative SDK.

Index

Constants

View Source 
const BudgetMaxPage = -1

Variables

View Source 
var YAML_budget = []byte("info:\n  title: BillingBudgets/Budget\n  description: The BillingBudgets Budget resource\n  x-dcl-struct-name: Budget\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Budget\n    parameters:\n    - name: budget\n      required: true\n      description: A full instance of a Budget\n  apply:\n    description: The function used to apply information about a Budget\n    parameters:\n    - name: budget\n      required: true\n      description: A full instance of a Budget\n  delete:\n    description: The function used to delete a Budget\n    parameters:\n    - name: budget\n      required: true\n      description: A full instance of a Budget\n  deleteAll:\n    description: The function used to delete all Budget\n    parameters:\n    - name: billingAccount\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Budget\n    parameters:\n    - name: billingAccount\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Budget:\n      title: Budget\n      x-dcl-id: billingAccounts/{{billing_account}}/budgets/{{name}}\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      x-dcl-read-timeout: 0\n      x-dcl-apply-timeout: 0\n      x-dcl-delete-timeout: 0\n      type: object\n      required:\n      - amount\n      - billingAccount\n      properties:\n        allUpdatesRule:\n          type: object\n          x-dcl-go-name: AllUpdatesRule\n          x-dcl-go-type: BudgetAllUpdatesRule\n          description: Optional. Rules to apply to notifications sent based on budget\n            spend and thresholds.\n          properties:\n            disableDefaultIamRecipients:\n              type: boolean\n              x-dcl-go-name: DisableDefaultIamRecipients\n              description: Optional. When set to true, disables default notifications\n                sent when a threshold is exceeded. Default notifications are sent\n                to those with Billing Account Administrator and Billing Account User\n                IAM roles for the target account.\n            monitoringNotificationChannels:\n              type: array\n              x-dcl-go-name: MonitoringNotificationChannels\n              description: Optional. Targets to send notifications to when a threshold\n                is exceeded. This is in addition to default recipients who have billing\n                account IAM roles. The value is the full REST resource name of a monitoring\n                notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`.\n                A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients\n                for more details.\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: string\n                x-dcl-go-type: string\n                x-dcl-references:\n                - resource: Monitoring/NotificationChannel\n                  field: name\n            pubsubTopic:\n              type: string\n              x-dcl-go-name: PubsubTopic\n              description: Optional. The name of the Pub/Sub topic where budget related\n                messages will be published, in the form `projects/{project_id}/topics/{topic_id}`.\n                Updates are sent at regular intervals to the topic. The topic needs\n                to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications\n                for more details. Caller is expected to have `pubsub.topics.setIamPolicy`\n                permission on the topic when it's set for a budget, otherwise, the\n                API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task\n                for more details on Pub/Sub roles and permissions.\n              x-dcl-references:\n              - resource: Pubsub/Topic\n                field: name\n            schemaVersion:\n              type: string\n              x-dcl-go-name: SchemaVersion\n              description: Optional. Required when NotificationsRule.pubsub_topic\n                is set. The schema version of the notification sent to NotificationsRule.pubsub_topic.\n                Only \"1.0\" is accepted. It represents the JSON schema as defined in\n                https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.\n        amount:\n          type: object\n          x-dcl-go-name: Amount\n          x-dcl-go-type: BudgetAmount\n          description: Required. Budgeted amount.\n          properties:\n            lastPeriodAmount:\n              type: object\n              x-dcl-go-name: LastPeriodAmount\n              x-dcl-go-type: BudgetAmountLastPeriodAmount\n              description: Use the last period's actual spend as the budget for the\n                present period. LastPeriodAmount can only be set when the budget's\n                time period is a .\n              x-dcl-conflicts:\n              - specifiedAmount\n            specifiedAmount:\n              type: object\n              x-dcl-go-name: SpecifiedAmount\n              x-dcl-go-type: BudgetAmountSpecifiedAmount\n              description: A specified amount to use as the budget. `currency_code`\n                is optional. If specified when creating a budget, it must match the\n                currency of the billing account. If specified when updating a budget,\n                it must match the currency_code of the existing budget. The `currency_code`\n                is provided on output.\n              x-dcl-conflicts:\n              - lastPeriodAmount\n              properties:\n                currencyCode:\n                  type: string\n                  x-dcl-go-name: CurrencyCode\n                  description: The three-letter currency code defined in ISO 4217.\n                  x-kubernetes-immutable: true\n                nanos:\n                  type: integer\n                  format: int64\n                  x-dcl-go-name: Nanos\n                  description: Number of nano (10^-9) units of the amount. The value\n                    must be between -999,999,999 and +999,999,999 inclusive. If `units`\n                    is positive, `nanos` must be positive or zero. If `units` is zero,\n                    `nanos` can be positive, zero, or negative. If `units` is negative,\n                    `nanos` must be negative or zero. For example $-1.75 is represented\n                    as `units`=-1 and `nanos`=-750,000,000.\n                  x-dcl-send-empty: true\n                units:\n                  type: integer\n                  format: int64\n                  x-dcl-go-name: Units\n                  description: The whole units of the amount. For example if `currencyCode`\n                    is `\"USD\"`, then 1 unit is one US dollar.\n                  x-dcl-send-empty: true\n        billingAccount:\n          type: string\n          x-dcl-go-name: BillingAccount\n          description: The billing account of the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/BillingAccount\n            field: name\n            parent: true\n          x-dcl-parameter: true\n        budgetFilter:\n          type: object\n          x-dcl-go-name: BudgetFilter\n          x-dcl-go-type: BudgetBudgetFilter\n          description: Optional. Filters that define which resources are used to compute\n            the actual spend against the budget amount, such as projects, services,\n            and the budget's time period, as well as other filters.\n          x-dcl-server-default: true\n          properties:\n            calendarPeriod:\n              type: string\n              x-dcl-go-name: CalendarPeriod\n              x-dcl-go-type: BudgetBudgetFilterCalendarPeriodEnum\n              description: 'Optional. Specifies to track usage for recurring calendar\n                period. For example, assume that CalendarPeriod.QUARTER is set. The\n                budget will track usage from April 1 to June 30, when the current\n                calendar month is April, May, June. After that, it will track usage\n                from July 1 to September 30 when the current calendar month is July,\n                August, September, so on. Possible values: CALENDAR_PERIOD_UNSPECIFIED,\n                MONTH, QUARTER, YEAR'\n              x-dcl-conflicts:\n              - customPeriod\n              x-dcl-server-default: true\n              enum:\n              - CALENDAR_PERIOD_UNSPECIFIED\n              - MONTH\n              - QUARTER\n              - YEAR\n            creditTypes:\n              type: array\n              x-dcl-go-name: CreditTypes\n              description: Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS,\n                this is a list of credit types to be subtracted from gross cost to\n                determine the spend for threshold calculations. See a list of acceptable\n                credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS,\n                this field must be empty.\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: string\n                x-dcl-go-type: string\n            creditTypesTreatment:\n              type: string\n              x-dcl-go-name: CreditTypesTreatment\n              x-dcl-go-type: BudgetBudgetFilterCreditTypesTreatmentEnum\n              description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.\n              x-dcl-server-default: true\n              enum:\n              - INCLUDE_ALL_CREDITS\n              - EXCLUDE_ALL_CREDITS\n              - INCLUDE_SPECIFIED_CREDITS\n            customPeriod:\n              type: object\n              x-dcl-go-name: CustomPeriod\n              x-dcl-go-type: BudgetBudgetFilterCustomPeriod\n              description: Optional. Specifies to track usage from any start date\n                (required) to any end date (optional). This time period is static,\n                it does not recur.\n              x-dcl-conflicts:\n              - calendarPeriod\n              required:\n              - startDate\n              properties:\n                endDate:\n                  type: object\n                  x-dcl-go-name: EndDate\n                  x-dcl-go-type: BudgetBudgetFilterCustomPeriodEndDate\n                  description: Optional. The end date of the time period. Budgets\n                    with elapsed end date won't be processed. If unset, specifies\n                    to track all usage incurred since the start_date.\n                  x-kubernetes-immutable: true\n                  properties:\n                    day:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Day\n                      description: Day of a month. Must be from 1 to 31 and valid\n                        for the year and month, or 0 to specify a year by itself or\n                        a year and month where the day isn't significant.\n                      x-kubernetes-immutable: true\n                    month:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Month\n                      description: Month of a year. Must be from 1 to 12, or 0 to\n                        specify a year without a month and day.\n                      x-kubernetes-immutable: true\n                    year:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Year\n                      description: Year of the date. Must be from 1 to 9999, or 0\n                        to specify a date without a year.\n                      x-kubernetes-immutable: true\n                startDate:\n                  type: object\n                  x-dcl-go-name: StartDate\n                  x-dcl-go-type: BudgetBudgetFilterCustomPeriodStartDate\n                  description: Required. The start date must be after January 1, 2017.\n                  x-kubernetes-immutable: true\n                  properties:\n                    day:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Day\n                      description: Day of a month. Must be from 1 to 31 and valid\n                        for the year and month, or 0 to specify a year by itself or\n                        a year and month where the day isn't significant.\n                      x-kubernetes-immutable: true\n                    month:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Month\n                      description: Month of a year. Must be from 1 to 12, or 0 to\n                        specify a year without a month and day.\n                      x-kubernetes-immutable: true\n                    year:\n                      type: integer\n                      format: int64\n                      x-dcl-go-name: Year\n                      description: Year of the date. Must be from 1 to 9999, or 0\n                        to specify a date without a year.\n                      x-kubernetes-immutable: true\n            labels:\n              type: object\n              additionalProperties:\n                type: object\n                x-dcl-go-type: BudgetBudgetFilterLabels\n                properties:\n                  values:\n                    type: array\n                    x-dcl-go-name: Values\n                    description: The values of the label\n                    x-kubernetes-immutable: true\n                    x-dcl-send-empty: true\n                    x-dcl-list-type: list\n                    items:\n                      type: string\n                      x-dcl-go-type: string\n              x-dcl-go-name: Labels\n              description: Optional. A single label and value pair specifying that\n                usage from only this set of labeled resources should be included in\n                the budget. Currently, multiple entries or multiple values per entry\n                are not allowed. If omitted, the report will include all labeled and\n                unlabeled usage.\n            projects:\n              type: array\n              x-dcl-go-name: Projects\n              description: Optional. A set of projects of the form `projects/{project}`,\n                specifying that usage from only this set of projects should be included\n                in the budget. If omitted, the report will include all usage for the\n                billing account, regardless of which project the usage occurred on.\n                Only zero or one project can be specified currently.\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: string\n                x-dcl-go-type: string\n                x-dcl-references:\n                - resource: Cloudresourcemanager/Project\n                  field: name\n            services:\n              type: array\n              x-dcl-go-name: Services\n              description: 'Optional. A set of services of the form `services/{service_id}`,\n                specifying that usage from only this set of services should be included\n                in the budget. If omitted, the report will include usage for all the\n                services. The service names are available through the Catalog API:\n                https://cloud.google.com/billing/v1/how-tos/catalog-api.'\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: string\n                x-dcl-go-type: string\n            subaccounts:\n              type: array\n              x-dcl-go-name: Subaccounts\n              description: Optional. A set of subaccounts of the form `billingAccounts/{account_id}`,\n                specifying that usage from only this set of subaccounts should be\n                included in the budget. If a subaccount is set to the name of the\n                parent account, usage from the parent account will be included. If\n                the field is omitted, the report will include usage from the parent\n                account and all subaccounts, if they exist.\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: string\n                x-dcl-go-type: string\n                x-dcl-references:\n                - resource: Cloudbilling/BillingAccount\n                  field: name\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: User data for display name in UI. The name must be less than\n            or equal to 60 characters.\n        etag:\n          type: string\n          x-dcl-go-name: Etag\n          readOnly: true\n          description: Optional. Etag to validate that the object is unchanged for\n            a read-modify-write operation. An empty etag will cause an update to overwrite\n            other changes.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. Resource name of the budget.\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n          x-dcl-has-long-form: true\n        thresholdRules:\n          type: array\n          x-dcl-go-name: ThresholdRules\n          description: Optional. Rules that trigger alerts (notifications of thresholds\n            being crossed) when spend exceeds the specified percentages of the budget.\n          x-dcl-send-empty: true\n          x-dcl-list-type: list\n          items:\n            type: object\n            x-dcl-go-type: BudgetThresholdRules\n            required:\n            - thresholdPercent\n            properties:\n              spendBasis:\n                type: string\n                x-dcl-go-name: SpendBasis\n                x-dcl-go-type: BudgetThresholdRulesSpendBasisEnum\n                description: 'Optional. The type of basis used to determine if spend\n                  has passed the threshold. Behavior defaults to CURRENT_SPEND if\n                  not set. Possible values: BASIS_UNSPECIFIED, CURRENT_SPEND, FORECASTED_SPEND'\n                enum:\n                - BASIS_UNSPECIFIED\n                - CURRENT_SPEND\n                - FORECASTED_SPEND\n              thresholdPercent:\n                type: number\n                format: double\n                x-dcl-go-name: ThresholdPercent\n                description: 'Required. Send an alert when this threshold is exceeded.\n                  This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative\n                  number.'\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/billingbudgets/budget.yaml

Functions

func DCLBudgetSchema added in v1.10.3 

func DCLBudgetSchema() *dcl.Schema

Types

type Budget 

type Budget struct {
	Name           *string                `json:"name"`
	DisplayName    *string                `json:"displayName"`
	BudgetFilter   *BudgetBudgetFilter    `json:"budgetFilter"`
	Amount         *BudgetAmount          `json:"amount"`
	ThresholdRules []BudgetThresholdRules `json:"thresholdRules"`
	Etag           *string                `json:"etag"`
	AllUpdatesRule *BudgetAllUpdatesRule  `json:"allUpdatesRule"`
	BillingAccount *string                `json:"billingAccount"`
}

func (*Budget) Describe 

func (r *Budget) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Budget) ID 

func (r *Budget) ID() (string, error)

func (*Budget) String 

func (r *Budget) String() string

type BudgetAllUpdatesRule 

type BudgetAllUpdatesRule struct {
	PubsubTopic                    *string  `json:"pubsubTopic"`
	SchemaVersion                  *string  `json:"schemaVersion"`
	MonitoringNotificationChannels []string `json:"monitoringNotificationChannels"`
	DisableDefaultIamRecipients    *bool    `json:"disableDefaultIamRecipients"`
	// contains filtered or unexported fields
}
var EmptyBudgetAllUpdatesRule *BudgetAllUpdatesRule = &BudgetAllUpdatesRule{empty: true}

This object is used to assert a desired state where this BudgetAllUpdatesRule is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetAllUpdatesRule) Empty 

func (r *BudgetAllUpdatesRule) Empty() bool

func (*BudgetAllUpdatesRule) HashCode 

func (r *BudgetAllUpdatesRule) HashCode() string

func (*BudgetAllUpdatesRule) String 

func (r *BudgetAllUpdatesRule) String() string

func (*BudgetAllUpdatesRule) UnmarshalJSON 

func (r *BudgetAllUpdatesRule) UnmarshalJSON(data []byte) error

type BudgetAmount 

type BudgetAmount struct {
	SpecifiedAmount  *BudgetAmountSpecifiedAmount  `json:"specifiedAmount"`
	LastPeriodAmount *BudgetAmountLastPeriodAmount `json:"lastPeriodAmount"`
	// contains filtered or unexported fields
}
var EmptyBudgetAmount *BudgetAmount = &BudgetAmount{empty: true}

This object is used to assert a desired state where this BudgetAmount is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetAmount) Empty 

func (r *BudgetAmount) Empty() bool

func (*BudgetAmount) HashCode 

func (r *BudgetAmount) HashCode() string

func (*BudgetAmount) String 

func (r *BudgetAmount) String() string

func (*BudgetAmount) UnmarshalJSON 

func (r *BudgetAmount) UnmarshalJSON(data []byte) error

type BudgetAmountLastPeriodAmount 

type BudgetAmountLastPeriodAmount struct {
	// contains filtered or unexported fields
}
var EmptyBudgetAmountLastPeriodAmount *BudgetAmountLastPeriodAmount = &BudgetAmountLastPeriodAmount{empty: true}

This object is used to assert a desired state where this BudgetAmountLastPeriodAmount is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetAmountLastPeriodAmount) Empty 

func (r *BudgetAmountLastPeriodAmount) Empty() bool

func (*BudgetAmountLastPeriodAmount) HashCode 

func (r *BudgetAmountLastPeriodAmount) HashCode() string

func (*BudgetAmountLastPeriodAmount) String 

func (r *BudgetAmountLastPeriodAmount) String() string

func (*BudgetAmountLastPeriodAmount) UnmarshalJSON 

func (r *BudgetAmountLastPeriodAmount) UnmarshalJSON(data []byte) error

type BudgetAmountSpecifiedAmount 

type BudgetAmountSpecifiedAmount struct {
	CurrencyCode *string `json:"currencyCode"`
	Units        *int64  `json:"units"`
	Nanos        *int64  `json:"nanos"`
	// contains filtered or unexported fields
}
var EmptyBudgetAmountSpecifiedAmount *BudgetAmountSpecifiedAmount = &BudgetAmountSpecifiedAmount{empty: true}

This object is used to assert a desired state where this BudgetAmountSpecifiedAmount is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetAmountSpecifiedAmount) Empty 

func (r *BudgetAmountSpecifiedAmount) Empty() bool

func (*BudgetAmountSpecifiedAmount) HashCode 

func (r *BudgetAmountSpecifiedAmount) HashCode() string

func (*BudgetAmountSpecifiedAmount) String 

func (r *BudgetAmountSpecifiedAmount) String() string

func (*BudgetAmountSpecifiedAmount) UnmarshalJSON 

func (r *BudgetAmountSpecifiedAmount) UnmarshalJSON(data []byte) error

type BudgetBudgetFilter 

type BudgetBudgetFilter struct {
	Projects             []string                                    `json:"projects"`
	CreditTypes          []string                                    `json:"creditTypes"`
	CreditTypesTreatment *BudgetBudgetFilterCreditTypesTreatmentEnum `json:"creditTypesTreatment"`
	Services             []string                                    `json:"services"`
	Subaccounts          []string                                    `json:"subaccounts"`
	Labels               map[string]BudgetBudgetFilterLabels         `json:"labels"`
	CalendarPeriod       *BudgetBudgetFilterCalendarPeriodEnum       `json:"calendarPeriod"`
	CustomPeriod         *BudgetBudgetFilterCustomPeriod             `json:"customPeriod"`
	// contains filtered or unexported fields
}
var EmptyBudgetBudgetFilter *BudgetBudgetFilter = &BudgetBudgetFilter{empty: true}

This object is used to assert a desired state where this BudgetBudgetFilter is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetBudgetFilter) Empty 

func (r *BudgetBudgetFilter) Empty() bool

func (*BudgetBudgetFilter) HashCode 

func (r *BudgetBudgetFilter) HashCode() string

func (*BudgetBudgetFilter) String 

func (r *BudgetBudgetFilter) String() string

func (*BudgetBudgetFilter) UnmarshalJSON 

func (r *BudgetBudgetFilter) UnmarshalJSON(data []byte) error

type BudgetBudgetFilterCalendarPeriodEnum 

type BudgetBudgetFilterCalendarPeriodEnum string

The enum BudgetBudgetFilterCalendarPeriodEnum.

func BudgetBudgetFilterCalendarPeriodEnumRef 

func BudgetBudgetFilterCalendarPeriodEnumRef(s string) *BudgetBudgetFilterCalendarPeriodEnum

BudgetBudgetFilterCalendarPeriodEnumRef returns a *BudgetBudgetFilterCalendarPeriodEnum with the value of string s If the empty string is provided, nil is returned.

func (BudgetBudgetFilterCalendarPeriodEnum) Validate 

func (v BudgetBudgetFilterCalendarPeriodEnum) Validate() error

type BudgetBudgetFilterCreditTypesTreatmentEnum 

type BudgetBudgetFilterCreditTypesTreatmentEnum string

The enum BudgetBudgetFilterCreditTypesTreatmentEnum.

func BudgetBudgetFilterCreditTypesTreatmentEnumRef 

func BudgetBudgetFilterCreditTypesTreatmentEnumRef(s string) *BudgetBudgetFilterCreditTypesTreatmentEnum

BudgetBudgetFilterCreditTypesTreatmentEnumRef returns a *BudgetBudgetFilterCreditTypesTreatmentEnum with the value of string s If the empty string is provided, nil is returned.

func (BudgetBudgetFilterCreditTypesTreatmentEnum) Validate 

func (v BudgetBudgetFilterCreditTypesTreatmentEnum) Validate() error

type BudgetBudgetFilterCustomPeriod 

type BudgetBudgetFilterCustomPeriod struct {
	StartDate *BudgetBudgetFilterCustomPeriodStartDate `json:"startDate"`
	EndDate   *BudgetBudgetFilterCustomPeriodEndDate   `json:"endDate"`
	// contains filtered or unexported fields
}
var EmptyBudgetBudgetFilterCustomPeriod *BudgetBudgetFilterCustomPeriod = &BudgetBudgetFilterCustomPeriod{empty: true}

This object is used to assert a desired state where this BudgetBudgetFilterCustomPeriod is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetBudgetFilterCustomPeriod) Empty 

func (r *BudgetBudgetFilterCustomPeriod) Empty() bool

func (*BudgetBudgetFilterCustomPeriod) HashCode 

func (r *BudgetBudgetFilterCustomPeriod) HashCode() string

func (*BudgetBudgetFilterCustomPeriod) String 

func (r *BudgetBudgetFilterCustomPeriod) String() string

func (*BudgetBudgetFilterCustomPeriod) UnmarshalJSON 

func (r *BudgetBudgetFilterCustomPeriod) UnmarshalJSON(data []byte) error

type BudgetBudgetFilterCustomPeriodEndDate 

type BudgetBudgetFilterCustomPeriodEndDate struct {
	Year  *int64 `json:"year"`
	Month *int64 `json:"month"`
	Day   *int64 `json:"day"`
	// contains filtered or unexported fields
}
var EmptyBudgetBudgetFilterCustomPeriodEndDate *BudgetBudgetFilterCustomPeriodEndDate = &BudgetBudgetFilterCustomPeriodEndDate{empty: true}

This object is used to assert a desired state where this BudgetBudgetFilterCustomPeriodEndDate is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetBudgetFilterCustomPeriodEndDate) Empty 

func (r *BudgetBudgetFilterCustomPeriodEndDate) Empty() bool

func (*BudgetBudgetFilterCustomPeriodEndDate) HashCode 

func (r *BudgetBudgetFilterCustomPeriodEndDate) HashCode() string

func (*BudgetBudgetFilterCustomPeriodEndDate) String 

func (r *BudgetBudgetFilterCustomPeriodEndDate) String() string

func (*BudgetBudgetFilterCustomPeriodEndDate) UnmarshalJSON 

func (r *BudgetBudgetFilterCustomPeriodEndDate) UnmarshalJSON(data []byte) error

type BudgetBudgetFilterCustomPeriodStartDate 

type BudgetBudgetFilterCustomPeriodStartDate struct {
	Year  *int64 `json:"year"`
	Month *int64 `json:"month"`
	Day   *int64 `json:"day"`
	// contains filtered or unexported fields
}
var EmptyBudgetBudgetFilterCustomPeriodStartDate *BudgetBudgetFilterCustomPeriodStartDate = &BudgetBudgetFilterCustomPeriodStartDate{empty: true}

This object is used to assert a desired state where this BudgetBudgetFilterCustomPeriodStartDate is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetBudgetFilterCustomPeriodStartDate) Empty 

func (r *BudgetBudgetFilterCustomPeriodStartDate) Empty() bool

func (*BudgetBudgetFilterCustomPeriodStartDate) HashCode 

func (r *BudgetBudgetFilterCustomPeriodStartDate) HashCode() string

func (*BudgetBudgetFilterCustomPeriodStartDate) String 

func (r *BudgetBudgetFilterCustomPeriodStartDate) String() string

func (*BudgetBudgetFilterCustomPeriodStartDate) UnmarshalJSON 

func (r *BudgetBudgetFilterCustomPeriodStartDate) UnmarshalJSON(data []byte) error

type BudgetBudgetFilterLabels 

type BudgetBudgetFilterLabels struct {
	Values []string `json:"values"`
	// contains filtered or unexported fields
}
var EmptyBudgetBudgetFilterLabels *BudgetBudgetFilterLabels = &BudgetBudgetFilterLabels{empty: true}

This object is used to assert a desired state where this BudgetBudgetFilterLabels is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetBudgetFilterLabels) Empty 

func (r *BudgetBudgetFilterLabels) Empty() bool

func (*BudgetBudgetFilterLabels) HashCode 

func (r *BudgetBudgetFilterLabels) HashCode() string

func (*BudgetBudgetFilterLabels) String 

func (r *BudgetBudgetFilterLabels) String() string

func (*BudgetBudgetFilterLabels) UnmarshalJSON 

func (r *BudgetBudgetFilterLabels) UnmarshalJSON(data []byte) error

type BudgetList 

type BudgetList struct {
	Items []*Budget
	// contains filtered or unexported fields
}

func (*BudgetList) HasNext 

func (l *BudgetList) HasNext() bool

func (*BudgetList) Next 

func (l *BudgetList) Next(ctx context.Context, c *Client) error

type BudgetThresholdRules 

type BudgetThresholdRules struct {
	ThresholdPercent *float64                            `json:"thresholdPercent"`
	SpendBasis       *BudgetThresholdRulesSpendBasisEnum `json:"spendBasis"`
	// contains filtered or unexported fields
}
var EmptyBudgetThresholdRules *BudgetThresholdRules = &BudgetThresholdRules{empty: true}

This object is used to assert a desired state where this BudgetThresholdRules is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*BudgetThresholdRules) Empty 

func (r *BudgetThresholdRules) Empty() bool

func (*BudgetThresholdRules) HashCode 

func (r *BudgetThresholdRules) HashCode() string

func (*BudgetThresholdRules) String 

func (r *BudgetThresholdRules) String() string

func (*BudgetThresholdRules) UnmarshalJSON 

func (r *BudgetThresholdRules) UnmarshalJSON(data []byte) error

type BudgetThresholdRulesSpendBasisEnum 

type BudgetThresholdRulesSpendBasisEnum string

The enum BudgetThresholdRulesSpendBasisEnum.

func BudgetThresholdRulesSpendBasisEnumRef 

func BudgetThresholdRulesSpendBasisEnumRef(s string) *BudgetThresholdRulesSpendBasisEnum

BudgetThresholdRulesSpendBasisEnumRef returns a *BudgetThresholdRulesSpendBasisEnum with the value of string s If the empty string is provided, nil is returned.

func (BudgetThresholdRulesSpendBasisEnum) Validate 

func (v BudgetThresholdRulesSpendBasisEnum) Validate() error

type Client 

type Client struct {
	Config *dcl.Config
}

The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.

func NewClient 

func NewClient(c *dcl.Config) *Client

NewClient creates a client that retries all operations a few times each.

func (*Client) ApplyBudget 

func (c *Client) ApplyBudget(ctx context.Context, rawDesired *Budget, opts ...dcl.ApplyOption) (*Budget, error)

func (*Client) DeleteAllBudget 

func (c *Client) DeleteAllBudget(ctx context.Context, billingAccount string, filter func(*Budget) bool) error

DeleteAllBudget deletes all resources that the filter functions returns true on.

func (*Client) DeleteBudget 

func (c *Client) DeleteBudget(ctx context.Context, r *Budget) error

func (*Client) GetBudget 

func (c *Client) GetBudget(ctx context.Context, r *Budget) (*Budget, error)

func (*Client) ListBudget 

func (c *Client) ListBudget(ctx context.Context, billingAccount string) (*BudgetList, error)

func (*Client) ListBudgetWithMaxResults 

func (c *Client) ListBudgetWithMaxResults(ctx context.Context, billingAccount string, pageSize int32) (*BudgetList, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.