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

1676 lines
73 KiB
Ruby
Raw Normal View History

2017-03-30 22:30:51 +00:00
# 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 ServicecontrolV1
2017-03-31 19:53:27 +00:00
# Represents a single metric value.
class MetricValue
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# A text string value.
# Corresponds to the JSON property `stringValue`
# @return [String]
attr_accessor :string_value
# The labels describing the metric value.
# See comments on google.api.servicecontrol.v1.Operation.labels for
# the overriding relationship.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
2017-03-31 19:53:27 +00:00
# A double precision floating point value.
# Corresponds to the JSON property `doubleValue`
# @return [Float]
attr_accessor :double_value
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# A signed 64-bit integer value.
# Corresponds to the JSON property `int64Value`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :int64_value
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Distribution represents a frequency distribution of double-valued sample
# points. It contains the size of the population of sample points plus
# additional optional information:
# - the arithmetic mean of the samples
# - the minimum and maximum of the samples
# - the sum-squared-deviation of the samples, used to compute variance
# - a histogram of the values of the sample points
# Corresponds to the JSON property `distributionValue`
# @return [Google::Apis::ServicecontrolV1::Distribution]
attr_accessor :distribution_value
# A boolean value.
# Corresponds to the JSON property `boolValue`
# @return [Boolean]
attr_accessor :bool_value
alias_method :bool_value?, :bool_value
# The end of the time period over which this metric value's measurement
# applies.
# Corresponds to the JSON property `endTime`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :end_time
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The start of the time period over which this metric value's measurement
# applies. The time period has different semantics for different metric
# types (cumulative, delta, and gauge). See the metric definition
# documentation in the service configuration for details.
# Corresponds to the JSON property `startTime`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :start_time
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Represents an amount of money with its currency type.
# Corresponds to the JSON property `moneyValue`
# @return [Google::Apis::ServicecontrolV1::Money]
attr_accessor :money_value
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@string_value = args[:string_value] if args.key?(:string_value)
2017-03-30 22:30:51 +00:00
@labels = args[:labels] if args.key?(:labels)
2017-03-31 19:53:27 +00:00
@double_value = args[:double_value] if args.key?(:double_value)
@int64_value = args[:int64_value] if args.key?(:int64_value)
@distribution_value = args[:distribution_value] if args.key?(:distribution_value)
@bool_value = args[:bool_value] if args.key?(:bool_value)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
@money_value = args[:money_value] if args.key?(:money_value)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents an amount of money with its currency type.
class Money
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The 3-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# 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`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :units
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@currency_code = args[:currency_code] if args.key?(:currency_code)
@nanos = args[:nanos] if args.key?(:nanos)
@units = args[:units] if args.key?(:units)
2017-03-30 22:30:51 +00:00
end
end
#
2017-03-31 19:53:27 +00:00
class EndReconciliationResponse
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Metric values as tracked by One Platform before the adjustment was made.
# The following metrics will be included:
# 1. Per quota metric total usage will be specified using the following gauge
# metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
# 2. Value for each quota limit associated with the metrics will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/quota/limit"
# 3. Delta value of the usage after the reconciliation for limits associated
# with the metrics will be specified using the following metric:
# "serviceruntime.googleapis.com/allocation/reconciliation_delta"
# The delta value is defined as:
# new_usage_from_client - existing_value_in_spanner.
# This metric is not defined in serviceruntime.yaml or in Cloud Monarch.
# This metric is meant for callers' use only. Since this metric is not
# defined in the monitoring backend, reporting on this metric will result in
# an error.
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The same operation_id value used in the EndReconciliationRequest. Used for
# logging and diagnostics purposes.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `operationId`
# @return [String]
attr_accessor :operation_id
2017-03-31 19:53:27 +00:00
# Indicates the decision of the reconciliation end.
# Corresponds to the JSON property `reconciliationErrors`
# @return [Array<Google::Apis::ServicecontrolV1::QuotaError>]
attr_accessor :reconciliation_errors
# ID of the actual config used to process the request.
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
2017-03-30 22:30:51 +00:00
@operation_id = args[:operation_id] if args.key?(:operation_id)
2017-03-31 19:53:27 +00:00
@reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Describing buckets with arbitrary user-provided width.
class ExplicitBuckets
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# 'bound' is a list of strictly increasing boundaries between
# buckets. Note that a list of length N-1 defines N buckets because
# of fenceposting. See comments on `bucket_options` for details.
# The i'th finite bucket covers the interval
# [bound[i-1], bound[i])
# where i ranges from 1 to bound_size() - 1. Note that there are no
# finite buckets at all if 'bound' only contains a single element; in
# that special case the single bound defines the boundary between the
# underflow and overflow buckets.
# bucket number lower bound upper bound
# i == 0 (underflow) -inf bound[i]
# 0 < i < bound_size() bound[i-1] bound[i]
# i == bound_size() (overflow) bound[i-1] +inf
# Corresponds to the JSON property `bounds`
# @return [Array<Float>]
attr_accessor :bounds
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
def initialize(**args)
update!(**args)
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Update properties of this object
def update!(**args)
@bounds = args[:bounds] if args.key?(:bounds)
end
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Distribution represents a frequency distribution of double-valued sample
# points. It contains the size of the population of sample points plus
# additional optional information:
# - the arithmetic mean of the samples
# - the minimum and maximum of the samples
# - the sum-squared-deviation of the samples, used to compute variance
# - a histogram of the values of the sample points
class Distribution
include Google::Apis::Core::Hashable
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Describing buckets with exponentially growing width.
# Corresponds to the JSON property `exponentialBuckets`
# @return [Google::Apis::ServicecontrolV1::ExponentialBuckets]
attr_accessor :exponential_buckets
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The minimum of the population of values. Ignored if `count` is zero.
# Corresponds to the JSON property `minimum`
# @return [Float]
attr_accessor :minimum
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Describing buckets with constant width.
# Corresponds to the JSON property `linearBuckets`
# @return [Google::Apis::ServicecontrolV1::LinearBuckets]
attr_accessor :linear_buckets
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The total number of samples in the distribution. Must be >= 0.
# Corresponds to the JSON property `count`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :count
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The arithmetic mean of the samples in the distribution. If `count` is
# zero then this field must be zero.
# Corresponds to the JSON property `mean`
# @return [Float]
attr_accessor :mean
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The number of samples in each histogram bucket. `bucket_counts` are
# optional. If present, they must sum to the `count` value.
# The buckets are defined below in `bucket_option`. There are N buckets.
# `bucket_counts[0]` is the number of samples in the underflow bucket.
# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
# in each of the finite buckets. And `bucket_counts[N] is the number
# of samples in the overflow bucket. See the comments of `bucket_option`
# below for more details.
# Any suffix of trailing zeros may be omitted.
# Corresponds to the JSON property `bucketCounts`
# @return [Array<String>]
attr_accessor :bucket_counts
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Describing buckets with arbitrary user-provided width.
# Corresponds to the JSON property `explicitBuckets`
# @return [Google::Apis::ServicecontrolV1::ExplicitBuckets]
attr_accessor :explicit_buckets
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The maximum of the population of values. Ignored if `count` is zero.
# Corresponds to the JSON property `maximum`
# @return [Float]
attr_accessor :maximum
# The sum of squared deviations from the mean:
# Sum[i=1..count]((x_i - mean)^2)
# where each x_i is a sample values. If `count` is zero then this field
# must be zero, otherwise validation of the request fails.
# Corresponds to the JSON property `sumOfSquaredDeviation`
# @return [Float]
attr_accessor :sum_of_squared_deviation
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@exponential_buckets = args[:exponential_buckets] if args.key?(:exponential_buckets)
@minimum = args[:minimum] if args.key?(:minimum)
@linear_buckets = args[:linear_buckets] if args.key?(:linear_buckets)
@count = args[:count] if args.key?(:count)
@mean = args[:mean] if args.key?(:mean)
@bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts)
@explicit_buckets = args[:explicit_buckets] if args.key?(:explicit_buckets)
@maximum = args[:maximum] if args.key?(:maximum)
@sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Describing buckets with exponentially growing width.
class ExponentialBuckets
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The i'th exponential bucket covers the interval
# [scale * growth_factor^(i-1), scale * growth_factor^i)
# where i ranges from 1 to num_finite_buckets inclusive.
# Must be larger than 1.0.
# Corresponds to the JSON property `growthFactor`
# @return [Float]
attr_accessor :growth_factor
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The i'th exponential bucket covers the interval
# [scale * growth_factor^(i-1), scale * growth_factor^i)
# where i ranges from 1 to num_finite_buckets inclusive.
# Must be > 0.
# Corresponds to the JSON property `scale`
# @return [Float]
attr_accessor :scale
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The number of finite buckets. With the underflow and overflow buckets,
# the total number of buckets is `num_finite_buckets` + 2.
# See comments on `bucket_options` for details.
# Corresponds to the JSON property `numFiniteBuckets`
# @return [Fixnum]
attr_accessor :num_finite_buckets
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@growth_factor = args[:growth_factor] if args.key?(:growth_factor)
@scale = args[:scale] if args.key?(:scale)
@num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Authorization information for the operation.
class AuthorizationInfo
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The resource being accessed, as a REST-style string. For example:
# bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
# Corresponds to the JSON property `resource`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :resource
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Whether or not authorization for `resource` and `permission`
# was granted.
# Corresponds to the JSON property `granted`
# @return [Boolean]
attr_accessor :granted
alias_method :granted?, :granted
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The required IAM permission.
# Corresponds to the JSON property `permission`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :permission
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@resource = args[:resource] if args.key?(:resource)
@granted = args[:granted] if args.key?(:granted)
@permission = args[:permission] if args.key?(:permission)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
#
class StartReconciliationResponse
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The same operation_id value used in the StartReconciliationRequest. Used
# for logging and diagnostics purposes.
# Corresponds to the JSON property `operationId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :operation_id
# Indicates the decision of the reconciliation start.
# Corresponds to the JSON property `reconciliationErrors`
# @return [Array<Google::Apis::ServicecontrolV1::QuotaError>]
attr_accessor :reconciliation_errors
# ID of the actual config used to process the request.
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
# Metric values as tracked by One Platform before the start of
# reconciliation. The following metrics will be included:
# 1. Per quota metric total usage will be specified using the following gauge
# metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
# 2. Value for each quota limit associated with the metrics will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/quota/limit"
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@operation_id = args[:operation_id] if args.key?(:operation_id)
@reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors)
2017-03-30 22:30:51 +00:00
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
2017-03-31 19:53:27 +00:00
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents the properties needed for quota operations.
class QuotaProperties
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# LimitType IDs that should be used for checking quota. Key in this map
# should be a valid LimitType string, and the value is the ID to be used. For
# example, an entry <USER, 123> will cause all user quota limits to use 123
# as the user ID. See google/api/quota.proto for the definition of LimitType.
# CLIENT_PROJECT: Not supported.
# USER: Value of this entry will be used for enforcing user-level quota
# limits. If none specified, caller IP passed in the
# servicecontrol.googleapis.com/caller_ip label will be used instead.
# If the server cannot resolve a value for this LimitType, an error
# will be thrown. No validation will be performed on this ID.
# Deprecated: use servicecontrol.googleapis.com/user label to send user ID.
# Corresponds to the JSON property `limitByIds`
# @return [Hash<String,String>]
attr_accessor :limit_by_ids
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Quota mode for this operation.
# Corresponds to the JSON property `quotaMode`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :quota_mode
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@limit_by_ids = args[:limit_by_ids] if args.key?(:limit_by_ids)
@quota_mode = args[:quota_mode] if args.key?(:quota_mode)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Describing buckets with constant width.
class LinearBuckets
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The i'th linear bucket covers the interval
# [offset + (i-1) * width, offset + i * width)
# where i ranges from 1 to num_finite_buckets, inclusive.
# Corresponds to the JSON property `offset`
# @return [Float]
attr_accessor :offset
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The number of finite buckets. With the underflow and overflow buckets,
# the total number of buckets is `num_finite_buckets` + 2.
# See comments on `bucket_options` for details.
# Corresponds to the JSON property `numFiniteBuckets`
# @return [Fixnum]
attr_accessor :num_finite_buckets
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The i'th linear bucket covers the interval
# [offset + (i-1) * width, offset + i * width)
# where i ranges from 1 to num_finite_buckets, inclusive.
# Must be strictly positive.
# Corresponds to the JSON property `width`
# @return [Float]
attr_accessor :width
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@offset = args[:offset] if args.key?(:offset)
@num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets)
@width = args[:width] if args.key?(:width)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Authentication information for the operation.
class AuthenticationInfo
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The email address of the authenticated user making the request.
# Corresponds to the JSON property `principalEmail`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :principal_email
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The authority selector specified by the requestor, if any.
# It is not guaranteed that the principal was allowed to use this authority.
# Corresponds to the JSON property `authoritySelector`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :authority_selector
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@principal_email = args[:principal_email] if args.key?(:principal_email)
@authority_selector = args[:authority_selector] if args.key?(:authority_selector)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Response message for the AllocateQuota method.
class AllocateQuotaResponse
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# ID of the actual config used to process the request.
# Corresponds to the JSON property `serviceConfigId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Indicates the decision of the allocate.
# Corresponds to the JSON property `allocateErrors`
# @return [Array<Google::Apis::ServicecontrolV1::QuotaError>]
attr_accessor :allocate_errors
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Quota metrics to indicate the result of allocation. Depending on the
# request, one or more of the following metrics will be included:
# 1. For rate quota, per quota group or per quota metric incremental usage
# will be specified using the following delta metric:
# "serviceruntime.googleapis.com/api/consumer/quota_used_count"
# 2. For allocation quota, per quota metric total usage will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
# 3. For both rate quota and allocation quota, the quota limit reached
# condition will be specified using the following boolean metric:
# "serviceruntime.googleapis.com/quota/exceeded"
# 4. For allocation quota, value for each quota limit associated with
# the metrics will be specified using the following gauge metric:
# "serviceruntime.googleapis.com/quota/limit"
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The same operation_id value used in the AllocateQuotaRequest. Used for
# logging and diagnostics purposes.
# Corresponds to the JSON property `operationId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :operation_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
def initialize(**args)
update!(**args)
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Update properties of this object
def update!(**args)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@allocate_errors = args[:allocate_errors] if args.key?(:allocate_errors)
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
@operation_id = args[:operation_id] if args.key?(:operation_id)
end
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Request message for the ReleaseQuota method.
class ReleaseQuotaRequest
include Google::Apis::Core::Hashable
# Specifies which version of service configuration should be used to process
# the request. If unspecified or no matching version can be found, the latest
# one will be used.
# Corresponds to the JSON property `serviceConfigId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Represents information regarding a quota operation.
# Corresponds to the JSON property `releaseOperation`
# @return [Google::Apis::ServicecontrolV1::QuotaOperation]
attr_accessor :release_operation
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@release_operation = args[:release_operation] if args.key?(:release_operation)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Metadata about the request.
class RequestMetadata
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The IP address of the caller.
# Corresponds to the JSON property `callerIp`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :caller_ip
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The user agent of the caller.
# This information is not authenticated and should be treated accordingly.
# For example:
# + `google-api-python-client/1.4.0`:
# The request was made by the Google API client for Python.
# + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:
# The request was made by the Google Cloud SDK CLI (gcloud).
# + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`
# :
# The request was made from the `my-project` App Engine app.
# Corresponds to the JSON property `callerSuppliedUserAgent`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :caller_supplied_user_agent
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@caller_ip = args[:caller_ip] if args.key?(:caller_ip)
@caller_supplied_user_agent = args[:caller_supplied_user_agent] if args.key?(:caller_supplied_user_agent)
2017-03-30 22:30:51 +00:00
end
end
#
2017-03-31 19:53:27 +00:00
class QuotaError
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Subject to whom this error applies. See the specific enum for more details
# on this field. For example, "clientip:<ip address of client>" or
# "project:<Google developer project id>".
# Corresponds to the JSON property `subject`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :subject
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Free-form text that provides details on the cause of the error.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Error code.
# Corresponds to the JSON property `code`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :code
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@subject = args[:subject] if args.key?(:subject)
@description = args[:description] if args.key?(:description)
@code = args[:code] if args.key?(:code)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
#
class CheckInfo
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# A list of fields and label keys that are ignored by the server.
# The client doesn't need to send them for following requests to improve
# performance and allow better aggregation.
# Corresponds to the JSON property `unusedArguments`
2017-03-30 22:30:51 +00:00
# @return [Array<String>]
2017-03-31 19:53:27 +00:00
attr_accessor :unused_arguments
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
def initialize(**args)
update!(**args)
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Update properties of this object
def update!(**args)
@unused_arguments = args[:unused_arguments] if args.key?(:unused_arguments)
end
end
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Response message for the ReleaseQuota method.
class ReleaseQuotaResponse
include Google::Apis::Core::Hashable
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Quota metrics to indicate the result of release. Depending on the
# request, one or more of the following metrics will be included:
# 1. For rate quota, per quota group or per quota metric released amount
# will be specified using the following delta metric:
# "serviceruntime.googleapis.com/api/consumer/quota_refund_count"
# 2. For allocation quota, per quota metric total usage will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
# 3. For allocation quota, value for each quota limit associated with
# the metrics will be specified using the following gauge metric:
# "serviceruntime.googleapis.com/quota/limit"
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The same operation_id value used in the ReleaseQuotaRequest. Used for
# logging and diagnostics purposes.
# Corresponds to the JSON property `operationId`
# @return [String]
attr_accessor :operation_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# ID of the actual config used to process the request.
# Corresponds to the JSON property `serviceConfigId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Indicates the decision of the release.
# Corresponds to the JSON property `releaseErrors`
# @return [Array<Google::Apis::ServicecontrolV1::QuotaError>]
attr_accessor :release_errors
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
@operation_id = args[:operation_id] if args.key?(:operation_id)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@release_errors = args[:release_errors] if args.key?(:release_errors)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Request message for the AllocateQuota method.
class AllocateQuotaRequest
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Specifies which version of service configuration should be used to process
# the request. If unspecified or no matching version can be found, the latest
# one will be used.
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
# Represents information regarding a quota operation.
# Corresponds to the JSON property `allocateOperation`
# @return [Google::Apis::ServicecontrolV1::QuotaOperation]
attr_accessor :allocate_operation
# Allocation mode for this operation.
# Deprecated: use QuotaMode inside the QuotaOperation.
# Corresponds to the JSON property `allocationMode`
# @return [String]
attr_accessor :allocation_mode
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@allocate_operation = args[:allocate_operation] if args.key?(:allocate_operation)
@allocation_mode = args[:allocation_mode] if args.key?(:allocation_mode)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents a set of metric values in the same metric.
# Each metric value in the set should have a unique combination of start time,
# end time, and label values.
class MetricValueSet
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The metric name defined in the service configuration.
# Corresponds to the JSON property `metricName`
# @return [String]
attr_accessor :metric_name
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The values in this metric.
# Corresponds to the JSON property `metricValues`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValue>]
attr_accessor :metric_values
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@metric_name = args[:metric_name] if args.key?(:metric_name)
@metric_values = args[:metric_values] if args.key?(:metric_values)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents the processing error of one `Operation` in the request.
class ReportError
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The Operation.operation_id value from the request.
# Corresponds to the JSON property `operationId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :operation_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# Corresponds to the JSON property `status`
# @return [Google::Apis::ServicecontrolV1::Status]
attr_accessor :status
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@operation_id = args[:operation_id] if args.key?(:operation_id)
@status = args[:status] if args.key?(:status)
2017-03-30 22:30:51 +00:00
end
end
#
2017-03-31 19:53:27 +00:00
class StartReconciliationRequest
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Specifies which version of service configuration should be used to process
# the request. If unspecified or no matching version can be found, the latest
# one will be used.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
2017-03-31 19:53:27 +00:00
# Represents information regarding a quota operation.
# Corresponds to the JSON property `reconciliationOperation`
# @return [Google::Apis::ServicecontrolV1::QuotaOperation]
attr_accessor :reconciliation_operation
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
2017-03-31 19:53:27 +00:00
@reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Defines the errors to be returned in
# google.api.servicecontrol.v1.CheckResponse.check_errors.
class CheckError
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Free-form text providing details on the error cause of the error.
# Corresponds to the JSON property `detail`
# @return [String]
attr_accessor :detail
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The error code.
# Corresponds to the JSON property `code`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :code
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@detail = args[:detail] if args.key?(:detail)
@code = args[:code] if args.key?(:code)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Contains the quota information for a quota check response.
class QuotaInfo
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Map of quota group name to the actual number of tokens consumed. If the
# quota check was not successful, then this will not be populated due to no
# quota consumption.
# Deprecated: Use quota_metrics to get per quota group usage.
# Corresponds to the JSON property `quotaConsumed`
# @return [Hash<String,Fixnum>]
attr_accessor :quota_consumed
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Quota metrics to indicate the usage. Depending on the check request, one or
# more of the following metrics will be included:
# 1. For rate quota, per quota group or per quota metric incremental usage
# will be specified using the following delta metric:
# "serviceruntime.googleapis.com/api/consumer/quota_used_count"
# 2. For allocation quota, per quota metric total usage will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
# 3. For both rate quota and allocation quota, the quota limit reached
# condition will be specified using the following boolean metric:
# "serviceruntime.googleapis.com/quota/exceeded"
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Quota Metrics that have exceeded quota limits.
# For QuotaGroup-based quota, this is QuotaGroup.name
# For QuotaLimit-based quota, this is QuotaLimit.name
# See: google.api.Quota
# Deprecated: Use quota_metrics to get per quota group limit exceeded status.
# Corresponds to the JSON property `limitExceeded`
# @return [Array<String>]
attr_accessor :limit_exceeded
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@quota_consumed = args[:quota_consumed] if args.key?(:quota_consumed)
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
@limit_exceeded = args[:limit_exceeded] if args.key?(:limit_exceeded)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Request message for the Check method.
class CheckRequest
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Indicates if service activation check should be skipped for this request.
# Default behavior is to perform the check and apply relevant quota.
# Corresponds to the JSON property `skipActivationCheck`
# @return [Boolean]
attr_accessor :skip_activation_check
alias_method :skip_activation_check?, :skip_activation_check
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Represents information regarding an operation.
# Corresponds to the JSON property `operation`
# @return [Google::Apis::ServicecontrolV1::Operation]
attr_accessor :operation
# Requests the project settings to be returned as part of the check response.
# Corresponds to the JSON property `requestProjectSettings`
# @return [Boolean]
attr_accessor :request_project_settings
alias_method :request_project_settings?, :request_project_settings
# Specifies which version of service configuration should be used to process
# the request.
# If unspecified or no matching version can be found, the
# latest one will be used.
# Corresponds to the JSON property `serviceConfigId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@skip_activation_check = args[:skip_activation_check] if args.key?(:skip_activation_check)
@operation = args[:operation] if args.key?(:operation)
@request_project_settings = args[:request_project_settings] if args.key?(:request_project_settings)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents information regarding a quota operation.
class QuotaOperation
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Identity of the consumer for whom this quota operation is being performed.
# This can be in one of the following formats:
# project:<project_id>,
# project_number:<project_number>,
# api_key:<api_key>.
# Corresponds to the JSON property `consumerId`
# @return [String]
attr_accessor :consumer_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Identity of the operation. This must be unique within the scope of the
# service that generated the operation. If the service calls AllocateQuota
# and ReleaseQuota on the same operation, the two calls should carry the
# same ID.
# UUID version 4 is recommended, though not required. In scenarios where an
# operation is computed from existing information and an idempotent id is
# desirable for deduplication purpose, UUID version 5 is recommended. See
# RFC 4122 for details.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `operationId`
# @return [String]
attr_accessor :operation_id
2017-03-31 19:53:27 +00:00
# Quota mode for this operation.
# Corresponds to the JSON property `quotaMode`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :quota_mode
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Fully qualified name of the API method for which this quota operation is
# requested. This name is used for matching quota rules or metric rules and
# billing status rules defined in service configuration. This field is not
# required if the quota operation is performed on non-API resources.
# Example of an RPC method name:
# google.example.library.v1.LibraryService.CreateShelf
# Corresponds to the JSON property `methodName`
# @return [String]
attr_accessor :method_name
# Represents information about this operation. Each MetricValueSet
# corresponds to a metric defined in the service configuration.
# The data type used in the MetricValueSet must agree with
# the data type specified in the metric definition.
# Within a single operation, it is not allowed to have more than one
# MetricValue instances that have the same metric names and identical
# label value combinations. If a request has such duplicated MetricValue
# instances, the entire request is rejected with
# an invalid argument error.
# Corresponds to the JSON property `quotaMetrics`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :quota_metrics
# Labels describing the operation.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@consumer_id = args[:consumer_id] if args.key?(:consumer_id)
2017-03-30 22:30:51 +00:00
@operation_id = args[:operation_id] if args.key?(:operation_id)
2017-03-31 19:53:27 +00:00
@quota_mode = args[:quota_mode] if args.key?(:quota_mode)
@method_name = args[:method_name] if args.key?(:method_name)
@quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics)
@labels = args[:labels] if args.key?(:labels)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
#
class EndReconciliationRequest
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Represents information regarding a quota operation.
# Corresponds to the JSON property `reconciliationOperation`
# @return [Google::Apis::ServicecontrolV1::QuotaOperation]
attr_accessor :reconciliation_operation
2017-03-30 22:30:51 +00:00
# Specifies which version of service configuration should be used to process
# the request. If unspecified or no matching version can be found, the latest
# one will be used.
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation)
2017-03-30 22:30:51 +00:00
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
end
end
#
2017-03-31 19:53:27 +00:00
class ReportInfo
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The Operation.operation_id value from the request.
# Corresponds to the JSON property `operationId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :operation_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Contains the quota information for a quota check response.
# Corresponds to the JSON property `quotaInfo`
# @return [Google::Apis::ServicecontrolV1::QuotaInfo]
attr_accessor :quota_info
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@operation_id = args[:operation_id] if args.key?(:operation_id)
@quota_info = args[:quota_info] if args.key?(:quota_info)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Represents information regarding an operation.
class Operation
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Fully qualified name of the operation. Reserved for future use.
# Corresponds to the JSON property `operationName`
# @return [String]
attr_accessor :operation_name
# End time of the operation.
# Required when the operation is used in ServiceController.Report,
# but optional when the operation is used in ServiceController.Check.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Required. Start time of the operation.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# DO NOT USE. This is an experimental field.
# Corresponds to the JSON property `importance`
# @return [String]
attr_accessor :importance
# The resource name of the parent of a resource in the resource hierarchy.
# This can be in one of the following formats:
# - “projects/<project-id or project-number>”
# - “folders/<folder-id>”
# - “organizations/<organization-id>”
# Corresponds to the JSON property `resourceContainer`
# @return [String]
attr_accessor :resource_container
# Labels describing the operation. Only the following labels are allowed:
# - Labels describing monitored resources as defined in
# the service configuration.
# - Default labels of metric values. When specified, labels defined in the
# metric value override these default.
# - The following labels defined by Google Cloud Platform:
# - `cloud.googleapis.com/location` describing the location where the
# operation happened,
# - `servicecontrol.googleapis.com/user_agent` describing the user agent
# of the API request,
# - `servicecontrol.googleapis.com/service_agent` describing the service
# used to handle the API request (e.g. ESP),
# - `servicecontrol.googleapis.com/platform` describing the platform
# where the API is served (e.g. GAE, GCE, GKE).
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Represents information to be logged.
# Corresponds to the JSON property `logEntries`
# @return [Array<Google::Apis::ServicecontrolV1::LogEntry>]
attr_accessor :log_entries
# User defined labels for the resource that this operation is associated
# with.
# Corresponds to the JSON property `userLabels`
# @return [Hash<String,String>]
attr_accessor :user_labels
# Represents information about this operation. Each MetricValueSet
# corresponds to a metric defined in the service configuration.
# The data type used in the MetricValueSet must agree with
# the data type specified in the metric definition.
# Within a single operation, it is not allowed to have more than one
# MetricValue instances that have the same metric names and identical
# label value combinations. If a request has such duplicated MetricValue
# instances, the entire request is rejected with
# an invalid argument error.
# Corresponds to the JSON property `metricValueSets`
# @return [Array<Google::Apis::ServicecontrolV1::MetricValueSet>]
attr_accessor :metric_value_sets
# Represents the properties needed for quota operations.
# Corresponds to the JSON property `quotaProperties`
# @return [Google::Apis::ServicecontrolV1::QuotaProperties]
attr_accessor :quota_properties
# Identity of the consumer who is using the service.
# This field should be filled in for the operations initiated by a
# consumer, but not for service-initiated operations that are
# not related to a specific consumer.
# This can be in one of the following formats:
# project:<project_id>,
# project_number:<project_number>,
# api_key:<api_key>.
# Corresponds to the JSON property `consumerId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :consumer_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Identity of the operation. This must be unique within the scope of the
# service that generated the operation. If the service calls
# Check() and Report() on the same operation, the two calls should carry
# the same id.
# UUID version 4 is recommended, though not required.
# In scenarios where an operation is computed from existing information
# and an idempotent id is desirable for deduplication purpose, UUID version 5
# is recommended. See RFC 4122 for details.
# Corresponds to the JSON property `operationId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :operation_id
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@operation_name = args[:operation_name] if args.key?(:operation_name)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
@importance = args[:importance] if args.key?(:importance)
@resource_container = args[:resource_container] if args.key?(:resource_container)
@labels = args[:labels] if args.key?(:labels)
@log_entries = args[:log_entries] if args.key?(:log_entries)
@user_labels = args[:user_labels] if args.key?(:user_labels)
@metric_value_sets = args[:metric_value_sets] if args.key?(:metric_value_sets)
@quota_properties = args[:quota_properties] if args.key?(:quota_properties)
@consumer_id = args[:consumer_id] if args.key?(:consumer_id)
@operation_id = args[:operation_id] if args.key?(:operation_id)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Response message for the Report method.
class ReportResponse
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Quota usage for each quota release `Operation` request.
# Fully or partially failed quota release request may or may not be present
# in `report_quota_info`. For example, a failed quota release request will
# have the current quota usage info when precise quota library returns the
# info. A deadline exceeded quota request will not have quota usage info.
# If there is no quota release request, report_quota_info will be empty.
# Corresponds to the JSON property `reportInfos`
# @return [Array<Google::Apis::ServicecontrolV1::ReportInfo>]
attr_accessor :report_infos
# The actual config id used to process the request.
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
# Partial failures, one for each `Operation` in the request that failed
# processing. There are three possible combinations of the RPC status:
# 1. The combination of a successful RPC status and an empty `report_errors`
# list indicates a complete success where all `Operations` in the
# request are processed successfully.
# 2. The combination of a successful RPC status and a non-empty
# `report_errors` list indicates a partial success where some
# `Operations` in the request succeeded. Each
# `Operation` that failed processing has a corresponding item
# in this list.
# 3. A failed RPC status indicates a general non-deterministic failure.
# When this happens, it's impossible to know which of the
# 'Operations' in the request succeeded or failed.
# Corresponds to the JSON property `reportErrors`
# @return [Array<Google::Apis::ServicecontrolV1::ReportError>]
attr_accessor :report_errors
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@report_infos = args[:report_infos] if args.key?(:report_infos)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@report_errors = args[:report_errors] if args.key?(:report_errors)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Response message for the Check method.
class CheckResponse
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The same operation_id value used in the CheckRequest.
# Used for logging and diagnostics purposes.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `operationId`
# @return [String]
attr_accessor :operation_id
2017-03-31 19:53:27 +00:00
# Indicate the decision of the check.
# If no check errors are present, the service should process the operation.
# Otherwise the service should use the list of errors to determine the
# appropriate action.
# Corresponds to the JSON property `checkErrors`
# @return [Array<Google::Apis::ServicecontrolV1::CheckError>]
attr_accessor :check_errors
# Feedback data returned from the server during processing a Check request.
# Corresponds to the JSON property `checkInfo`
# @return [Google::Apis::ServicecontrolV1::CheckInfo]
attr_accessor :check_info
# Contains the quota information for a quota check response.
# Corresponds to the JSON property `quotaInfo`
# @return [Google::Apis::ServicecontrolV1::QuotaInfo]
attr_accessor :quota_info
# The actual config id used to process the request.
2017-03-30 22:30:51 +00:00
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@operation_id = args[:operation_id] if args.key?(:operation_id)
2017-03-31 19:53:27 +00:00
@check_errors = args[:check_errors] if args.key?(:check_errors)
@check_info = args[:check_info] if args.key?(:check_info)
@quota_info = args[:quota_info] if args.key?(:quota_info)
2017-03-30 22:30:51 +00:00
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
end
end
2017-03-31 19:53:27 +00:00
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
class Status
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :message
# A list of messages that carry the error details. There will be a
# common set of message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
@details = args[:details] if args.key?(:details)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Request message for the Report method.
class ReportRequest
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Operations to be reported.
# Typically the service should report one operation per request.
# Putting multiple operations into a single request is allowed, but should
# be used only when multiple operations are natually available at the time
# of the report.
# If multiple operations are in a single request, the total request size
# should be no larger than 1MB. See ReportResponse.report_errors for
# partial failure behavior.
# Corresponds to the JSON property `operations`
# @return [Array<Google::Apis::ServicecontrolV1::Operation>]
attr_accessor :operations
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Specifies which version of service config should be used to process the
# request.
# If unspecified or no matching version can be found, the
# latest one will be used.
# Corresponds to the JSON property `serviceConfigId`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_config_id
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@operations = args[:operations] if args.key?(:operations)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# Common audit log format for Google Cloud Platform API operations.
class AuditLog
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# Other service-specific data about the request, response, and other
# activities.
# Corresponds to the JSON property `serviceData`
# @return [Hash<String,Object>]
attr_accessor :service_data
# Metadata about the request.
# Corresponds to the JSON property `requestMetadata`
# @return [Google::Apis::ServicecontrolV1::RequestMetadata]
attr_accessor :request_metadata
# The number of items returned from a List or Query API method,
# if applicable.
# Corresponds to the JSON property `numResponseItems`
# @return [String]
attr_accessor :num_response_items
2017-03-30 22:30:51 +00:00
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# Corresponds to the JSON property `status`
# @return [Google::Apis::ServicecontrolV1::Status]
attr_accessor :status
2017-03-31 19:53:27 +00:00
# Authentication information for the operation.
# Corresponds to the JSON property `authenticationInfo`
# @return [Google::Apis::ServicecontrolV1::AuthenticationInfo]
attr_accessor :authentication_info
# The name of the API service performing the operation. For example,
# `"datastore.googleapis.com"`.
# Corresponds to the JSON property `serviceName`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :service_name
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The operation response. This may not include all response elements,
# such as those that are too large, privacy-sensitive, or duplicated
# elsewhere in the log record.
# It should never include user-generated data, such as file contents.
# When the JSON object represented here has a proto equivalent, the proto
# name will be indicated in the `@type` property.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The name of the service method or operation.
# For API calls, this should be the name of the API method.
# For example,
# "google.datastore.v1.Datastore.RunQuery"
# "google.logging.v1.LoggingService.DeleteLog"
# Corresponds to the JSON property `methodName`
# @return [String]
attr_accessor :method_name
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Authorization information. If there are multiple
# resources or permissions involved, then there is
# one AuthorizationInfo element for each `resource, permission` tuple.
# Corresponds to the JSON property `authorizationInfo`
# @return [Array<Google::Apis::ServicecontrolV1::AuthorizationInfo>]
attr_accessor :authorization_info
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The resource or collection that is the target of the operation.
# The name is a scheme-less URI, not including the API service name.
# For example:
# "shelves/SHELF_ID/books"
# "shelves/SHELF_ID/books/BOOK_ID"
# Corresponds to the JSON property `resourceName`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :resource_name
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The operation request. This may not include all request parameters,
# such as those that are too large, privacy-sensitive, or duplicated
# elsewhere in the log record.
# It should never include user-generated data, such as file contents.
# When the JSON object represented here has a proto equivalent, the proto
# name will be indicated in the `@type` property.
# Corresponds to the JSON property `request`
# @return [Hash<String,Object>]
attr_accessor :request
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@service_data = args[:service_data] if args.key?(:service_data)
@request_metadata = args[:request_metadata] if args.key?(:request_metadata)
@num_response_items = args[:num_response_items] if args.key?(:num_response_items)
@status = args[:status] if args.key?(:status)
@authentication_info = args[:authentication_info] if args.key?(:authentication_info)
@service_name = args[:service_name] if args.key?(:service_name)
@response = args[:response] if args.key?(:response)
@method_name = args[:method_name] if args.key?(:method_name)
@authorization_info = args[:authorization_info] if args.key?(:authorization_info)
@resource_name = args[:resource_name] if args.key?(:resource_name)
@request = args[:request] if args.key?(:request)
2017-03-30 22:30:51 +00:00
end
end
2017-03-31 19:53:27 +00:00
# An individual log entry.
class LogEntry
2017-03-30 22:30:51 +00:00
include Google::Apis::Core::Hashable
2017-03-31 19:53:27 +00:00
# A set of user-defined (key, value) data that provides additional
# information about the log entry.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The severity of the log entry. The default value is
# `LogSeverity.DEFAULT`.
# Corresponds to the JSON property `severity`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :severity
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# A unique ID for the log entry used for deduplication. If omitted,
# the implementation will generate one based on operation_id.
# Corresponds to the JSON property `insertId`
# @return [String]
attr_accessor :insert_id
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# Required. The log to which this log entry belongs. Examples: `"syslog"`,
# `"book_log"`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The log entry payload, represented as a structure that
# is expressed as a JSON object.
# Corresponds to the JSON property `structPayload`
# @return [Hash<String,Object>]
attr_accessor :struct_payload
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The log entry payload, represented as a Unicode string (UTF-8).
# Corresponds to the JSON property `textPayload`
2017-03-30 22:30:51 +00:00
# @return [String]
2017-03-31 19:53:27 +00:00
attr_accessor :text_payload
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The log entry payload, represented as a protocol buffer that is
# expressed as a JSON object. You can only pass `protoPayload`
# values that belong to a set of approved types.
# Corresponds to the JSON property `protoPayload`
# @return [Hash<String,Object>]
attr_accessor :proto_payload
2017-03-30 22:30:51 +00:00
2017-03-31 19:53:27 +00:00
# The time the event described by the log entry occurred. If
# omitted, defaults to operation start time.
# Corresponds to the JSON property `timestamp`
# @return [String]
attr_accessor :timestamp
2017-03-30 22:30:51 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2017-03-31 19:53:27 +00:00
@labels = args[:labels] if args.key?(:labels)
@severity = args[:severity] if args.key?(:severity)
@insert_id = args[:insert_id] if args.key?(:insert_id)
@name = args[:name] if args.key?(:name)
@struct_payload = args[:struct_payload] if args.key?(:struct_payload)
@text_payload = args[:text_payload] if args.key?(:text_payload)
@proto_payload = args[:proto_payload] if args.key?(:proto_payload)
@timestamp = args[:timestamp] if args.key?(:timestamp)
2017-03-30 22:30:51 +00:00
end
end
end
end
end