google-api-ruby-client/generated/google/apis/cloudbilling_v1/classes.rb

1164 lines
48 KiB
Ruby

# Copyright 2015 Google Inc.
#
# 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.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudbillingV1
# Represents the aggregation level and interval for pricing of a single SKU.
class AggregationInfo
include Google::Apis::Core::Hashable
# The number of intervals to aggregate over.
# Example: If aggregation_level is "DAILY" and aggregation_count is 14,
# aggregation will be over 14 days.
# Corresponds to the JSON property `aggregationCount`
# @return [Fixnum]
attr_accessor :aggregation_count
#
# Corresponds to the JSON property `aggregationInterval`
# @return [String]
attr_accessor :aggregation_interval
#
# Corresponds to the JSON property `aggregationLevel`
# @return [String]
attr_accessor :aggregation_level
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@aggregation_count = args[:aggregation_count] if args.key?(:aggregation_count)
@aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval)
@aggregation_level = args[:aggregation_level] if args.key?(:aggregation_level)
end
end
# Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
# Example Policy with multiple AuditConfigs:
# `
# "audit_configs": [
# `
# "service": "allServices",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `,
# `
# "log_type": "ADMIN_READ"
# `
# ]
# `,
# `
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ"
# `,
# `
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# `
# ]
# `
# ]
# `
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
class AuditConfig
include Google::Apis::Core::Hashable
# The configuration for logging of each type of permission.
# Corresponds to the JSON property `auditLogConfigs`
# @return [Array<Google::Apis::CloudbillingV1::AuditLogConfig>]
attr_accessor :audit_log_configs
# Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs)
@service = args[:service] if args.key?(:service)
end
end
# Provides the configuration for logging a type of permissions.
# Example:
# `
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `
# ]
# `
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
class AuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
# The log type that this config enables.
# Corresponds to the JSON property `logType`
# @return [String]
attr_accessor :log_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@exempted_members = args[:exempted_members] if args.key?(:exempted_members)
@log_type = args[:log_type] if args.key?(:log_type)
end
end
# A billing account in [GCP Console](https://console.cloud.google.com/).
# You can assign a billing account to one or more projects.
class BillingAccount
include Google::Apis::Core::Hashable
# The display name given to the billing account, such as `My Billing
# Account`. This name is displayed in the GCP Console.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# If this account is a
# [subaccount](https://cloud.google.com/billing/docs/concepts), then this
# will be the resource name of the master billing account that it is being
# resold through.
# Otherwise this will be empty.
# Corresponds to the JSON property `masterBillingAccount`
# @return [String]
attr_accessor :master_billing_account
# The resource name of the billing account. The resource name has the form
# `billingAccounts/`billing_account_id``. For example,
# `billingAccounts/012345-567890-ABCDEF` would be the resource name for
# billing account `012345-567890-ABCDEF`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. True if the billing account is open, and will therefore be
# charged for any
# usage on associated projects. False if the billing account is closed, and
# therefore projects associated with it will be unable to use paid services.
# Corresponds to the JSON property `open`
# @return [Boolean]
attr_accessor :open
alias_method :open?, :open
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@master_billing_account = args[:master_billing_account] if args.key?(:master_billing_account)
@name = args[:name] if args.key?(:name)
@open = args[:open] if args.key?(:open)
end
end
# Associates `members` with a `role`.
class Binding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::CloudbillingV1::Expr]
attr_accessor :condition
# Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google
# account. For example, `alice@example.com` .
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group.
# For example, `admins@example.com`.
# * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:`emailid`` and the recovered user
# retains the role in the binding.
# * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:`emailid`` and the undeleted service account retains the
# role in the binding.
# * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:`emailid`` and the
# recovered group retains the role in the binding.
# * `domain:`domain``: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@condition = args[:condition] if args.key?(:condition)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
# Represents the category hierarchy of a SKU.
class Category
include Google::Apis::Core::Hashable
# The type of product the SKU refers to.
# Example: "Compute", "Storage", "Network", "ApplicationServices" etc.
# Corresponds to the JSON property `resourceFamily`
# @return [String]
attr_accessor :resource_family
# A group classification for related SKUs.
# Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.
# Corresponds to the JSON property `resourceGroup`
# @return [String]
attr_accessor :resource_group
# The display name of the service this SKU belongs to.
# Corresponds to the JSON property `serviceDisplayName`
# @return [String]
attr_accessor :service_display_name
# Represents how the SKU is consumed.
# Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.
# Corresponds to the JSON property `usageType`
# @return [String]
attr_accessor :usage_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_family = args[:resource_family] if args.key?(:resource_family)
@resource_group = args[:resource_group] if args.key?(:resource_group)
@service_display_name = args[:service_display_name] if args.key?(:service_display_name)
@usage_type = args[:usage_type] if args.key?(:usage_type)
end
end
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language
# syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@expression = args[:expression] if args.key?(:expression)
@location = args[:location] if args.key?(:location)
@title = args[:title] if args.key?(:title)
end
end
# Encapsulates the geographic taxonomy data for a sku.
class GeoTaxonomy
include Google::Apis::Core::Hashable
# The list of regions associated with a sku. Empty for Global skus, which are
# associated with all GCP regions.
# Corresponds to the JSON property `regions`
# @return [Array<String>]
attr_accessor :regions
# The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@regions = args[:regions] if args.key?(:regions)
@type = args[:type] if args.key?(:type)
end
end
# Response message for `ListBillingAccounts`.
class ListBillingAccountsResponse
include Google::Apis::Core::Hashable
# A list of billing accounts.
# Corresponds to the JSON property `billingAccounts`
# @return [Array<Google::Apis::CloudbillingV1::BillingAccount>]
attr_accessor :billing_accounts
# A token to retrieve the next page of results. To retrieve the next page,
# call `ListBillingAccounts` again with the `page_token` field set to this
# value. This field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@billing_accounts = args[:billing_accounts] if args.key?(:billing_accounts)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for `ListProjectBillingInfoResponse`.
class ListProjectBillingInfoResponse
include Google::Apis::Core::Hashable
# A token to retrieve the next page of results. To retrieve the next page,
# call `ListProjectBillingInfo` again with the `page_token` field set to this
# value. This field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of `ProjectBillingInfo` resources representing the projects
# associated with the billing account.
# Corresponds to the JSON property `projectBillingInfo`
# @return [Array<Google::Apis::CloudbillingV1::ProjectBillingInfo>]
attr_accessor :project_billing_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@project_billing_info = args[:project_billing_info] if args.key?(:project_billing_info)
end
end
# Response message for `ListServices`.
class ListServicesResponse
include Google::Apis::Core::Hashable
# A token to retrieve the next page of results. To retrieve the next page,
# call `ListServices` again with the `page_token` field set to this
# value. This field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of services.
# Corresponds to the JSON property `services`
# @return [Array<Google::Apis::CloudbillingV1::Service>]
attr_accessor :services
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@services = args[:services] if args.key?(:services)
end
end
# Response message for `ListSkus`.
class ListSkusResponse
include Google::Apis::Core::Hashable
# A token to retrieve the next page of results. To retrieve the next page,
# call `ListSkus` again with the `page_token` field set to this
# value. This field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of public SKUs of the given service.
# Corresponds to the JSON property `skus`
# @return [Array<Google::Apis::CloudbillingV1::Sku>]
attr_accessor :skus
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@skus = args[:skus] if args.key?(:skus)
end
end
# Represents an amount of money with its currency type.
class Money
include Google::Apis::Core::Hashable
# The 3-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
# The whole units of the amount.
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
# Corresponds to the JSON property `units`
# @return [Fixnum]
attr_accessor :units
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@nanos = args[:nanos] if args.key?(:nanos)
@units = args[:units] if args.key?(:units)
end
end
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-
# policies).
# **JSON example:**
# `
# "bindings": [
# `
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# `,
# `
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": `
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')
# ",
# `
# `
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# `
# **YAML example:**
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
class Policy
include Google::Apis::Core::Hashable
# Specifies cloud audit logging configuration for this policy.
# Corresponds to the JSON property `auditConfigs`
# @return [Array<Google::Apis::CloudbillingV1::AuditConfig>]
attr_accessor :audit_configs
# Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudbillingV1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# Specifies the format of the policy.
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-
# policies).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_configs = args[:audit_configs] if args.key?(:audit_configs)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# Expresses a mathematical pricing formula. For Example:-
# `usage_unit: GBy`
# `tiered_rates:`
# `[start_usage_amount: 20, unit_price: $10]`
# `[start_usage_amount: 100, unit_price: $5]`
# The above expresses a pricing formula where the first 20GB is free, the
# next 80GB is priced at $10 per GB followed by $5 per GB for additional
# usage.
class PricingExpression
include Google::Apis::Core::Hashable
# The base unit for the SKU which is the unit used in usage exports.
# Example: "By"
# Corresponds to the JSON property `baseUnit`
# @return [String]
attr_accessor :base_unit
# Conversion factor for converting from price per usage_unit to price per
# base_unit, and start_usage_amount to start_usage_amount in base_unit.
# unit_price / base_unit_conversion_factor = price per base_unit.
# start_usage_amount * base_unit_conversion_factor = start_usage_amount in
# base_unit.
# Corresponds to the JSON property `baseUnitConversionFactor`
# @return [Float]
attr_accessor :base_unit_conversion_factor
# The base unit in human readable form.
# Example: "byte".
# Corresponds to the JSON property `baseUnitDescription`
# @return [String]
attr_accessor :base_unit_description
# The recommended quantity of units for displaying pricing info. When
# displaying pricing info it is recommended to display:
# (unit_price * display_quantity) per display_quantity usage_unit.
# This field does not affect the pricing formula and is for display purposes
# only.
# Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and
# the display_quantity is "1000" then the recommended way of displaying the
# pricing info is "0.10 USD per 1000 GB"
# Corresponds to the JSON property `displayQuantity`
# @return [Float]
attr_accessor :display_quantity
# The list of tiered rates for this pricing. The total cost is computed by
# applying each of the tiered rates on usage. This repeated list is sorted
# by ascending order of start_usage_amount.
# Corresponds to the JSON property `tieredRates`
# @return [Array<Google::Apis::CloudbillingV1::TierRate>]
attr_accessor :tiered_rates
# The short hand for unit of usage this pricing is specified in.
# Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".
# Corresponds to the JSON property `usageUnit`
# @return [String]
attr_accessor :usage_unit
# The unit of usage in human readable form.
# Example: "gibi byte".
# Corresponds to the JSON property `usageUnitDescription`
# @return [String]
attr_accessor :usage_unit_description
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@base_unit = args[:base_unit] if args.key?(:base_unit)
@base_unit_conversion_factor = args[:base_unit_conversion_factor] if args.key?(:base_unit_conversion_factor)
@base_unit_description = args[:base_unit_description] if args.key?(:base_unit_description)
@display_quantity = args[:display_quantity] if args.key?(:display_quantity)
@tiered_rates = args[:tiered_rates] if args.key?(:tiered_rates)
@usage_unit = args[:usage_unit] if args.key?(:usage_unit)
@usage_unit_description = args[:usage_unit_description] if args.key?(:usage_unit_description)
end
end
# Represents the pricing information for a SKU at a single point of time.
class PricingInfo
include Google::Apis::Core::Hashable
# Represents the aggregation level and interval for pricing of a single SKU.
# Corresponds to the JSON property `aggregationInfo`
# @return [Google::Apis::CloudbillingV1::AggregationInfo]
attr_accessor :aggregation_info
# Conversion rate used for currency conversion, from USD to the currency
# specified in the request. This includes any surcharge collected for billing
# in non USD currency. If a currency is not specified in the request this
# defaults to 1.0.
# Example: USD * currency_conversion_rate = JPY
# Corresponds to the JSON property `currencyConversionRate`
# @return [Float]
attr_accessor :currency_conversion_rate
# The timestamp from which this pricing was effective within the requested
# time range. This is guaranteed to be greater than or equal to the
# start_time field in the request and less than the end_time field in the
# request. If a time range was not specified in the request this field will
# be equivalent to a time within the last 12 hours, indicating the latest
# pricing info.
# Corresponds to the JSON property `effectiveTime`
# @return [String]
attr_accessor :effective_time
# Expresses a mathematical pricing formula. For Example:-
# `usage_unit: GBy`
# `tiered_rates:`
# `[start_usage_amount: 20, unit_price: $10]`
# `[start_usage_amount: 100, unit_price: $5]`
# The above expresses a pricing formula where the first 20GB is free, the
# next 80GB is priced at $10 per GB followed by $5 per GB for additional
# usage.
# Corresponds to the JSON property `pricingExpression`
# @return [Google::Apis::CloudbillingV1::PricingExpression]
attr_accessor :pricing_expression
# An optional human readable summary of the pricing information, has a
# maximum length of 256 characters.
# Corresponds to the JSON property `summary`
# @return [String]
attr_accessor :summary
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@aggregation_info = args[:aggregation_info] if args.key?(:aggregation_info)
@currency_conversion_rate = args[:currency_conversion_rate] if args.key?(:currency_conversion_rate)
@effective_time = args[:effective_time] if args.key?(:effective_time)
@pricing_expression = args[:pricing_expression] if args.key?(:pricing_expression)
@summary = args[:summary] if args.key?(:summary)
end
end
# Encapsulation of billing information for a GCP Console project. A project
# has at most one associated billing account at a time (but a billing account
# can be assigned to multiple projects).
class ProjectBillingInfo
include Google::Apis::Core::Hashable
# The resource name of the billing account associated with the project, if
# any. For example, `billingAccounts/012345-567890-ABCDEF`.
# Corresponds to the JSON property `billingAccountName`
# @return [String]
attr_accessor :billing_account_name
# True if the project is associated with an open billing account, to which
# usage on the project is charged. False if the project is associated with a
# closed billing account, or no billing account at all, and therefore cannot
# use paid services. This field is read-only.
# Corresponds to the JSON property `billingEnabled`
# @return [Boolean]
attr_accessor :billing_enabled
alias_method :billing_enabled?, :billing_enabled
# The resource name for the `ProjectBillingInfo`; has the form
# `projects/`project_id`/billingInfo`. For example, the resource name for the
# billing information for project `tokyo-rain-123` would be
# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The ID of the project that this `ProjectBillingInfo` represents, such as
# `tokyo-rain-123`. This is a convenience field so that you don't need to
# parse the `name` field to obtain a project ID. This field is read-only.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@billing_account_name = args[:billing_account_name] if args.key?(:billing_account_name)
@billing_enabled = args[:billing_enabled] if args.key?(:billing_enabled)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# Encapsulates a single service in Google Cloud Platform.
class Service
include Google::Apis::Core::Hashable
# The business under which the service is offered.
# Ex. "businessEntities/GCP", "businessEntities/Maps"
# Corresponds to the JSON property `businessEntityName`
# @return [String]
attr_accessor :business_entity_name
# A human readable display name for this service.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The resource name for the service.
# Example: "services/DA34-426B-A397"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The identifier for the service.
# Example: "DA34-426B-A397"
# Corresponds to the JSON property `serviceId`
# @return [String]
attr_accessor :service_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@business_entity_name = args[:business_entity_name] if args.key?(:business_entity_name)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@service_id = args[:service_id] if args.key?(:service_id)
end
end
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-
# policies).
# **JSON example:**
# `
# "bindings": [
# `
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# `,
# `
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": `
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')
# ",
# `
# `
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# `
# **YAML example:**
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::CloudbillingV1::Policy]
attr_accessor :policy
# OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
# `paths: "bindings, etag"`
# Corresponds to the JSON property `updateMask`
# @return [String]
attr_accessor :update_mask
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@policy = args[:policy] if args.key?(:policy)
@update_mask = args[:update_mask] if args.key?(:update_mask)
end
end
# Encapsulates a single SKU in Google Cloud Platform
class Sku
include Google::Apis::Core::Hashable
# Represents the category hierarchy of a SKU.
# Corresponds to the JSON property `category`
# @return [Google::Apis::CloudbillingV1::Category]
attr_accessor :category
# A human readable description of the SKU, has a maximum length of 256
# characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Encapsulates the geographic taxonomy data for a sku.
# Corresponds to the JSON property `geoTaxonomy`
# @return [Google::Apis::CloudbillingV1::GeoTaxonomy]
attr_accessor :geo_taxonomy
# The resource name for the SKU.
# Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A timeline of pricing info for this SKU in chronological order.
# Corresponds to the JSON property `pricingInfo`
# @return [Array<Google::Apis::CloudbillingV1::PricingInfo>]
attr_accessor :pricing_info
# Identifies the service provider.
# This is 'Google' for first party services in Google Cloud Platform.
# Corresponds to the JSON property `serviceProviderName`
# @return [String]
attr_accessor :service_provider_name
# List of service regions this SKU is offered at.
# Example: "asia-east1"
# Service regions can be found at https://cloud.google.com/about/locations/
# Corresponds to the JSON property `serviceRegions`
# @return [Array<String>]
attr_accessor :service_regions
# The identifier for the SKU.
# Example: "AA95-CD31-42FE"
# Corresponds to the JSON property `skuId`
# @return [String]
attr_accessor :sku_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@category = args[:category] if args.key?(:category)
@description = args[:description] if args.key?(:description)
@geo_taxonomy = args[:geo_taxonomy] if args.key?(:geo_taxonomy)
@name = args[:name] if args.key?(:name)
@pricing_info = args[:pricing_info] if args.key?(:pricing_info)
@service_provider_name = args[:service_provider_name] if args.key?(:service_provider_name)
@service_regions = args[:service_regions] if args.key?(:service_regions)
@sku_id = args[:sku_id] if args.key?(:sku_id)
end
end
# Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# The price rate indicating starting usage and its corresponding price.
class TierRate
include Google::Apis::Core::Hashable
# Usage is priced at this rate only after this amount.
# Example: start_usage_amount of 10 indicates that the usage will be priced
# at the unit_price after the first 10 usage_units.
# Corresponds to the JSON property `startUsageAmount`
# @return [Float]
attr_accessor :start_usage_amount
# Represents an amount of money with its currency type.
# Corresponds to the JSON property `unitPrice`
# @return [Google::Apis::CloudbillingV1::Money]
attr_accessor :unit_price
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@start_usage_amount = args[:start_usage_amount] if args.key?(:start_usage_amount)
@unit_price = args[:unit_price] if args.key?(:unit_price)
end
end
end
end
end